Objects / Stocktake — Shopfront Developer Documentation

Object

ExternalStocktake

Implements

List of interfaces this object implements

InventoryLogEventInterface

Fields	Type	Description
id	ID!	The ID for the external stocktake
outlet	Outlet!	The Outlet that the stocktake was performed at
user	User!	The user that created the stocktake
zeroStock	Boolean!	Whether all stock was set to zero before the stocktake was applied
overrideStock	Boolean!	If true, the stock in the stocktake overrides the stock on file, otherwise it adds to the stock on file
status	ExternalStocktakeStatusEnum!	The current status of the stocktake
timestamp	DateTime!	The time the stocktake was imported into the system
completed	Stocktake	This is the stocktake that this completed external stocktake is converted into
products	ExternalStocktakeProductConnection	The products imported into this stocktake

ExternalStocktakeProductConnection

Object — ConnectionType of Product

Sortable Fields

Fields from Product that can be used to sort the connection items

name
createdAt
updatedAt

Arguments	Type	Description
search	String	If supplied, searches for products that contain the search string in their name or barcode

Edge Fields	Type	Description
barcode	String!	The barcode imported
name	String	The imported name of the product
cost	Float	The imported unit cost
quantity	Float!	The quantity of products to import
barcodeQuantity	Float!	The quantity of the barcode for the product
tempProduct	Boolean!	Whether the product was imported as a temporary product

Object

StocktakeApply

Fields	Type	Description
stocktake	Stocktake	The stocktake that this apply event refers to
user	User	The user that applied the stocktake
stocktakeOnly	Boolean	Whether the stocktake only ignored products not in the stocktake or zeroed them
processTime	DateTime	When the stocktake was applied

Object

StocktakeEvent

Fields	Type	Description
product	Product	The product that the event applies to
type	StocktakeEventEnum	The type of the event
count	Float	The current status for the stocktake
user	User	The user that created the event
timestamp	DateTime	When the event occurred

Object

StocktakeProduct

Fields	Type	Description
product	Product	The product data belongs too
cost	Float	The cost of the product at the time of the stocktake
caseQuantity	Float	The case quantity of the product at the time of the stocktake
scanned	Boolean	Whether the product was scanned in the stocktake
expectedCount	Float	The expected count of the product at the time of the stocktake
expectedValue	Float	The expected cost value of the product
actualCount	Float	The actual count of the product in the stocktake
actualValue	Float	The actual cost value of the counted product

Object

StocktakeStatistics

Fields	Type	Description
scans	Float	The count of all scan events in the stocktake
products	Float	The count of all the unique products in the stocktake, will return zero if the stocktake hasn't been completed
sales	Float	The count of all the sales that affected the stocktake
firstEventTime	DateTime	The timestamp of the first stocktake event, returns null if the stocktake hasn't received any events
users	[StocktakeUserStatistics]	The Statistics of the users in the stocktake

Object

StocktakeTotal

Fields	Type	Description
scannedExpectedCount	Float	The total expected count of the scanned products at the time of the stocktakes completion
scannedExpectedValue	Float	The total expected cost value of the scanned products at the time of the stocktakes completion
scannedActualCount	Float	The total actual count of the scanned products at the time of the stocktakes completion
scannedActualValue	Float	The total actual cost value of the scanned products at the time of the stocktakes completion
notScannedExpectedCount	Float	The total expected count of the not scanned products at the time of the stocktakes completion
notScannedExpectedValue	Float	The total expected cost value of the not scanned products at the time of the stocktakes completion
notScannedActualCount	Float	The total actual count of the not scanned products at the time of the stocktakes completion
notScannedActualValue	Float	The total actual cost value of the not counted products at the time of the stocktakes completion
allExpectedCount	Float	The total expected count of the all products at the time of the stocktakes completion
allExpectedValue	Float	The total expected cost value of the all products at the time of the stocktakes completion
allActualCount	Float	The total actual count of the all products at the time of the stocktakes completion
allActualValue	Float	The total actual cost value of the all products at the time of the stocktakes completion

Object

Stocktake

Implements

List of interfaces this object implements

InventoryLogEventInterface

Fields	Type	Description
id	ID!	The ID of the stocktake
name	String!	The name of the stocktake
type	StocktakeTypeEnum	The type of the stocktake, Determines what happens when the stocktake is applied. This will be defined when the stocktake is completed
source	ExternalStocktake	The external stocktake that this stocktake is created from
outlet	Outlet!	The Outlet the stocktake is for
status	StocktakeStatusEnum!	The current status for the stocktake
displayExpected	Boolean!	Whether the expected quantity for products should be displayed (in the UI)
applied	Boolean!	Whether the stocktake has been applied to the inventory yet
events	StocktakeStocktakeEventConnection	The events that occurred in the stocktake
products	StocktakeStocktakeProductConnection	The products at the end of the stocktake
statistics	StocktakeStatistics	The statistics of a completed stocktake
users	[User]	The users that have scanned anything in a "COMPLETED" stocktake
categories	[Category]	The categories for the partial stocktake
totals	StocktakeTotal	The totals for the completed stocktake
completedBy	User	The user that completed the stocktake
createdAt	DateTime!	The date and time that the stocktake was created
completedAt	DateTime	The date and time that the stocktake was completed
applications	[StocktakeApply]	A list of all the times the stocktake has been applied to the store's stock file
lastApplication	StocktakeApply	The last time this stocktake was applied
potentialVariances	[StocktakeProduct!]!	Any products that could have a potential variance that we're not able to automatically resolve

StocktakeStocktakeEventConnection

Object — ConnectionType of StocktakeEvent

Sortable Fields

Fields from StocktakeEvent that can be used to sort the connection items

timestamp

Arguments	Type	Description
eventsAfter	DateTime	This argument is used for preventing data duplication via pagination caused by the dynamic nature of this data
product	ID	The id of the product to get the events for, this will filter the data
user	ID	The id of the user to get the events for, this will filter the data

StocktakeStocktakeProductConnection

Object — ConnectionType of StocktakeProduct

Sortable Fields

Fields from StocktakeProduct that can be used to sort the connection items

product
expected
actual
difference

Arguments	Type	Description
scanned	StocktakeScannedEnum
search	String	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Object

StocktakeUserStatistics

Fields	Type	Description
user	User!	The user the statistics applies to
scans	Float	The count of all the unique products in the stocktake
products	Float	The count of all the sales that affected the stocktake