CreateConsignmentInput
Input for creating a Consignment object.
Input Fields
ref (
String!)
External reference of the object. Recommended to be unique.
consignmentReference (
String!)
The external consignment reference assigned by the carrier.
Max character limit: 100.
trackingLabel (
String)
Tracking label of the consignment.
Max character limit: 100.
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 (
CarrierId!)
Carrier used for the consignment
retailer (
RetailerId!)
Retailer who is booking the consignment
consignmentArticles (
[CreateConsignmentArticleWithConsignmentInput]!)
Input for creating ConsignmentArticles for this consignment
attributes (
[AttributeInput])
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.