query

products (ProductConnection)

Return all products matching the given search criteria. Note that it only works for standard GI products. In order to get results, the retailer references ('retailerRefs') should be properly associated with the Product Catalogues.

Argument	Type	Description
`createdOn`	`DateRange`	Time of creation
`updatedOn`	`DateRange`	Time of last update
`ref`	`[String!]`	The unique reference identifier for the Product
`type`	`[String!]`	The type field can be used to differentiate between Product workflows
`status`	`[String]`	The current status of the Product. By default, the initial value will be `CREATED`, however no other status values are enforced by the platform. The status field is also used within ruleset selection during orchestration. For more info, see Orchestration
`gtin`	`[String!]`	The Global Trade Item Number (GTIN) for this Product
`name`	`[String!]`	The name of the Product
`summary`	`[String]`	A short description of the Product (max 255 chars)
`category`	`CategoryKey`	The Product Category by which the products should be filtered
`catalogue`	`ProductCatalogueKey`	The Product Catalogue in which this Product is managed
`first`	`Int`	Return the first N results. Max page size allowed is 500
`last`	`Int`	Return the last N results. Max page size allowed is 500
`before`	`String`	Return results before this cursor
`after`	`String`	Return results after this cursor

articlesByLocation (ArticleConnection)

Returns the articles currently enroute to, or awaiting collection from, a given location or set of locations. Either 'fromLocation' or 'toLocation' should be provided.

Argument	Type	Description
`status`	`[String!]`	Filter results by Article status (e.g. AWAITING_ARRIVAL vs AWAITING_COLLECTION)
`orderType`	`[String!]`	Filter results by Order type (e.g. HD vs CC)
`fromLocation`	`[LocationKey!]`	Find Articles that are coming from these locations (typically used for collection-type scenarios)
`toLocation`	`[LocationKey!]`	Find Articles that are moving to these locations (typically used for arrivals-type scenarios)
`orderRef`	`[String!]`	Filter results by Order ref
`customerFirstName`	`String`	Filter results by Customer first name
`customerLastName`	`String`	Filter results by Customer last name
`customerPhone`	`String`	Filter results by Customer phone
`customerEmail`	`String`	Filter results by Customer email
`createdOn`	`DateRange`	Filter results by Articles created in a given date range (typically used for uncollected-type scenarios)
`updatedOn`	`DateRange`	Filter results by Articles updated in a given date range
`consignmentStatus`	`[String!]`	Filter results by Consignment status
`carrierName`	`String`	Filter results by Carrier name
`retailerId`	`[Int!]`	Filter results by Retailer id
`first`	`Int`	Return the first N results. Max page size allowed is 500
`last`	`Int`	Return the last N results. Max page size allowed is 500
`before`	`String`	Return results before this cursor
`after`	`String`	Return results after this cursor

searchVirtualInventory (VirtualInventoryConnection)

This query searches the virtual inventory to return locations and available-to-sell stock for the requested products and their given quantities.

Argument	Type	Description
`virtualCatalogue`	`VirtualCatalogueKey!`	Reference identifier for the `VirtualCatalogue` that will be searched
`virtualPosition`	`VirtualPositionInput`	Identifier for the `VirtualPosition` that will be searched
`productQuantities`	`[ProductQuantityInput!]!`	An array of products with their requested quantities
`excludedLocationRefs`	`[String!]`	An array of references of `Location` objects that will be excluded from this search should this parameter be passed
`orderByProximity`	`GeoCoordinateInput`	GeoCoordinates to order results by. Closest locations are returned first. If this parameter is not passed, results will be in no specific order
`first`	`Int`	Returns the first n elements from the list

productCatalogues (ProductCatalogueConnection)

Search for ProductCatalogue entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`ref`	`[String!]`	The unique reference identifier for the Product Catalogue
`type`	`[String!]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`status`	`[String]`
`name`	`[String!]`	The name of the Product Catalogue
`description`	`[String]`	A short description of the Product Catalogue
`retailerRefs`	`[[String]]`	A list of Retailer references associated with this Product Catalogue
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

inventoryCatalogues (InventoryCatalogueConnection)

Search for InventoryCatalogue entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`ref`	`[String!]`	The unique reference identifier for the Inventory Catalogue
`type`	`[String!]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`status`	`[String]`
`name`	`[String!]`	The name of the Inventory Catalogue
`description`	`[String]`	A short description of the Inventory Catalogue
`retailerRefs`	`[[String]]`	A list of Retailer references associated with this Inventory Catalogue
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

inventoryPositions (InventoryPositionConnection)

Search for InventoryPosition entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`ref`	`[String!]`	The unique reference identifier for the Inventory Position
`type`	`[String!]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`status`	`[String]`
`productRef`	`[String!]`	A reference identifying a Product. The referenced product may or may not exist within one or more Product Catalogues. This is a loosely coupled association, since Product and Inventory are separate domains.
`onHand`	`[Int]`	The calculated on hand quantity based on the associated quantities, and rules in the orchestration workflow
`locationRef`	`[String]`	A reference identifying the Location where this inventory exists. This is a loosely coupled association.
`catalogue`	`InventoryCatalogueKey`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

inventoryQuantities (InventoryQuantityConnection)

Search for InventoryQuantity entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`ref`	`[String!]`	The unique reference identifier for the Inventory Quantity
`type`	`[String!]`	The type field can be used to differentiate between Inventory Quantity workflows. Example types include `LAST_ON_HAND`, `RESERVED`, `EXPECTED`, and `ADJUSTMENT`.
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`status`	`[String]`
`quantity`	`[Int]`	The actual amount of this specific Quantity record
`condition`	`[String]`	The condition of the Inventory Quantity value. The platform does not enforce any values here. Examples could include `NEW`, `USED`, or `DAMAGED`
`expectedOn`	`DateRange`
`storageAreaRef`	`[String]`	A reference to the Storage Area where this inventory is kept
`catalogue`	`InventoryCatalogueKey`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

categories (CategoryConnection)

Search for Category entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`ref`	`[String!]`	The unique reference identifier for the Category
`type`	`[String!]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`status`	`[String]`
`name`	`[String!]`	The name of the Category
`summary`	`[String]`	A short description of the Category
`catalogue`	`ProductCatalogueKey`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

standardProducts (StandardProductConnection)

