ProductionOrderPrime with embedded ordered products, shipping details, and fulfillments. Use this representation to retrieve the complete order in one call.
| Name | Type | Description | |
|---|---|---|---|
shippings
|
array of OrderShipping | A list of shipping line objects, each containing details about a shipping method used. | |
fulfillments
|
array of OrderFulfillmentExpanded | A list of fulfillments associated with the order. | |
orderedProducts
|
array of OrderedProduct | A list of line item objects, each containing information about an item in the order. | |
customAttributes
|
array of OrderCustomAttribute | A list of OrderCustomAttribute objects. |
| Name | Type | Description | |
|---|---|---|---|
id
|
number
|
Unique numeric identifier for the Order. | |
version
|
number
|
Indicates the version number of the production order. This field is typically used for optimistic locking to handle concurrent updates. | |
uniqueId
|
string
|
Custom orderId | |
customSticker
|
string
|
Custom label. | |
created
|
number
|
The autogenerated date and time (ISO 8601 format) when the order was created. | |
financialStatus
|
OrderFinancialStatus | The status of payment associated with the order. | |
fulfilmentStatus
|
OrderFulfillmentStatus | The order's status in terms of fulfilled line items. | |
customer
|
Customer | Information about the customer. The order might not have a customer and apps should not depend on the existence of a customer object. This value might be null. | |
country
|
Country | Represents the country associated with the production order. This variable is of type CountryPrime and provides information such as the country's code, name, VAT rates, currency, and other country-specific configurations important for order processing. | |
orderShipping
|
OrderShipping | Represents the shipping details associated with an order. This variable is of type OrderShippingPrime and provides information such as the shipping method, shipping company, costs, and other related details. It allows setting or getting the shipping information for a particular production order. | |
paid
|
number
|
Represents the date and time when the order was paid. | |
dataErasure
|
OrderDataErasure | Represents the data erasure details associated with a production order. Encapsulates information regarding the status and timestamps of the erasure process for personal and print data related to the order. | |
express
|
boolean
|
Express order flag. | |
comment
|
string
|
Optional comment field. |
{
"productionOrderExpanded" : {
"shippings" : {
"shippingLine" : [ {
"id" : 12345,
"title" : "...",
"price" : 12345.0,
"codPrice" : 12345.0,
"orderValue" : 12345.0,
"carrier" : {
"id" : 12345,
"name" : "UPS",
"description" : "Standard domestic shipping method",
"phoneRequired" : true,
"moduleProvider" : { },
"customProvider" : "...",
"premium" : true,
"emdorsement" : "...",
"ddp" : true,
"showTicketLogo" : true,
"customApiUser" : "...",
"customApiKey" : "...",
"htmlTemplate" : "...",
"mainCarrier" : { },
"perProduct" : true
}
}, {
"id" : 12345,
"title" : "...",
"price" : 12345.0,
"codPrice" : 12345.0,
"orderValue" : 12345.0,
"carrier" : {
"id" : 12345,
"name" : "UPS",
"description" : "Standard domestic shipping method",
"phoneRequired" : true,
"moduleProvider" : { },
"customProvider" : "...",
"premium" : true,
"emdorsement" : "...",
"ddp" : true,
"showTicketLogo" : true,
"customApiUser" : "...",
"customApiKey" : "...",
"htmlTemplate" : "...",
"mainCarrier" : { },
"perProduct" : true
}
} ]
},
"fulfillments" : {
"orderFulfillmentExpanded" : [ {
"items" : {
"orderFulfillmentItem" : [ {
"id" : 12345,
"quantity" : 2,
"item" : { }
}, {
"id" : 12345,
"quantity" : 2,
"item" : { }
} ]
},
"id" : 12345,
"trackingNumber" : "222201010015732844",
"trackingUrl" : "https://www.ups.com/track?222201010015732844",
"name" : "UPS Standard",
"carrier" : {
"id" : 12345,
"name" : "UPS",
"description" : "Standard domestic shipping method",
"phoneRequired" : true,
"moduleProvider" : { },
"customProvider" : "...",
"premium" : true,
"emdorsement" : "...",
"ddp" : true,
"showTicketLogo" : true,
"customApiUser" : "...",
"customApiKey" : "...",
"htmlTemplate" : "...",
"mainCarrier" : { },
"perProduct" : true
}
}, {
"items" : {
"orderFulfillmentItem" : [ {
"id" : 12345,
"quantity" : 2,
"item" : { }
}, {
"id" : 12345,
"quantity" : 2,
"item" : { }
} ]
},
"id" : 12345,
"trackingNumber" : "222201010015732844",
"trackingUrl" : "https://www.ups.com/track?222201010015732844",
"name" : "UPS Standard",
"carrier" : {
"id" : 12345,
"name" : "UPS",
"description" : "Standard domestic shipping method",
"phoneRequired" : true,
"moduleProvider" : { },
"customProvider" : "...",
"premium" : true,
"emdorsement" : "...",
"ddp" : true,
"showTicketLogo" : true,
"customApiUser" : "...",
"customApiKey" : "...",
"htmlTemplate" : "...",
"mainCarrier" : { },
"perProduct" : true
}
} ]
},
"orderedProducts" : {
"orderedProduct" : [ {
"id" : 12345,
"created" : 12345,
"assignedProductColor" : {
"id" : 12345,
"orderIndex" : 1,
"productColor" : { },
"default" : true,
"active" : true
},
"assignedProductSize" : {
"id" : 12345,
"orderIndex" : 1,
"default" : true,
"productSize" : { },
"width" : 47.0,
"height" : 68.0,
"length" : 12345.0,
"accuracy" : 12345.0
},
"amount" : 2,
"price" : 9.99,
"uuid" : "...",
"customReferenceId" : "Item 123456",
"customLabel" : "..."
}, {
"id" : 12345,
"created" : 12345,
"assignedProductColor" : {
"id" : 12345,
"orderIndex" : 1,
"productColor" : { },
"default" : true,
"active" : true
},
"assignedProductSize" : {
"id" : 12345,
"orderIndex" : 1,
"default" : true,
"productSize" : { },
"width" : 47.0,
"height" : 68.0,
"length" : 12345.0,
"accuracy" : 12345.0
},
"amount" : 2,
"price" : 9.99,
"uuid" : "...",
"customReferenceId" : "Item 123456",
"customLabel" : "..."
} ]
},
"customAttributes" : {
"orderCustomAttribute" : [ {
"id" : 12345,
"name" : "...",
"value" : "..."
}, {
"id" : 12345,
"name" : "...",
"value" : "..."
} ]
},
"id" : 12345,
"version" : 12345,
"uniqueId" : "...",
"customSticker" : "...",
"created" : 12345,
"financialStatus" : "VOIDED",
"fulfilmentStatus" : "CANCELLED",
"customer" : {
"id" : 12345,
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@emailservice.com",
"phone" : "+44208269323",
"acceptsMarketing" : true,
"billingAddress" : {
"id" : 12345,
"street" : "Golborne Road",
"streetNo" : "45",
"address2" : "...",
"city" : "London",
"company" : "...",
"country" : "United Kingdom",
"firstName" : "John",
"lastName" : "Doe",
"latitude" : 45.41685,
"longitude" : -71.6822,
"name" : "John Doe",
"phone" : "+44208269323",
"email" : "john.doe@emailservice.com",
"province" : "...",
"zip" : "WC2N 5DU",
"countryCode" : "UK",
"provinceCode" : "...",
"stateCode" : "CA",
"stateName" : "California"
},
"shippingAddress" : {
"id" : 12345,
"street" : "Golborne Road",
"streetNo" : "45",
"address2" : "...",
"city" : "London",
"company" : "...",
"country" : "United Kingdom",
"firstName" : "John",
"lastName" : "Doe",
"latitude" : 45.41685,
"longitude" : -71.6822,
"name" : "John Doe",
"phone" : "+44208269323",
"email" : "john.doe@emailservice.com",
"province" : "...",
"zip" : "WC2N 5DU",
"countryCode" : "UK",
"provinceCode" : "...",
"stateCode" : "CA",
"stateName" : "California"
}
},
"country" : {
"id" : 12345,
"code" : "UK",
"name" : "United Kingdom",
"standardVat" : {
"id" : 12345,
"percentValue" : 19.0
},
"reducedVat" : {
"id" : 12345,
"percentValue" : 19.0
},
"currency" : {
"id" : 12345,
"code" : "EUR",
"symbol" : "€",
"name" : "Euro"
},
"pricePrecision" : 2,
"priceFractionalDigits" : 2,
"default" : true
},
"orderShipping" : {
"id" : 12345,
"title" : "...",
"price" : 12345.0,
"codPrice" : 12345.0,
"orderValue" : 12345.0,
"carrier" : {
"id" : 12345,
"name" : "UPS",
"description" : "Standard domestic shipping method",
"phoneRequired" : true,
"moduleProvider" : { },
"customProvider" : "...",
"premium" : true,
"emdorsement" : "...",
"ddp" : true,
"showTicketLogo" : true,
"customApiUser" : "...",
"customApiKey" : "...",
"htmlTemplate" : "...",
"mainCarrier" : { },
"perProduct" : true
}
},
"paid" : 12345,
"dataErasure" : {
"id" : 12345,
"personalDataErased" : true,
"printDataErased" : true,
"personalDataEraseDate" : 12345,
"printDataEraseDate" : 12345
},
"express" : true,
"comment" : "..."
}
}ProductionOrderPrime with embedded ordered products, shipping details, and fulfillments. Use this representation to retrieve the complete order in one call.
| Name | Type | Description | |
|---|---|---|---|
orderCustomAttribute
|
list of OrderCustomAttribute | A list of OrderCustomAttribute objects. | |
orderFulfillmentExpanded
|
list of OrderFulfillmentExpanded | A list of fulfillments associated with the order. | |
orderedProduct
|
list of OrderedProduct | A list of line item objects, each containing information about an item in the order. | |
shippingLine
|
list of OrderShipping | A list of shipping line objects, each containing details about a shipping method used. |
| Name | Type | Description | |
|---|---|---|---|
comment
|
string
|
Optional comment field. | |
country
|
Country | Represents the country associated with the production order. This variable is of type CountryPrime and provides information such as the country's code, name, VAT rates, currency, and other country-specific configurations important for order processing. | |
created
|
dateTime
|
The autogenerated date and time (ISO 8601 format) when the order was created. | |
customSticker
|
string
|
Custom label. | |
customer
|
Customer | Information about the customer. The order might not have a customer and apps should not depend on the existence of a customer object. This value might be null. | |
dataErasure
|
OrderDataErasure | Represents the data erasure details associated with a production order. Encapsulates information regarding the status and timestamps of the erasure process for personal and print data related to the order. | |
express
|
boolean
|
Express order flag. | |
financialStatus
|
OrderFinancialStatus | The status of payment associated with the order. | |
fulfilmentStatus
|
OrderFulfillmentStatus | The order's status in terms of fulfilled line items. | |
id
|
int
|
Unique numeric identifier for the Order. | |
orderShipping
|
OrderShipping | Represents the shipping details associated with an order. This variable is of type OrderShippingPrime and provides information such as the shipping method, shipping company, costs, and other related details. It allows setting or getting the shipping information for a particular production order. | |
paid
|
dateTime
|
Represents the date and time when the order was paid. | |
uniqueId
|
string
|
Custom orderId | |
version
|
int
|
Indicates the version number of the production order. This field is typically used for optimistic locking to handle concurrent updates. |
<productionOrderExpanded>
<shippings>
<shippingLine>
<id>...</id>
<title>...</title>
<price>...</price>
<codPrice>...</codPrice>
<orderValue>...</orderValue>
<carrier>
<id>...</id>
<name>UPS</name>
<description>Standard domestic shipping method</description>
<phoneRequired>true</phoneRequired>
<moduleProvider/>
<customProvider>...</customProvider>
<premium>...</premium>
<emdorsement>...</emdorsement>
<ddp>...</ddp>
<showTicketLogo>...</showTicketLogo>
<customApiUser>...</customApiUser>
<customApiKey>...</customApiKey>
<htmlTemplate>...</htmlTemplate>
<mainCarrier/>
<perProduct>...</perProduct>
</carrier>
</shippingLine>
</shippings>
<fulfillments>
<orderFulfillmentExpanded>
<items>
<orderFulfillmentItem>
<id>...</id>
<quantity>2</quantity>
<item/>
</orderFulfillmentItem>
</items>
<id>...</id>
<trackingNumber>222201010015732844</trackingNumber>
<trackingUrl>https://www.ups.com/track?222201010015732844</trackingUrl>
<name>UPS Standard</name>
<carrier/>
</orderFulfillmentExpanded>
</fulfillments>
<orderedProducts>
<orderedProduct>
<id>...</id>
<created>2019-04-25T18:02:07+02:00</created>
<assignedProductColor>
<id>...</id>
<orderIndex>1</orderIndex>
<productColor/>
<default>...</default>
<active>...</active>
</assignedProductColor>
<assignedProductSize>
<id>...</id>
<orderIndex>1</orderIndex>
<default>...</default>
<productSize/>
<width>47</width>
<height>68</height>
<length>...</length>
<accuracy>...</accuracy>
</assignedProductSize>
<amount>2</amount>
<price>9.99</price>
<uuid>...</uuid>
<customReferenceId>Item 123456</customReferenceId>
<customLabel>...</customLabel>
</orderedProduct>
</orderedProducts>
<customAttributes>
<orderCustomAttribute>
<id>...</id>
<name>...</name>
<value>...</value>
</orderCustomAttribute>
</customAttributes>
<id>...</id>
<version>...</version>
<uniqueId>...</uniqueId>
<customSticker>...</customSticker>
<created>2019-04-25T18:02:07+02:00</created>
<financialStatus>...</financialStatus>
<fulfilmentStatus>...</fulfilmentStatus>
<customer>
<id>...</id>
<firstName>John</firstName>
<lastName>Doe</lastName>
<email>john.doe@emailservice.com</email>
<phone>+44208269323</phone>
<acceptsMarketing>...</acceptsMarketing>
<billingAddress/>
<shippingAddress/>
</customer>
<country>
<id>...</id>
<code>UK</code>
<name>United Kingdom</name>
<standardVat/>
<reducedVat/>
<currency/>
<pricePrecision>2</pricePrecision>
<priceFractionalDigits>2</priceFractionalDigits>
<default>...</default>
</country>
<orderShipping>
<id>...</id>
<title>...</title>
<price>...</price>
<codPrice>...</codPrice>
<orderValue>...</orderValue>
<carrier/>
</orderShipping>
<paid>...</paid>
<dataErasure>
<id>...</id>
<personalDataErased>...</personalDataErased>
<printDataErased>...</printDataErased>
<personalDataEraseDate>2019-04-25T18:02:07+02:00</personalDataEraseDate>
<printDataEraseDate>2019-04-25T18:02:07+02:00</printDataEraseDate>
</dataErasure>
<express>...</express>
<comment>...</comment>
</productionOrderExpanded>