Carrier
The carrier information
Implements
Connections
CarrierConsignmentConnection)
A connection to associated Consignments
| Argument | Type | Description |
|---|---|---|
ref |
[String!]
|
External reference of the |
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 |
Fields
ID!)
ID of the object
DateTime)
Time of creation
DateTime)
Time of last update
String!)
The reference identifier used to identify an entity
String!)
Type of the Carrier, typically used by the Orchestration Engine to determine the workflow that should be applied. Unless stated otherwise, no values are enforced by the platform.
The type field can be used to differentiate between Inventory Position workflows
String)
The current status of the Carrier.
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
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".
The reference used for workflow identification
Int!)
The version of the workflow assigned to the entity and used for workflow identification. It comprises a major version and minor version number.
The version of the workflow
[Attribute])
A list of attributes associated with this Carrier. This can be used to extend the existing data structure with additional data for use in orchestration rules, etc.
String!)
The carrier name
Retailer)
The retailer
[Manifest])
A list of manifests associated with this Carrier.