Search for StandardProduct entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`ref`	`[String!]`	The unique reference identifier for the Product
`type`	`[String!]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`status`	`[String]`
`gtin`	`[String!]`	The Global Trade Item Number (GTIN) for this Product
`name`	`[String!]`	The name of the Product
`summary`	`[String]`	A short description of the Product (max 255 chars)
`catalogue`	`ProductCatalogueKey`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID
`category`	`CategoryKey`	The Product Category by which the products should be filtered

variantProducts (VariantProductConnection)

Search for VariantProduct entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`ref`	`[String!]`	The unique reference identifier for the Product
`type`	`[String!]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`status`	`[String]`
`gtin`	`[String!]`	The Global Trade Item Number (GTIN) for this Product
`name`	`[String!]`	The name of the Product
`summary`	`[String]`	A short description of the Product (max 255 chars)
`catalogue`	`ProductCatalogueKey`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID
`category`	`CategoryKey`	The Product Category by which the products should be filtered

groupProducts (GroupProductConnection)

Search for GroupProduct entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`ref`	`[String!]`	The unique reference identifier for the Product
`type`	`[String!]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`status`	`[String]`
`name`	`[String!]`	The name of the Product
`summary`	`[String]`	A short description of the Product (max 255 chars)
`catalogue`	`ProductCatalogueKey`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID
`category`	`CategoryKey`	The Product Category by which the products should be filtered

prices (PriceConnection)

Search for Price entities

Argument	Type	Description
`type`	`[String!]`	The type field is used to identify different types of prices, for example 'RRP', 'SALE', etc. No Price type values are enforced by the platform.
`currency`	`[String!]`	The currency of the Price, for example 'USD', 'GBP', 'AUD', etc.
`value`	`[Float!]`	The price value itself
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

retailers (RetailerConnection)

Search for Retailer entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`status`	`[String]`	Status of the retailer
`ref`	`[String!]`	Reference for the retailer
`summary`	`[String]`	Short description of the retailer
`websiteUrl`	`[String]`	Retailer's website URL used in customer notifications
`websiteUrlName`	`[String]`	Friendly text to be shown for URL links in customer notifications
`primaryEmail`	`[String]`	Primary email of the retailer
`supportContactName`	`[String]`	Customer support contact name
`supportEmail`	`[String]`	Customer support email used in customer notifications
`supportPhone`	`[String]`	Customer support phone number used in customer notifications
`tradingName`	`[String]`	The retailer's trading name used in customer notifications
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

networks (NetworkConnection)

Search for Network entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`ref`	`[String]`	Reference to the network. This is the name of the network you passed in while creating the network. Recommended to be unique.
`type`	`[String]`	The type of network
`status`	`[String]`	Status of the network
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

storeAddresses (StoreAddressConnection)

Search for StoreAddress entities

Argument	Type	Description
`type`	`[String]`	Type of Address, to support legacy address, the value can be AGENT and ORDER
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`directions`	`[String]`	Directions to store location (may be used for landmarks)
`companyName`	`[String]`	Company name
`name`	`[String]`	Name
`street`	`[String]`	Street
`street2`	`[String]`	Street 2
`city`	`[String]`	City
`state`	`[String]`	State
`postcode`	`[String]`	Postcode
`region`	`[String]`	Region
`country`	`[String]`	Country
`latitude`	`[Float]`	Latitude
`longitude`	`[Float]`	Longitude
`ref`	`[String]`	Location reference
`timeZone`	`[String]`	Timezone
`email`	`[String]`	Email
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

customerAddresses (CustomerAddressConnection)

Search for CustomerAddress entities

Argument	Type	Description
`type`	`[String]`	Type of Address, to support legacy address, the value can be AGENT and ORDER
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`companyName`	`[String]`	Company name
`name`	`[String]`	Name
`street`	`[String]`	Street
`street2`	`[String]`	Street 2
`city`	`[String]`	City
`state`	`[String]`	State
`postcode`	`[String]`	Postcode
`region`	`[String]`	Region
`country`	`[String]`	Country
`latitude`	`[Float]`	Latitude
`longitude`	`[Float]`	Longitude
`ref`	`[String]`	Location reference
`timeZone`	`[String]`	Timezone
`email`	`[String]`	Email
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

locations (LocationConnection)

Search for Location entities

Argument	Type	Description
`ref`	`[String]`	The location (i.e. store) id provided by the retailer
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`type`	`[String]`	Type
`status`	`[String]`	The location status. Possible values are 'ACTIVE', 'INACTIVE'.
`name`	`[String]`	Name of location
`supportPhoneNumber`	`[String]`	The location contact number
`defaultCarrier`	`[String]`	Default carrier
`defaultCarrierName`	`[String]`	Default carrier of the location
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

openingSchedules (OpeningScheduleConnection)

Search for OpeningSchedule entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`allHours`	`[Boolean!]`	Is the location open 24hrs
`monEnd`	`[Int!]`	Closing time on Monday (HHmm)
`monStart`	`[Int!]`	Opening time on Monday (HHmm).
`tueEnd`	`[Int!]`	Closing time on Tuesday (HHmm)
`tueStart`	`[Int!]`	Opening time on Tuesday (HHmm)
`wedEnd`	`[Int!]`	Closing time on Wednesday (HHmm)
`wedStart`	`[Int!]`	Opening time on Wednesday (HHmm)
`thuEnd`	`[Int!]`	Closing time on Thursday (HHmm)
`thuStart`	`[Int!]`	Opening time on Thursday (HHmm)
`friEnd`	`[Int!]`	Closing time on Friday (HHmm)
`friStart`	`[Int!]`	Opening time on Friday (HHmm)
`satEnd`	`[Int!]`	Closing time on Saturday (HHmm)
`satStart`	`[Int!]`	Opening time on Saturday (HHmm)
`sunEnd`	`[Int!]`	Closing time on Sunday (HHmm)
`sunStart`	`[Int!]`	Opening time on Sunday (HHmm)
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

storageAreas (StorageAreaConnection)

Search for StorageArea entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`name`	`[String]`	Name
`status`	`[String]`	Status
`type`	`[String]`	Type
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

orders (OrderConnection)

Search for Order entities

Argument	Type	Description
`ref`	`[String]`	External reference of the object. Must be unique.
`type`	`[String!]`	Type of the Order, typically used by the Orchestration Engine to determine the workflow that should be applied. Unless stated otherwise, no values are enforced by the platform. Currently supports all values.
`status`	`[String]`	The current status of the Order.
`workflowRef`	`[String!]`	The workflow's reference
`workflowVersion`	`[Int!]`	The version of the workflow
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`totalPrice`	`[Float]`	Total price
`totalTaxPrice`	`[Float]`	Total tax price
`customerLink`	`CustomerLinkInput`
`payment`	`PaymentLinkInput`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID
`retailerId`	`[Int!]`	ID of the retailer

orderBillingAddresses (OrderBillingAddressConnection)

Search for OrderBillingAddress entities

Argument	Type	Description
`companyName`	`[String]`	Company name
`name`	`[String]`	Name
`street`	`[String]`	Street
`street2`	`[String]`	Street 2
`city`	`[String]`	City
`state`	`[String]`	State
`postcode`	`[String]`	Postcode
`region`	`[String]`	Region
`country`	`[String]`	Country
`latitude`	`[Float]`	Latitude
`longitude`	`[Float]`	Longitude
`timeZone`	`[String]`	Timezone
`email`	`[String]`	Email
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

payments (PaymentConnection)

Search for Payment entities

Argument	Type	Description
`ref`	`[String!]`	External reference of the object. Must be unique.
`type`	`[String!]`	Type of the `Payment`, typically used by the Orchestration Engine to determine the workflow that should be applied. For Payment a sample value for this is `DEFAULT`.
`status`	`[String!]`	Status of the `Payment`
`retailer`	`RetailerLinkInput`
`workflow`	`WorkflowLinkInput`
`workflowRef`	`[String!]`	DEPRECATED, please use the field `workflow` instead - The reference of the workflow.
`workflowVersion`	`[Int!]`	DEPRECATED, please use the field `workflow` instead - The version of the workflow.
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

paymentTransactions (PaymentTransactionConnection)

Search for PaymentTransaction entities

Argument	Type	Description
`ref`	`[String!]`	External reference of the object. Must be unique.
`type`	`[String!]`	Type of the `PaymentTransaction`, typically used by the Orchestration Engine to determine the workflow that should be applied. Common types that are used are: CAPTURE REFUND, AUTHORIZATION
`status`	`[String!]`	Status of the `PaymentTransaction`.
`currency`	`CurrencyLinkInput`
`authorizationKey`	`[String]`	The key received when executing a pre authorisation transaction. Typically used to perform a subsequent payment capture.
`cardType`	`[String]`	Card type. Some sample values are 'MASTERCARD', 'VISA', 'AMEX', 'DINERS', 'SPAN', 'DISCOVER', 'UNIONPAY', 'JCB', 'MAESTRO', 'INTERAC'
`paymentMethod`	`[String!]`	Payment method.
`workflow`	`WorkflowLinkInput`
`workflowRef`	`[String!]`	DEPRECATED, please use the field `workflow` instead - The reference of the workflow.
`workflowVersion`	`[Int!]`	DEPRECATED, please use the field `workflow` instead - The version of the workflow.
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

paymentServiceProviders (PaymentServiceProviderConnection)

Search for PaymentServiceProvider entities

Argument	Type	Description
`ref`	`[String!]`	External reference of the object. Must be unique.
`name`	`[String]`	name of the `PaymentServiceProvider`
`clientId`	`[String!]`	Client ID of the `PaymentServiceProvider`
`clientSecret`	`[String!]`	Client Secret of the `PaymentServiceProvider`
`serviceAuthToken`	`[String!]`	Auth Token of the `PaymentServiceProvider`
`host`	`[String!]`	Host of the `PaymentServiceProvider`. Sample value: 'api.sandbox.paypal.com'.
`port`	`[Int!]`	Port of the `PaymentServiceProvider`
`retailer`	`RetailerLinkInput`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

customers (CustomerConnection)

Search for Customer entities

Argument	Type	Description
`ref`	`[String]`	Username of the customer
`status`	`[String]`	Status
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`title`	`[String]`	The customer's title
`department`	`[String]`	The department/team that the customer belongs to
`country`	`[String]`	The country the customer is operating from
`firstName`	`[String]`	The customer's first name
`lastName`	`[String]`	The customer's last name
`username`	`[String]`	Username
`primaryEmail`	`[String]`	Email
`primaryPhone`	`[String]`	Phone number
`timezone`	`[String]`	Timezones
`promotionOptIn`	`[Boolean]`	Whether the customer has opted to receive promotions
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

orderItems (OrderItemConnection)

Search for OrderItem entities

Argument	Type	Description
`ref`	`[String]`	External reference of the object. Recommended to be unique.
`status`	`[String!]`	Status of the OrderItem.
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`quantity`	`[Int!]`	Quantity ordered
`paidPrice`	`[Float]`	Price paid. Excludes tax.
`currency`	`[String]`	Currency. Should ideally be a 3 letter ISO currency code. For instance AUD.
`price`	`[Float]`	Price
`taxPrice`	`[Float]`	Tax price
`taxType`	`[String]`	Tax type. Supported values are GST, VAT, EXCLTAX
`totalPrice`	`[Float]`	Total price
`totalTaxPrice`	`[Float]`	Total tax price
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

fulfilments (FulfilmentConnection)

Search for Fulfilment entities

Argument	Type	Description
`ref`	`[String]`	External reference of the object. Recommended to be unique.
`status`	`[String]`
`fulfilmentChoiceRef`	`[String]`	Represents the `FulfilmentChoice` corresponding to this object
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`deliveryType`	`[String]`	Type of delivery. Supported values are STANDARD, OVERNIGHT and EXPRESS.
`type`	`[String!]`	Type of the Fulfilment. Supports all values.
`eta`	`[String]`	The estimated time of completing the fulfilment.
`expiryTime`	`DateRange`
`fromLocation`	`LocationLinkInput`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID
`retailerId`	`[Int!]`	ID of the retailer

fulfilmentItems (FulfilmentItemConnection)

Search for FulfilmentItem entities

Argument	Type	Description
`ref`	`[String]`	External reference of the object. Recommended to be unique.
`status`	`[String!]`	Status
`requestedQuantity`	`[Int]`	Number of `OrderItem`s assigned to the fulfilment
`filledQuantity`	`[Int!]`	Number of `OrderItem`s confirmed
`rejectedQuantity`	`[Int!]`	Number of `OrderItem`s rejected
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

articles (ArticleConnection)

Search for Article entities

Argument	Type	Description
`ref`	`[String]`	The unique article reference provided by the retailer
`type`	`[String!]`
`status`	`[String]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`description`	`[String]`	Description
`height`	`[Float!]`	Height
`length`	`[Float!]`	Length
`name`	`[String]`	Name
`weight`	`[Float!]`	Weight
`width`	`[Float!]`	Width
`quantity`	`[Int]`	Quantity
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID
`retailerId`	`[Int!]`	ID of the retailer

