CarrierConsignment
A Consignment
is the object representing the booking of an article for delivery.
Implements
Connections
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 |
ManifestConnection
)
Manifests that contain the consignment
Argument | Type | Description |
---|---|---|
ref |
[String!]
|
External reference for the |
name |
[String]
|
The name of the |
type |
[String!]
|
The type of |
status |
[String]
|
The status of the |
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 of the object
DateTime
)
Time of creation
DateTime
)
Time of last update
String!
)
External reference of the Consignment
. Must be unique.
[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.
String
)
The status of the consignment
String
)
The external consignment reference assigned by the carrier
String
)
Tracking label of the consignment
String
)
The URL used to retrieve the shipping label
String
)
A url to represent the order summary. Usually the manifest url from the service provider.
Carrier
)
Carrier used for the consignment
Retailer
)
Retailer who is booking the consignment
String!
)
The reference used for workflow identification
Int!
)
The version of the workflow