CarrierConsignment

A Consignment is the object representing the booking of an article for delivery.

Implements

Connections

carrierConsignmentArticles (CarrierConsignmentArticleConnection)

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

manifests (ManifestConnection)

Manifests that contain the consignment

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

Fields

id (ID!)

ID of the object

createdOn (DateTime)

Time of creation

updatedOn (DateTime)

Time of last update

ref (String!)

External reference of the Consignment. Must be unique.

attributes ([Attribute])

A list of attributes associated with this Consignment. This can be used to extend the existing data structure with additional data for use in orchestration rules, etc.

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.

carrier (Carrier)

Carrier used for the consignment

retailer (Retailer)

Retailer who is booking the consignment

workflowRef (String!)

The reference used for workflow identification

workflowVersion (Int!)

The version of the workflow