consignmentArticles (ConsignmentArticleConnection)

Search for ConsignmentArticle entities

Argument	Type	Description
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

carrierConsignmentArticles (CarrierConsignmentArticleConnection)

Search for CarrierConsignmentArticle entities

Argument	Type	Description
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

manifests (ManifestConnection)

Search for Manifest entities

Argument	Type	Description
`ref`	`[String!]`	External reference for the `Manifest`. Must be unique.
`name`	`[String]`	The name of the `Manifest`
`type`	`[String!]`	The type of `Manifest`
`status`	`[String]`	The status of the `Manifest`
`workflowRef`	`[String!]`	The reference used for workflow identification
`workflowVersion`	`[Int!]`	The version of the workflow
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`carrierManifestLink`	`[String]`	The link where the carrier's manifest is stored. Not all the carriers generates one, so this field is optional.
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

articleItems (ArticleItemConnection)

Search for ArticleItem entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`quantity`	`[Int!]`	Quantity of article item
`barcode`	`[String]`	Barcode of article item
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

consignments (ConsignmentConnection)

Search for Consignment entities

Argument	Type	Description
`ref`	`[String]`	External reference of the object. Recommended to be unique.
`status`	`[String]`	The status of the consignment
`consignmentReference`	`[String!]`	The external consignment reference assigned by the carrier
`trackingLabel`	`[String]`	Tracking label of the consignment
`labelUrl`	`[String]`	The URL used to retrieve the shipping label
`orderSummaryUrl`	`[String]`	A url to represent the order summary. Usually the manifest url from the service provider.
`workflowRef`	`[String!]`	The reference used for workflow identification
`workflowVersion`	`[Int!]`	The version of the workflow
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

