Article

An Article can be created when a fulfilment is fulfilled, or when a dispatch occurs. The Article represents the physical parcel that contains the customer order items. The Article is the entity received by the customer.

Implements

Node
Orchestrateable

Connections

items (ArticleItemConnection)

Items within this article

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

fulfilments (FulfilmentConnection)

Fulfilments associated with this article

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

consignmentArticles (ConsignmentArticleConnection)

Relationships between consignment and article

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)

Relationships between carrierConsignment and article

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

Fields

id (ID!)

ID of the object

createdOn (DateTime)

Time of creation

updatedOn (DateTime)

Time of last update

type (String!)

Type of the Article, typically used by the Orchestration Engine to determine the workflow that should be applied. Unless stated otherwise, no values are enforced by the platform.

status (String)

The current status of the Article.
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 reference used for workflow identification. This is defined by a combination of the entity name and the type, in the format [EntityName]::[Type]. For example, an Order of type CC will have the workflowRef "ORDER::CC".

workflowVersion (Int!)

The version of the workflow assigned to the entity and used for workflow identification. It comprises a major version and minor version number.

ref (String)

The unique article reference provided by the retailer

attributes ([Attribute])

Attributes of article

description (String)

Description

height (Float!)

Height

length (Float!)

Length

name (String)

Name

weight (Float!)

Weight

width (Float!)

Width

quantity (Int)

Quantity

storageArea (StorageArea)

The storage areas of the article