carrierConsignments (CarrierConsignmentConnection)

Search for CarrierConsignment entities

Argument	Type	Description
`ref`	`[String!]`	External reference of the `Consignment`. Must be unique.
`status`	`[String]`	The status of the consignment
`consignmentReference`	`[String]`	The external consignment reference assigned by the carrier
`trackingLabel`	`[String]`	Tracking label of the consignment
`labelUrl`	`[String]`	The URL used to retrieve the shipping label
`orderSummaryUrl`	`[String]`	A url to represent the order summary. Usually the manifest url from the service provider.
`workflowRef`	`[String!]`	The reference used for workflow identification
`workflowVersion`	`[Int!]`	The version of the workflow
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

carriers (CarrierConnection)

Search for Carrier entities

Argument	Type	Description
`name`	`[String!]`	The carrier name
`type`	`[String!]`	The type field can be used to differentiate between Inventory Position workflows
`ref`	`[String!]`	The reference identifier used to identify an entity
`workflowRef`	`[String!]`	The reference used for workflow identification
`workflowVersion`	`[Int!]`	The version of the workflow
`status`	`[String]`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

carrierDetailses (CarrierDetailsConnection)

Search for CarrierDetails entities

Argument	Type	Description
`retailerId`	`[String]`	Retailer ID of carrier details
`agentId`	`[String]`	Location ID of carrier details
`carrierId`	`[String]`	Carrier ID of carrier details
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

carrierAttributes (CarrierAttributeConnection)

Search for CarrierAttribute entities

Argument	Type	Description
`name`	`[String!]`
`value`	`[String!]`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

fulfilmentChoices (FulfilmentChoiceConnection)

Search for FulfilmentChoice entities

Argument	Type	Description
`ref`	`[String]`	External reference of the object. Recommended to be unique.
`type`	`[String!]`	Type of the Fulfilment choice. Supports all values.
`status`	`[String]`	The current status of the Fulfilment choice. By default, the initial value will be CREATED, however no other status values are enforced by the platform. The status field is also used within ruleset selection during orchestration. For more info, see Orchestration.
`workflowRef`	`[String!]`	The workflow's reference
`workflowVersion`	`[Int!]`	The version of the workflow
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`currency`	`[String]`	The type of currency, 3 letter ISO currency code.
`deliveryFirstName`	`[String]`	First Name of delivery recipient.
`deliveryLastName`	`[String]`	Last Name of delivery recipient.
`deliveryContact`	`[String]`	Mobile number of delivery recipient.
`deliveryEmail`	`[String]`	Email address to which e-delivery is made.
`deliverAfter`	`DateRange`
`deliverBefore`	`DateRange`
`dispatchOn`	`DateRange`
`deliveryInstruction`	`[String]`	Instruction provided by the customer (250 character limit).
`deliveryType`	`[String!]`	The type of delivery determined by retailers' shipping options. Example values are STANDARD, EXPRESS, OVERNIGHT, 3HOURS
`fulfilmentPrice`	`[Float]`	FulfilmentPrice refers to shipping and C&C fees.
`fulfilmentTaxPrice`	`[Float]`	This refers to the tax cost associated with the fulfilment price.
`fulfilmentType`	`[String]`	Indicates the type of fulfilment.
`pickupLocationRef`	`[String]`	Pickup location. Required if it is a click & collect.
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

financialTransactions (FinancialTransactionConnection)

Search for FinancialTransaction entities

Argument	Type	Description
`ref`	`[String]`	The unique transaction reference provided by the Retailer to the payment gateway
`type`	`[String!]`
`status`	`[String]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`total`	`[Float!]`	The total transaction amount
`scale`	`[Int]`	The number of digits to scale down to
`unscaledValue`	`[Int]`	The unscaled value
`currency`	`[String!]`	Currency used for the transaction.
`externalTransactionCode`	`[String]`	The unique transaction code or request code provided by the payment gateway
`externalTransactionId`	`[String]`	The unique transaction ID or request ID provided by the payment gateway
`cardType`	`[String]`	The card type used for the payment
`paymentMethod`	`[String]`	The way in which payment was made. Platform provides support for the following payment methods - 'CREDITCARD', 'PAYPAL', 'GIFTVOUCHER', 'CASH', 'AFTERPAY'. However, these can be overridden/configured per client as settings
`paymentProviderName`	`[String]`	The name of the payment gateway. Platform provided values are 'CYBERSOURCE', 'GIVEX', 'PAYPAL', 'BRAINTREE', 'AFTERPAY'. However, these can be overridden/configured per client as settings using 'PAYMENT.PROVIDER'
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

settings (SettingConnection)

Search for Setting entities

Argument	Type	Description
`name`	`[String]`	Name of the setting.
`valueType`	`[String]`	Data type of the setting's value. Supported types are LOB, STRING, INTEGER, BOOLEAN and JSON.
`value`	`[String]`	Value of the setting. Use this if the value is NOT a JSON.
`context`	`[String!]`	The context of the setting. Supported values are ACCOUNT, RETAILER, AGENT or CUSTOMER
`contextId`	`[Int!]`	`ID` of the context. For instance, use a retailer's ID when using RETAILER context.
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

comments (CommentConnection)

Search for Comment entities

Argument	Type	Description
`entityType`	`[String!]`	Type of the entity. For example `ORDER`, `FULFILMENT`, `ORDERITEM`, `PRODUCTCATALOGUE` etc.
`entityId`	`[ID]`	ID of the entity
`entityRef`	`[String]`	Entity reference
`text`	`[String!]`	Comment text
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

virtualCatalogues (VirtualCatalogueConnection)

Search for VirtualCatalogue entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`ref`	`[String!]`	The reference identifier used to identify an entity
`type`	`[String!]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`status`	`[String]`
`name`	`[String!]`	Name of the inventory catalogue
`description`	`[String]`	Description
`inventoryCatalogueRef`	`[String]`	Inventory Catalogue used for this virtual catalogue
`productCatalogueRef`	`[String]`	Product Catalogue used for this virtual catalogue
`networkIds`	`[[String]]`	Networks used for this catalogue
`controlGroupRef`	`[String]`	Control group Ref
`retailerRefs`	`[[String]]`	Retailer refs
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

virtualPositions (VirtualPositionConnection)

Search for VirtualPosition entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`ref`	`[String!]`	The reference identifier used to identify an entity
`type`	`[String!]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`status`	`[String]`
`productRef`	`[String]`	Product reference
`quantity`	`[Int]`	On hand quantity
`groupRef`	`[String]`	Group - reference to Location or Category
`catalogue`	`VirtualCatalogueKey`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

controlGroups (ControlGroupConnection)

Search for ControlGroup entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`ref`	`[String!]`	The reference identifier used to identify an entity
`type`	`[String!]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`status`	`[String]`
`name`	`[String]`	Name
`description`	`[String]`	Description
`retailerRefs`	`[[String]]`	Retailer refs
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

controls (ControlConnection)

Search for Control entities

Argument	Type	Description
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`ref`	`[String!]`	The reference identifier used to identify an entity
`type`	`[String!]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`status`	`[String]`
`name`	`[String]`	Name
`description`	`[String]`	Description
`executionOrder`	`[Int]`	Order that this control is applied
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

fulfilmentOptions (FulfilmentOptionConnection)

Search for FulfilmentOption entities

Argument	Type	Description
`ref`	`[String]`	External reference. Recommended to be unique.
`status`	`[String]`
`type`	`[String!]`
`retailerId`	`[Int!]`	ID of the `Retailer`, typically used by the Orchestration Engine to determine the workflow that should be applied.
`orderType`	`[String]`	Type of order. For example click & collect (CC) or home delivery (HD)
`locationRef`	`[String]`	The reference identifier for a location. May be used in orchestration rules to drive custom business logic. For example, you can have a rule to return plans only from this location or a rule to return plans from all locations but excluding this one.
`trackingCode`	`[String]`	A unique identifier for the clients to group related Fulfilment Plans.
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

fulfilmentPlans (FulfilmentPlanConnection)

Search for FulfilmentPlan entities

Argument	Type	Description
`ref`	`[String]`	External reference. Recommended to be unique.
`status`	`[String]`
`type`	`[String!]`
`splitCount`	`[Int]`	Order split limits
`eta`	`[String]`	ETA of the `FulfilmentPlan`. Although this can be set explicitly, we recommend that this be determined and set in the workflow.
`retailerId`	`[Int]`	ID of the retailer
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

users (UserConnection)

Search for User entities

Argument	Type	Description
`ref`	`[String!]`	External reference of the object. Recommended to be unique.
`username`	`[String!]`	Unique name for the user used for identification and logging purposes.
`title`	`[String]`	The user's title. For example Mr., Miss, Dr., Ms. etc
`firstName`	`[String]`	User's first name
`lastName`	`[String]`	User's last name
`primaryEmail`	`[String]`	User's primary email
`primaryPhone`	`[String]`	User's primary phone number
`type`	`[String!]`	Type of the user
`status`	`[String]`	Status
`department`	`[String]`	Department
`country`	`[String]`	Country
`timezone`	`[String]`	Timezone
`promotionOptIn`	`[Boolean]`	Determines if the user has opted to receive promotions
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

roles (RoleConnection)

Search for Role entities

Argument	Type	Description
`name`	`[String!]`	Name of the role. Must be unique.
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

waves (WaveConnection)

Search for Wave entities

Argument	Type	Description
`ref`	`[String!]`	External reference of the `Wave`. Must be unique.
`name`	`[String]`	Name of the `Wave`
`status`	`[String]`
`type`	`[String!]`
`workflowRef`	`[String!]`
`workflowVersion`	`[Int!]`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`processingLocation`	`LocationLinkInput`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID
`retailerId`	`[Int!]`	ID of the retailer

waveItems (WaveItemConnection)

Search for WaveItem entities

Argument	Type	Description
`quantity`	`[Int!]`	Aggregated quantity of a product in the `Wave`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

permissions (PermissionConnection)

Search for Permission entities

Argument	Type	Description
`name`	`[String!]`	Name of the permission. Must be unique.
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

billingAccounts (BillingAccountConnection)

Search for BillingAccount entities

Argument	Type	Description
`ref`	`[String!]`	External reference to the `BillingAccount`. Must be unique.
`type`	`[String]`	Type of the `BillingAccount`, typically used by the Orchestration Engine to determine the workflow that should be applied.
`status`	`[String]`	Status of the `BillingAccount`.
`retailer`	`RetailerLinkInput`
`customer`	`CustomerLinkInput`
`name`	`[String]`	Name of the `BillingAccount`.
`workflow`	`WorkflowLinkInput`
`workflowRef`	`[String]`	DEPRECATED, please use the field `workflow` instead - The reference of the workflow.
`workflowVersion`	`[String]`	DEPRECATED, please use the field `workflow` instead - The version of the workflow.
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

creditMemoes (CreditMemoConnection)

Search for CreditMemo entities

Argument	Type	Description
`ref`	`[String!]`	External reference to the `CreditMemo`. Must be unique.
`type`	`[String]`	Type of the `CreditMemo`, typically used by the Orchestration Engine to determine the workflow that should be applied.
`status`	`[String]`	Status of the `CreditMemo`.
`order`	`OrderLinkInput`
`returnOrder`	`ReturnOrderLinkInput`
`issueDate`	`DateRange`
`currency`	`CurrencyLinkInput`
`workflow`	`WorkflowLinkInput`
`workflowRef`	`[String]`	DEPRECATED, please use the field `workflow` instead - The reference of the workflow.
`workflowVersion`	`[String]`	DEPRECATED, please use the field `workflow` instead - The version of the workflow.
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

creditMemoItems (CreditMemoItemConnection)

Search for CreditMemoItem entities

Argument	Type	Description
`ref`	`[String!]`	External reference to the `CreditMemoItem`. Must be unique.
`type`	`[String]`	Type of the `CreditMemoItem`, typically used by the Orchestration Engine to determine the workflow that should be applied.
`description`	`[String]`	Description of the `CreditMemoItem`.
`orderItem`	`OrderItemLinkInput`
`returnOrderItem`	`ReturnOrderItemLinkInput`
`product`	`ProductLinkInput`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

invoices (InvoiceConnection)

Search for Invoice entities

Argument	Type	Description
`ref`	`[String!]`	External reference to the `Invoice`. Must be unique.
`workflow`	`WorkflowLinkInput`
`type`	`[String]`	Type of the `Invoice`, typically used by the Orchestration Engine to determine the workflow that should be applied.
`status`	`[String]`	Status of the `Invoice`.
`order`	`OrderLinkInput`
`fulfilment`	`FulfilmentLinkInput`
`issueDate`	`DateRange`
`dueDate`	`DateRange`
`currency`	`CurrencyLinkInput`
`workflowRef`	`[String]`	DEPRECATED, please use the field `workflow` instead - The reference of the workflow.
`workflowVersion`	`[Int]`	DEPRECATED, please use the field `workflow` instead - The version of the workflow.
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

invoiceItems (InvoiceItemConnection)

Search for InvoiceItem entities

Argument	Type	Description
`ref`	`[String!]`	External reference to the `InvoiceItem`. Must be unique.
`type`	`[String]`	Type of the `InvoiceItem`, typically used by the Orchestration Engine to determine the workflow that should be applied.
`description`	`[String]`	A description of the source item. In the case of product source items this can be the name.
`product`	`ProductLinkInput`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

currencies (CurrencyConnection)

Search for Currency entities

Argument	Type	Description
`alphabeticCode`	`[String]`	External reference to the `Currency`. Must be unique. For the standard currency types, this field is the three-letters-code used internationally (ISO-4217). eg: AUD, EUR, USD.
`numericCode`	`[String]`	The numeric code of the `Currency`.
`name`	`[String]`	The name of the `Currency`.
`minorUnits`	`[Int]`	The number of minor units that make up a major unit of the `Currency`
`isISO4217`	`[Boolean]`	Currencies which are defined as part of the ISO-4217 standard cannot be deleted or modified.
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

returnOrders (ReturnOrderConnection)

Search for ReturnOrder entities

Argument	Type	Description
`ref`	`[String!]`	External reference for `ReturnOrder`. Must be unique.
`retailer`	`RetailerLinkInput`
`workflow`	`WorkflowLinkInput`
`type`	`[String!]`	Type of the return order
`status`	`[String!]`	Status of the `Return Order`
`customer`	`CustomerLinkInput`
`order`	`OrderLinkInput`
`returnAuthorisationKey`	`[String]`	The generated key representing an authorised return order which the customer can use to progress through the return order process.
`returnAuthorisationKeyExpiry`	`DateRange`
`lodgedLocation`	`LocationLinkInput`
`destinationLocation`	`LocationLinkInput`
`exchangeOrder`	`OrderLinkInput`
`creditMemo`	`CreditMemoLinkInput`
`currency`	`CurrencyLinkInput`
`workflowRef`	`[String]`	DEPRECATED, please use the field `workflow` instead - The reference of the workflow.
`workflowVersion`	`[Int]`	DEPRECATED, please use the field `workflow` instead - The version of the workflow.
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID
`retailerId`	`[Int!]`	ID of the retailer

returnOrderItems (ReturnOrderItemConnection)

Search for ReturnOrderItem entities

Argument	Type	Description
`ref`	`[String!]`	External reference for `Return Order`. Must be unique.
`status`	`[String!]`	Status of the return order
`product`	`ProductLinkInput`
`orderItem`	`OrderItemLinkInput`
`returnReasonComment`	`[String]`	An optional comment. Required if the reason code required further information such as 'Other'.
`returnConditionComment`	`[String]`	An optional comment. Required if the condition code required further information such as 'Other'.
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

returnFulfilments (ReturnFulfilmentConnection)

Search for ReturnFulfilment entities

Argument	Type	Description
`ref`	`[String!]`	External reference for `Return Fulfilment`. Must be unique.
`workflow`	`WorkflowLinkInput`
`type`	`[String!]`	Type of the return fulfilment
`status`	`[String!]`	Status of the `Return Fulfilment`
`lodgedLocation`	`LocationLinkInput`
`destinationLocation`	`LocationLinkInput`
`workflowRef`	`[String]`	DEPRECATED, please use the field `workflow` instead - The reference of the workflow.
`workflowVersion`	`[Int]`	DEPRECATED, please use the field `workflow` instead - The version of the workflow.
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

returnFulfilmentItems (ReturnFulfilmentItemConnection)

Search for ReturnFulfilmentItem entities

Argument	Type	Description
`ref`	`[String!]`	External reference for `Return Order`. Must be unique.
`product`	`ProductLinkInput`
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

returnVerifications (ReturnVerificationConnection)

Search for ReturnVerification entities

Argument	Type	Description
`ref`	`[String!]`	External reference for `Return Order`. Must be unique.
`type`	`[String!]`
`verificationDetails`	`[String]`	verification details
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

inventoryFeeds (InventoryFeedConnection)

Search for InventoryFeed entities

Argument	Type	Description
`ref`	`[String!]`	Reference of the Inventory Feed. Must be unique.
`name`	`[String]`	Human readable name for this feed
`status`	`[String!]`	Status of the Inventory Feed. Supported values are ACTIVE and INACTIVE.
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`frequencyCronExpression`	`[String]`	CRON expression of Inventory Feed schedule
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

inventoryFeedRuns (InventoryFeedRunConnection)

Search for InventoryFeedRun entities

Argument	Type	Description
`ref`	`[String!]`	Unique reference identifier of the Inventory Feed Run
`status`	`[String!]`	Current status of the Inventory Feed run
`type`	`[String!]`	Type of the Inventory Feed Run. Supported values are FULL_LOAD and INCREMENTAL.
`createdOn`	`DateRange`
`updatedOn`	`DateRange`
`inventoryFeed`	`InventoryFeedKey`
`first`	`Int`	Returns the first n elements from the list
`last`	`Int`	Returns the last n elements from the list
`before`	`String`	Returns the elements in the list that come before the specified global ID
`after`	`String`	Returns the elements in the list that come after the specified global ID

setting (Setting)

Find a Setting entity

Argument	Type	Description
`id`	`ID`	The unique setting id assigned by Fluent

productCatalogue (ProductCatalogue)

Find a ProductCatalogue entity

Argument	Type	Description
`ref`	`String!`	The unique reference identifier for the Product Catalogue

standardProduct (StandardProduct)

Find a StandardProduct entity

Argument	Type	Description
`ref`	`String!`	The unique reference identifier for the Product
`catalogue`	`ProductCatalogueKey!`

variantProduct (VariantProduct)

Find a VariantProduct entity

Argument	Type	Description
`ref`	`String!`	The unique reference identifier for the Product
`catalogue`	`ProductCatalogueKey!`

groupProduct (GroupProduct)

Find a GroupProduct entity

Argument	Type	Description
`ref`	`String!`	The unique reference identifier for the Product
`catalogue`	`ProductCatalogueKey!`

product (Product)

Return the product matching the given input. Note that it only works for standard GI product.

Argument	Type	Description
`ref`	`String!`
`catalogue`	`ProductCatalogueKey!`

me (User)

Find a User entity

inventoryPositionAggregate (InventoryPositionAggregateOutput)

Retrieve the aggregate onHand of Inventory Position for one Product

Argument	Type	Description
`catalogue`	`InventoryCatalogueKey!`	Inventory Catalogue reference identifier
`productRef`	`String!`	Product reference identifier
`type`	`[String!]`	Inventory Position type
`status`	`[String!]`	Inventory Position status
`networkRef`	`String`	Network reference identifier

inventoryQuantityAggregate (InventoryQuantityAggregateOutput)

Retrieve the aggregate qty of Inventory Quantity

Argument	Type	Description
`position`	`InventoryPositionKey!`	Inventory Position reference identifier
`type`	`[String!]`	Inventory Quantity type
`status`	`[String!]`	Inventory Quantity status
`expectedOn`	`DateRange`	Inventory Quantity expected on date

metricInstant (MetricInstant)

An instant query at a single point in time

Argument	Type	Description
`query`	`String!`
`time`	`DateTime`

metricRange (MetricRange)

An expression query over a range of time

Argument	Type	Description
`query`	`String!`
`start`	`DateTime`
`end`	`DateTime`
`step`	`String`

accountUsage (AccountUsage)

Retrieve the aggregated usage for the current account of a given period with a given step (granularity).

inventoryCatalogue (InventoryCatalogue)

Find a InventoryCatalogue entity

Argument	Type	Description
`ref`	`String!`	Inventory Catalogue reference identifier. Max character limit: 100.

inventoryPosition (InventoryPosition)

Find a InventoryPosition entity

Argument	Type	Description
`ref`	`String!`	Inventory Position reference identifier. Max character limit: 100.
`catalogue`	`InventoryCatalogueKey!`	The Inventory Catalogue in which this Position resides

inventoryQuantity (InventoryQuantity)

Find a InventoryQuantity entity

Argument	Type	Description
`ref`	`String!`	Inventory Quantity reference identifier. Max character limit: 100.
`catalogue`	`InventoryCatalogueKey!`	The Inventory Catalogue in which this Quantity resides

category (Category)

Find a Category entity

Argument	Type	Description
`ref`	`String!`	Category reference identifier. Max character limit: 100.
`catalogue`	`ProductCatalogueKey!`	The Product Catalogue in which this Category resides

retailerById (Retailer)

Find a Retailer entity

Argument	Type	Description
`id`	`ID!`	ID of the object

networkById (Network)

Find a Network entity

Argument	Type	Description
`id`	`ID!`	ID of the object

network (Network)

Find a Network entity

Argument	Type	Description
`id`	`ID`	ID of the object
`ref`	`String`	Reference to the network. This is the name of the network you passed in while creating the network. Recommended to be unique.

storeAddressById (StoreAddress)

Find a StoreAddress entity

Argument	Type	Description
`id`	`ID!`	ID of the object

customerAddressById (CustomerAddress)

Find a CustomerAddress entity

Argument	Type	Description
`id`	`ID!`	ID of the object

locationById (Location)

Find a Location entity

Argument	Type	Description
`id`	`ID!`	ID of the object

location (Location)

Find a Location entity

Argument	Type	Description
`id`	`ID`	ID of the object
`ref`	`String`	The client's reference identifier for the object. Max character limit: 100.

storageAreaById (StorageArea)

Find a StorageArea entity

Argument	Type	Description
`id`	`ID!`	ID of the object

orderById (Order)

Find a Order entity

Argument	Type	Description
`id`	`ID!`	ID of the object

order (Order)

Find a Order entity

Argument	Type	Description
`id`	`ID`	ID of the `Order`
`ref`	`String`	External reference of the `Order`.

payment (Payment)

Find a Payment entity

Argument	Type	Description
`ref`	`String!`	The client's unique reference identifier for the object. Max character limit: 100.

paymentTransaction (PaymentTransaction)

Find a PaymentTransaction entity

Argument	Type	Description
`ref`	`String!`	The client's unique reference identifier for the object. Max character limit: 100.

paymentServiceProvider (PaymentServiceProvider)

Find a PaymentServiceProvider entity

Argument	Type	Description
`ref`	`String!`	The client's unique reference identifier for the object. Max character limit: 100.

customerById (Customer)

Find a Customer entity

Argument	Type	Description
`id`	`ID!`	ID of the object

customer (Customer)

Find a Customer entity

Argument	Type	Description
`ref`	`String!`	Username of the customer

orderItemById (OrderItem)

Find a OrderItem entity

Argument	Type	Description
`id`	`ID!`	ID of the object

fulfilmentById (Fulfilment)

Find a Fulfilment entity

Argument	Type	Description
`id`	`ID!`	ID of the object

fulfilment (Fulfilment)

Find a Fulfilment entity

Argument	Type	Description
`id`	`ID`	ID of the object

articleById (Article)

Find a Article entity

Argument	Type	Description
`id`	`ID!`	ID of the object

consignmentArticleById (ConsignmentArticle)

Find a ConsignmentArticle entity

Argument	Type	Description
`article`	`ArticleId`
`consignment`	`ConsignmentId`

carrierConsignmentArticleById (CarrierConsignmentArticle)

Find a CarrierConsignmentArticle entity

Argument	Type	Description
`article`	`ArticleId`
`carrierConsignment`	`CarrierConsignmentKey`

manifest (Manifest)

Find a Manifest entity

Argument	Type	Description
`ref`	`String!`	external reference of the object. Max character limit: 100.

consignmentById (Consignment)

Find a Consignment entity

Argument	Type	Description
`id`	`ID!`	ID of the object

carrierConsignment (CarrierConsignment)

Find a CarrierConsignment entity

Argument	Type	Description
`ref`	`String!`	External reference of the `Consignment`. Must be unique.

carrierById (Carrier)

Find a Carrier entity

Argument	Type	Description
`id`	`ID!`	ID of the object

carrier (Carrier)

Find a Carrier entity

Argument	Type	Description
`ref`	`String!`	Reference of the object. Max character limit: 100.

fulfilmentChoiceById (FulfilmentChoice)

Find a FulfilmentChoice entity

Argument	Type	Description
`id`	`ID!`	ID of the object

fulfilmentChoice (FulfilmentChoice)

Find a FulfilmentChoice entity

Argument	Type	Description
`id`	`ID`	ID of the `FulfilmentChoice`
`ref`	`String`	External reference of the `FulfilmentChoice`.

financialTransaction (FinancialTransaction)

Find a FinancialTransaction entity

Argument	Type	Description
`id`	`ID!`	The id of the FinancialTransaction

commentById (Comment)

Find a Comment entity

Argument	Type	Description
`id`	`ID!`	ID of the object

virtualCatalogue (VirtualCatalogue)

Find a VirtualCatalogue entity

Argument	Type	Description
`ref`	`String!`	Virtual Catalogue reference identifier. Max character limit: 100.

virtualPosition (VirtualPosition)

Find a VirtualPosition entity

Argument	Type	Description
`ref`	`String!`	Virtual Position reference identifier. Max character limit: 100.
`catalogue`	`VirtualCatalogueKey!`

controlGroup (ControlGroup)

Find a ControlGroup entity

Argument	Type	Description
`ref`	`String!`	Control Group reference identifier. Max character limit: 100.

control (Control)

Find a Control entity

Argument	Type	Description
`ref`	`String!`	Control reference identifier. Max character limit: 100.
`controlGroup`	`ControlGroupKey!`

fulfilmentOptionById (FulfilmentOption)

Find a FulfilmentOption entity

Argument	Type	Description
`id`	`ID!`	ID of the object

fulfilmentPlanById (FulfilmentPlan)

Find a FulfilmentPlan entity

Argument	Type	Description
`id`	`ID!`	ID of the object

userById (User)

Find a User entity

Argument	Type	Description
`id`	`ID!`	ID of the object

user (User)

Find a User entity

Argument	Type	Description
`id`	`ID`	ID of the object
`username`	`String`	Unique name for the user used for identification and logging purposes.

role (Role)

Find a Role entity

Argument	Type	Description
`name`	`String!`	Name of the role which is unique and acts as a key to identify the role itself

waveById (Wave)

Find a Wave entity

Argument	Type	Description
`id`	`ID!`	ID of the object

wave (Wave)

Find a Wave entity

Argument	Type	Description
`id`	`ID`	ID of the `Wave`

permission (Permission)

Find a Permission entity

Argument	Type	Description
`name`	`String!`	Name of the permission

billingAccount (BillingAccount)

Find a BillingAccount entity

Argument	Type	Description
`ref`	`String!`	Max character limit: 100.

creditMemo (CreditMemo)

Find a CreditMemo entity

Argument	Type	Description
`ref`	`String!`	Max character limit: 100.

creditMemoItem (CreditMemoItem)

Find a CreditMemoItem entity

Argument	Type	Description
`ref`	`String!`	Max character limit: 100.

invoice (Invoice)

Find a Invoice entity

Argument	Type	Description
`ref`	`String!`	Max character limit: 100.

invoiceItem (InvoiceItem)

Find a InvoiceItem entity

Argument	Type	Description
`ref`	`String!`	Max character limit: 100.

currency (Currency)

Find a Currency entity

Argument	Type	Description
`alphabeticCode`	`String!`	Max character limit: 20.

returnOrder (ReturnOrder)

Find a ReturnOrder entity

Argument	Type	Description
`ref`	`String!`	Max character limit: 100.
`retailer`	`RetailerId!`

returnOrderItem (ReturnOrderItem)

Find a ReturnOrderItem entity

Argument	Type	Description
`ref`	`String!`	Max character limit: 100.
`returnOrder`	`ReturnOrderKey!`

returnFulfilment (ReturnFulfilment)

Find a ReturnFulfilment entity

Argument	Type	Description
`ref`	`String!`	Max character limit: 100.
`returnOrder`	`ReturnOrderKey!`

returnFulfilmentItem (ReturnFulfilmentItem)

Find a ReturnFulfilmentItem entity

Argument	Type	Description
`ref`	`String!`	Max character limit: 100.
`returnFulfilment`	`ReturnFulfilmentKey!`

inventoryFeed (InventoryFeed)

Find a InventoryFeed entity

Argument	Type	Description
`ref`	`String!`	Reference of the Inventory Feed. Must be unique.

inventoryFeedRun (InventoryFeedRun)

Find a InventoryFeedRun entity

Argument	Type	Description
`ref`	`String!`	Unique reference identifier of the Inventory Feed Run

Query

Connections

Description of the `CreditMemoItem`.

Fields

Query

Connections

Description of the CreditMemoItem.

Fields

Description of the `CreditMemoItem`.