Orders can be created through the API, but no payment information will be collected, and no transaction performed. You can mark the order with any payment status.
Production management is a separate tool that learns about an order only when the platform hands it
over, which for an order submitted through usingCreatorSE happens once the
deferred-order queue has processed it. Until then the {orderId}/production/* endpoints
have nothing to act on, so set express in the order payload rather than flagging the
order afterwards.
/accounts/{accountId}/shops/{shopId}/orders
Create a new order.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
Order | the order data including uniqueId, financial status, and customer note |
application/xml |
Order |
| Code | Condition |
|---|---|
| 200 | the order was created and the expanded order is returned |
| 400 | the submitted order data failed validation |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
OrderExpanded | |
application/xml |
OrderExpanded |
<productionOrder>
<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>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</billingAddress>
<shippingAddress>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</shippingAddress>
</customer>
<country>
<id>...</id>
<code>UK</code>
<name>United Kingdom</name>
<standardVat>
<id>...</id>
<percentValue>19</percentValue>
</standardVat>
<reducedVat>
<id>...</id>
<percentValue>19</percentValue>
</reducedVat>
<currency>
<id>...</id>
<code>EUR</code>
<symbol>€</symbol>
<name>Euro</name>
</currency>
<pricePrecision>2</pricePrecision>
<priceFractionalDigits>2</priceFractionalDigits>
<default>...</default>
</country>
<orderShipping>
<id>...</id>
<title>Zasilkovna - pickup point</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>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</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>
</productionOrder>
{
"productionOrder" : {
"id" : 12345,
"version" : 12345,
"uniqueId" : "...",
"customSticker" : "...",
"created" : 12345,
"financialStatus" : "PARTIALLY_REFUNDED",
"fulfilmentStatus" : "PREPARED_TO_PRODUCE",
"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" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
},
"paid" : 12345,
"dataErasure" : {
"id" : 12345,
"personalDataErased" : true,
"printDataErased" : true,
"personalDataEraseDate" : 12345,
"printDataEraseDate" : 12345
},
"express" : true,
"comment" : "..."
}
}
<productionOrderExpanded>
<shippings>
<shippingLine>
<id>...</id>
<title>Zasilkovna - pickup point</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>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</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>Zasilkovna - pickup point</title>
<price>...</price>
<codPrice>...</codPrice>
<orderValue>...</orderValue>
<carrier/>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</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>
{
"productionOrderExpanded" : {
"shippings" : {
"shippingLine" : [ {
"id" : 12345,
"title" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
}, {
"id" : 12345,
"title" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
} ]
},
"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" : "PARTIALLY_PAID",
"fulfilmentStatus" : "RECLAMATION",
"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" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
},
"paid" : 12345,
"dataErasure" : {
"id" : 12345,
"personalDataErased" : true,
"printDataErased" : true,
"personalDataEraseDate" : 12345,
"printDataEraseDate" : 12345
},
"express" : true,
"comment" : "..."
}
}
/accounts/{accountId}/shops/{shopId}/orders
Get a list of all orders for your shop.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
shopId |
required | path | int | the unique identifier of the shop | |
filterId |
query | |
optional saved Filter.Order ID; empty string for all | ||
page |
query | 0 |
int | zero-based page index | |
size |
query | 10 |
int | number of items per page |
| Code | Condition |
|---|---|
| 200 | the requested page of orders was returned |
<pagedData>
<records>...</records>
<totalElements>...</totalElements>
</pagedData>
{
"pagedData" : {
"records" : [ { }, { } ],
"totalElements" : 12345
}
}
/accounts/{accountId}/shops/{shopId}/orders/{orderId}
Get a single order by its id.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 200 | the order was returned |
| 404 | no order with the given id exists in this shop |
<productionOrder>
<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>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</billingAddress>
<shippingAddress>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</shippingAddress>
</customer>
<country>
<id>...</id>
<code>UK</code>
<name>United Kingdom</name>
<standardVat>
<id>...</id>
<percentValue>19</percentValue>
</standardVat>
<reducedVat>
<id>...</id>
<percentValue>19</percentValue>
</reducedVat>
<currency>
<id>...</id>
<code>EUR</code>
<symbol>€</symbol>
<name>Euro</name>
</currency>
<pricePrecision>2</pricePrecision>
<priceFractionalDigits>2</priceFractionalDigits>
<default>...</default>
</country>
<orderShipping>
<id>...</id>
<title>Zasilkovna - pickup point</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>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</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>
</productionOrder>
{
"productionOrder" : {
"id" : 12345,
"version" : 12345,
"uniqueId" : "...",
"customSticker" : "...",
"created" : 12345,
"financialStatus" : "PARTIALLY_PAID",
"fulfilmentStatus" : "RECLAMATION",
"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" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
},
"paid" : 12345,
"dataErasure" : {
"id" : 12345,
"personalDataErased" : true,
"printDataErased" : true,
"personalDataEraseDate" : 12345,
"printDataEraseDate" : 12345
},
"express" : true,
"comment" : "..."
}
}
/accounts/{accountId}/shops/{shopId}/orders/{orderId}
Update the uniqueId of an order. All other fields in the request body are
ignored. The request body must carry the order's current version for optimistic
locking; if it does not match the stored version the update is rejected and the order is left
unchanged.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
Order | the order data; must include the current version and the uniqueId to set |
application/xml |
Order |
| Code | Condition |
|---|---|
| 204 | the order was updated; the response body is empty |
| 404 | no order with the given id exists in this shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
<productionOrder>
<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>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</billingAddress>
<shippingAddress>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</shippingAddress>
</customer>
<country>
<id>...</id>
<code>UK</code>
<name>United Kingdom</name>
<standardVat>
<id>...</id>
<percentValue>19</percentValue>
</standardVat>
<reducedVat>
<id>...</id>
<percentValue>19</percentValue>
</reducedVat>
<currency>
<id>...</id>
<code>EUR</code>
<symbol>€</symbol>
<name>Euro</name>
</currency>
<pricePrecision>2</pricePrecision>
<priceFractionalDigits>2</priceFractionalDigits>
<default>...</default>
</country>
<orderShipping>
<id>...</id>
<title>Zasilkovna - pickup point</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>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</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>
</productionOrder>
{
"productionOrder" : {
"id" : 12345,
"version" : 12345,
"uniqueId" : "...",
"customSticker" : "...",
"created" : 12345,
"financialStatus" : "PARTIALLY_PAID",
"fulfilmentStatus" : "FINISHED",
"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" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
},
"paid" : 12345,
"dataErasure" : {
"id" : 12345,
"personalDataErased" : true,
"printDataErased" : true,
"personalDataEraseDate" : 12345,
"printDataEraseDate" : 12345
},
"express" : true,
"comment" : "..."
}
}
/accounts/{accountId}/shops/{shopId}/orders/{orderId}
Delete the order by its id.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 200 | the order was deleted; the response body is empty |
| 400 | the order is locked in production or has a pending cancellation and cannot be deleted directly; cancel it first |
| 404 | no order with the given id exists in this shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
/accounts/{accountId}/shops/{shopId}/orders/expanded
Get a list of all orders (expanded) for your shop.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
shopId |
required | path | int | the unique identifier of the shop | |
filterId |
query | |
optional saved Filter.Order ID; empty string for all | ||
page |
query | 0 |
int | zero-based page index | |
size |
query | 10 |
int | number of items per page |
| Code | Condition |
|---|---|
| 200 | the requested page of expanded orders was returned |
<pagedData>
<records>...</records>
<totalElements>...</totalElements>
</pagedData>
{
"pagedData" : {
"records" : [ { }, { } ],
"totalElements" : 12345
}
}
/accounts/{accountId}/shops/{shopId}/orders/session
Get the current session order.
Returns the order associated with your HTTP session without you having to know its id — the
read counterpart to POST session. See that endpoint for what the current session
order is.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 200 | the current session order was returned |
| 404 | the current session has no associated order |
<productionOrder>
<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>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</billingAddress>
<shippingAddress>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</shippingAddress>
</customer>
<country>
<id>...</id>
<code>UK</code>
<name>United Kingdom</name>
<standardVat>
<id>...</id>
<percentValue>19</percentValue>
</standardVat>
<reducedVat>
<id>...</id>
<percentValue>19</percentValue>
</reducedVat>
<currency>
<id>...</id>
<code>EUR</code>
<symbol>€</symbol>
<name>Euro</name>
</currency>
<pricePrecision>2</pricePrecision>
<priceFractionalDigits>2</priceFractionalDigits>
<default>...</default>
</country>
<orderShipping>
<id>...</id>
<title>Zasilkovna - pickup point</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>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</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>
</productionOrder>
{
"productionOrder" : {
"id" : 12345,
"version" : 12345,
"uniqueId" : "...",
"customSticker" : "...",
"created" : 12345,
"financialStatus" : "PENDING",
"fulfilmentStatus" : "PREPARED_TO_PRODUCE",
"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" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
},
"paid" : 12345,
"dataErasure" : {
"id" : 12345,
"personalDataErased" : true,
"printDataErased" : true,
"personalDataEraseDate" : 12345,
"printDataEraseDate" : 12345
},
"express" : true,
"comment" : "..."
}
}
/accounts/{accountId}/shops/{shopId}/orders/by-uniqueid/{uniqueId}
Get a single order by its custom uniqueId.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
shopId |
required | path | int | the unique identifier of the shop | |
uniqueId |
required | path | the custom external identifier assigned to the order |
| Code | Condition |
|---|---|
| 200 | the order was returned |
| 404 | no order with the given uniqueId exists in this shop |
<productionOrder>
<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>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</billingAddress>
<shippingAddress>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</shippingAddress>
</customer>
<country>
<id>...</id>
<code>UK</code>
<name>United Kingdom</name>
<standardVat>
<id>...</id>
<percentValue>19</percentValue>
</standardVat>
<reducedVat>
<id>...</id>
<percentValue>19</percentValue>
</reducedVat>
<currency>
<id>...</id>
<code>EUR</code>
<symbol>€</symbol>
<name>Euro</name>
</currency>
<pricePrecision>2</pricePrecision>
<priceFractionalDigits>2</priceFractionalDigits>
<default>...</default>
</country>
<orderShipping>
<id>...</id>
<title>Zasilkovna - pickup point</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>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</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>
</productionOrder>
{
"productionOrder" : {
"id" : 12345,
"version" : 12345,
"uniqueId" : "...",
"customSticker" : "...",
"created" : 12345,
"financialStatus" : "VOIDED",
"fulfilmentStatus" : "PREPARED_TO_PRODUCE",
"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" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
},
"paid" : 12345,
"dataErasure" : {
"id" : 12345,
"personalDataErased" : true,
"printDataErased" : true,
"personalDataEraseDate" : 12345,
"printDataEraseDate" : 12345
},
"express" : true,
"comment" : "..."
}
}
/accounts/{accountId}/shops/{shopId}/orders/expanded/{orderId}
Get a single order (expanded) by its id.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 200 | the expanded order was returned |
| 404 | no order with the given id exists in this shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
OrderExpanded | |
application/xml |
OrderExpanded |
<productionOrderExpanded>
<shippings>
<shippingLine>
<id>...</id>
<title>Zasilkovna - pickup point</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>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</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>Zasilkovna - pickup point</title>
<price>...</price>
<codPrice>...</codPrice>
<orderValue>...</orderValue>
<carrier/>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</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>
{
"productionOrderExpanded" : {
"shippings" : {
"shippingLine" : [ {
"id" : 12345,
"title" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
}, {
"id" : 12345,
"title" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
} ]
},
"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" : "REFUNDED",
"fulfilmentStatus" : "NOT_EDITABLE",
"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" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
},
"paid" : 12345,
"dataErasure" : {
"id" : 12345,
"personalDataErased" : true,
"printDataErased" : true,
"personalDataEraseDate" : 12345,
"printDataEraseDate" : 12345
},
"express" : true,
"comment" : "..."
}
}
/accounts/{accountId}/shops/{shopId}/orders/{orderId}/receiverAddress
Get the receiver address of an order. Returns the shipping address of the order's customer — the address the parcel is delivered to. An order without a customer or without a shipping address returns an empty address rather than an error.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 200 | the receiver address was returned |
| 404 | no order with the given id exists in this shop |
<address>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</address>
{
"address" : {
"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"
}
}
/accounts/{accountId}/shops/{shopId}/orders/{orderId}/senderAddress
Get the sender address of an order. Returns the return address stored on the order. An order that has no sender address of its own — the usual case, where the shop's address is used — returns an empty address rather than an error.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 200 | the sender address was returned |
| 404 | no order with the given id exists in this shop |
<address>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</address>
{
"address" : {
"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"
}
}
/accounts/{accountId}/shops/{shopId}/orders/{orderId}/shipping
Get the shipping lines of an order. Each line carries the chosen carrier, the shipping amounts charged and the pickup point. An order normally has exactly one line; the response is paginated for uniformity with the other list endpoints, but it is not pageable and always returns every line of the order.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 200 | the shipping lines were returned |
| 404 | no order with the given id exists in this shop |
<pagedData>
<records>...</records>
<totalElements>...</totalElements>
</pagedData>
{
"pagedData" : {
"records" : [ { }, { } ],
"totalElements" : 12345
}
}
/accounts/{accountId}/shops/{shopId}/orders/expanded/by-uniqueid/{uniqueId}
Get a single order (expanded) by its custom uniqueId.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
shopId |
required | path | int | the unique identifier of the shop | |
uniqueId |
required | path | the custom external identifier assigned to the order |
| Code | Condition |
|---|---|
| 200 | the expanded order was returned |
| 404 | no order with the given uniqueId exists in this shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
OrderExpanded | |
application/xml |
OrderExpanded |
<productionOrderExpanded>
<shippings>
<shippingLine>
<id>...</id>
<title>Zasilkovna - pickup point</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>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</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>Zasilkovna - pickup point</title>
<price>...</price>
<codPrice>...</codPrice>
<orderValue>...</orderValue>
<carrier/>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</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>
{
"productionOrderExpanded" : {
"shippings" : {
"shippingLine" : [ {
"id" : 12345,
"title" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
}, {
"id" : 12345,
"title" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
} ]
},
"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" : "RECLAMATION",
"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" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
},
"paid" : 12345,
"dataErasure" : {
"id" : 12345,
"personalDataErased" : true,
"printDataErased" : true,
"personalDataEraseDate" : 12345,
"printDataEraseDate" : 12345
},
"express" : true,
"comment" : "..."
}
}
/accounts/{accountId}/shops/{shopId}/orders/session
Create an order and make it the current session order.
The current session order is a convenience mechanism for a multi-step order-building flow: the
created order is associated with your HTTP session, so later calls can look it up by the
session instead of you having to track and pass an explicit order id at every step. It is the
same Order used everywhere else in this resource, keyed by session id as well —
not a separate cart or basket with its own pricing or line items. A session holds at most one
current order at a time; attempting to create a second one while a session order already exists
is rejected. Read the current session order back with the GET session endpoint,
and adopt a pre-existing order as the session order with PUT {orderId}/associate.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
Order | the order data used to create the order (same body as the plain create endpoint); the new order is bound to the current session |
application/xml |
Order |
| Code | Condition |
|---|---|
| 200 | the order was created and associated with the current session |
| 400 | the current session already has an associated order; read it with GET session before creating another |
<productionOrder>
<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>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</billingAddress>
<shippingAddress>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</shippingAddress>
</customer>
<country>
<id>...</id>
<code>UK</code>
<name>United Kingdom</name>
<standardVat>
<id>...</id>
<percentValue>19</percentValue>
</standardVat>
<reducedVat>
<id>...</id>
<percentValue>19</percentValue>
</reducedVat>
<currency>
<id>...</id>
<code>EUR</code>
<symbol>€</symbol>
<name>Euro</name>
</currency>
<pricePrecision>2</pricePrecision>
<priceFractionalDigits>2</priceFractionalDigits>
<default>...</default>
</country>
<orderShipping>
<id>...</id>
<title>Zasilkovna - pickup point</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>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</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>
</productionOrder>
{
"productionOrder" : {
"id" : 12345,
"version" : 12345,
"uniqueId" : "...",
"customSticker" : "...",
"created" : 12345,
"financialStatus" : "PAID",
"fulfilmentStatus" : "CANCELLATION_WAITING",
"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" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
},
"paid" : 12345,
"dataErasure" : {
"id" : 12345,
"personalDataErased" : true,
"printDataErased" : true,
"personalDataEraseDate" : 12345,
"printDataEraseDate" : 12345
},
"express" : true,
"comment" : "..."
}
}
<productionOrder>
<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>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</billingAddress>
<shippingAddress>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</shippingAddress>
</customer>
<country>
<id>...</id>
<code>UK</code>
<name>United Kingdom</name>
<standardVat>
<id>...</id>
<percentValue>19</percentValue>
</standardVat>
<reducedVat>
<id>...</id>
<percentValue>19</percentValue>
</reducedVat>
<currency>
<id>...</id>
<code>EUR</code>
<symbol>€</symbol>
<name>Euro</name>
</currency>
<pricePrecision>2</pricePrecision>
<priceFractionalDigits>2</priceFractionalDigits>
<default>...</default>
</country>
<orderShipping>
<id>...</id>
<title>Zasilkovna - pickup point</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>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</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>
</productionOrder>
{
"productionOrder" : {
"id" : 12345,
"version" : 12345,
"uniqueId" : "...",
"customSticker" : "...",
"created" : 12345,
"financialStatus" : "AUTHORIZED",
"fulfilmentStatus" : "RECLAMATION",
"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" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
},
"paid" : 12345,
"dataErasure" : {
"id" : 12345,
"personalDataErased" : true,
"printDataErased" : true,
"personalDataEraseDate" : 12345,
"printDataEraseDate" : 12345
},
"express" : true,
"comment" : "..."
}
}
/accounts/{accountId}/shops/{shopId}/orders/usingCreatorSE
Create a new order in deferred processing mode using the CreatorSE.OrderDeferred data type. The order payload is validated and stored; fulfillment is processed asynchronously.
When the order contains DesignElementDdf elements, the
productionResource.filename field is required and must include a file
extension (e.g. design.pdf). Orders submitted without it are rejected
with HTTP 400.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
CreatorSE.OrderDeferred | the order data including designs, customer info, and shipping.
For DDF design elements, productionResource.filename is required
and must include a file extension. |
application/xml |
CreatorSE.OrderDeferred |
| Code | Condition |
|---|---|
| 200 | the order was accepted and queued for processing |
| 400 | validation failed (e.g. missing country, customer address, or DDF filename without extension) |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
CreatorSE.OrderSubmited | |
application/xml |
CreatorSE.OrderSubmited |
<creatorse_productionOrderDeferred>
<uniqueId>...</uniqueId>
<financialStatus>...</financialStatus>
<customer>
<id>...</id>
<firstName>John</firstName>
<lastName>Doe</lastName>
<email>john.doe@emailservice.com</email>
<phone>+44208269323</phone>
<acceptsMarketing>...</acceptsMarketing>
<billingAddress>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</billingAddress>
<shippingAddress>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</shippingAddress>
</customer>
<shopAddress>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</shopAddress>
<country>
<id>...</id>
<code>UK</code>
<name>United Kingdom</name>
<standardVat>
<id>...</id>
<percentValue>19</percentValue>
</standardVat>
<reducedVat>
<id>...</id>
<percentValue>19</percentValue>
</reducedVat>
<currency>
<id>...</id>
<code>EUR</code>
<symbol>€</symbol>
<name>Euro</name>
</currency>
<pricePrecision>2</pricePrecision>
<priceFractionalDigits>2</priceFractionalDigits>
<default>...</default>
</country>
<orderShipping>
<id>...</id>
<title>Zasilkovna - pickup point</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>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</orderShipping>
<customSticker>...</customSticker>
<express>...</express>
<validateSuppliers>...</validateSuppliers>
<comment>...</comment>
<invoiceGroup>...</invoiceGroup>
<packagingReceipt>...</packagingReceipt>
<designs>
<creatorse_design>
<productId>...</productId>
<amount>...</amount>
<assignedSize>
<id>...</id>
<size/>
</assignedSize>
<assignedColor>
<id>...</id>
<color/>
</assignedColor>
<sku>...</sku>
<customReferenceId>Item 123456</customReferenceId>
<customLabel>...</customLabel>
<compositions>
<creatorse_composition>
<productArea/>
<previewResource/>
<elements>
<creatorse_designElementMotive/>
<creatorse_designElementDdf/>
<creatorse_designElementDecoration/>
</elements>
</creatorse_composition>
</compositions>
</creatorse_design>
</designs>
<templates>
<creatorse_designedTemplateProduct>
<templateProductId>...</templateProductId>
<amount>...</amount>
<assignedSize>
<id>...</id>
<size/>
</assignedSize>
<assignedColor>
<id>...</id>
<color/>
</assignedColor>
<templateProductSku>...</templateProductSku>
</creatorse_designedTemplateProduct>
</templates>
<customAttributes>
<orderCustomAttribute>
<id>...</id>
<name>...</name>
<value>...</value>
</orderCustomAttribute>
</customAttributes>
<passthroughItems>
<creatorse_passthroughItem>
<metadata>...</metadata>
<previewImage>...</previewImage>
<name>...</name>
<description>...</description>
<sku>...</sku>
<referenceId>...</referenceId>
<quantity>...</quantity>
<brand>...</brand>
<color>...</color>
<size>...</size>
</creatorse_passthroughItem>
</passthroughItems>
</creatorse_productionOrderDeferred>
{
"creatorse_productionOrderDeferred" : {
"uniqueId" : "...",
"financialStatus" : "PENDING",
"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"
}
},
"shopAddress" : {
"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" : "Zasilkovna - pickup point",
"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
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
},
"customSticker" : "...",
"express" : true,
"validateSuppliers" : true,
"comment" : "...",
"invoiceGroup" : "...",
"packagingReceipt" : "...",
"designs" : {
"creatorse_design" : [ {
"productId" : 12345,
"amount" : 12345,
"assignedSize" : {
"id" : 12345,
"size" : { }
},
"assignedColor" : {
"id" : 12345,
"color" : { }
},
"sku" : "...",
"customReferenceId" : "Item 123456",
"customLabel" : "...",
"compositions" : {
"creatorse_composition" : [ {
"productArea" : { },
"previewResource" : { },
"elements" : [ {
"creatorse_designElementMotive" : { }
}, {
"creatorse_designElementDdf" : { }
}, {
"creatorse_designElementDecoration" : { }
} ]
}, {
"productArea" : { },
"previewResource" : { },
"elements" : [ {
"creatorse_designElementMotive" : { }
}, {
"creatorse_designElementDdf" : { }
}, {
"creatorse_designElementDecoration" : { }
} ]
} ]
}
}, {
"productId" : 12345,
"amount" : 12345,
"assignedSize" : {
"id" : 12345,
"size" : { }
},
"assignedColor" : {
"id" : 12345,
"color" : { }
},
"sku" : "...",
"customReferenceId" : "Item 123456",
"customLabel" : "...",
"compositions" : {
"creatorse_composition" : [ {
"productArea" : { },
"previewResource" : { },
"elements" : [ {
"creatorse_designElementMotive" : { }
}, {
"creatorse_designElementDdf" : { }
}, {
"creatorse_designElementDecoration" : { }
} ]
}, {
"productArea" : { },
"previewResource" : { },
"elements" : [ {
"creatorse_designElementMotive" : { }
}, {
"creatorse_designElementDdf" : { }
}, {
"creatorse_designElementDecoration" : { }
} ]
} ]
}
} ]
},
"templates" : {
"creatorse_designedTemplateProduct" : [ {
"templateProductId" : 12345,
"amount" : 12345,
"assignedSize" : {
"id" : 12345,
"size" : { }
},
"assignedColor" : {
"id" : 12345,
"color" : { }
},
"templateProductSku" : "..."
}, {
"templateProductId" : 12345,
"amount" : 12345,
"assignedSize" : {
"id" : 12345,
"size" : { }
},
"assignedColor" : {
"id" : 12345,
"color" : { }
},
"templateProductSku" : "..."
} ]
},
"customAttributes" : {
"orderCustomAttribute" : [ {
"id" : 12345,
"name" : "...",
"value" : "..."
}, {
"id" : 12345,
"name" : "...",
"value" : "..."
} ]
},
"passthroughItems" : {
"creatorse_passthroughItem" : [ {
"metadata" : "...",
"previewImage" : "...",
"name" : "...",
"description" : "...",
"sku" : "...",
"referenceId" : "...",
"quantity" : 12345,
"brand" : "...",
"color" : "...",
"size" : "..."
}, {
"metadata" : "...",
"previewImage" : "...",
"name" : "...",
"description" : "...",
"sku" : "...",
"referenceId" : "...",
"quantity" : 12345,
"brand" : "...",
"color" : "...",
"size" : "..."
} ]
}
}
}
<productionOrderSubmited>
<id>...</id>
<uniqueId>...</uniqueId>
</productionOrderSubmited>
{
"productionOrderSubmited" : {
"id" : 12345,
"uniqueId" : "..."
}
}
/accounts/{accountId}/shops/{shopId}/orders/{destinationOrderId}/transferItems
Transfer ordered products from one order into another. Moves the given ordered products — or all of them, when none are listed — out of the source order and into the destination order. A typical use is consolidating the items a customer built up in an earlier order into the order they are working on now (for instance merging a previous session's order into the current session order). The destination order is the one named in the path. The source order must not yet have a financial status: once an order is processing or committed its items can no longer be transferred out of it.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
destinationOrderId |
required | path | int | the unique identifier of the order that receives the transferred items | |
shopId |
required | path | int | the unique identifier of the shop | |
orderedProductList |
query | optional ids of the ordered products to transfer; when omitted, all of the source order's items are transferred | |||
sourceOrderId |
query | 0 |
int | the unique identifier of the order the items are transferred from |
| Code | Condition |
|---|---|
| 204 | the items were transferred; the response body is empty |
| 409 | the source order was not found, the destination order was not found, or the source order already has a financial status set (it is already processing or committed and its items cannot be transferred out) |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
/accounts/{accountId}/shops/{shopId}/orders/{orderId}/associate
Make an existing order the current session order.
Looks up the order by its id and associates it with your HTTP session, so a flow that was
interrupted, or that starts from an order id you already hold, can resume using the session
order endpoints without passing the id again. See POST session for what the
current session order is. A session holds at most one current order at a time: re-associating
the order the session already holds is an idempotent no-op, but associating a different order
while one is already the session order is rejected.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order to make the current session order | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 204 | the order was associated with the current session; the response body is empty |
| 404 | no order with the given id exists in this shop |
| 500 | the current session already has a different associated order; re-associating
the order the session already holds is an idempotent 204 instead. This
condition is raised as an ApplicationException, which has no dedicated exception mapper and
therefore surfaces as 500 rather than a 409 Conflict; a
dedicated conflict mapper is a possible future change. To recover, read the existing
session order with GET session instead of associating another. |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
/accounts/{accountId}/shops/{shopId}/orders/{orderId}/cancelOrder
Cancels an existing order for a specific account and shop.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order to be canceled | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 204 | the order was cancelled; the response body is empty |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
/accounts/{accountId}/shops/{shopId}/orders/{orderId}/commitOrder
Commits an order for the given account and shop with an optional financial status.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order to be committed | |
shopId |
required | path | int | the unique identifier of the shop | |
financialStatus |
query | PENDING |
the financial status of the order; defaults to "PENDING" if not specified |
| Code | Condition |
|---|---|
| 204 | the order was committed; the response body is empty |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
/accounts/{accountId}/shops/{shopId}/orders/{orderId}/sendToProduction
Sends a committed order into the production and fulfilment pipeline.
The order's own stored data drives the hand-off: the Express production flag is
applied when the order is marked express, the order's invoice group is used when one is set,
and the order's customer comment, when present, is attached as a production comment. No
address or shipping data is submitted with this call because that information must already be
present on the order from its creation.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order to send to production | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 204 | the order was handed to the production pipeline; the response body is empty |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
/accounts/{accountId}/shops/{shopId}/orders/{orderId}/production/receiverAddress
Set the receiver address of an order.
The receiver address is the customer's shipping address, so this endpoint replaces
customer.shippingAddress; the customer's billing address is left untouched. Unlike
most order edits this one is accepted after the order has been sent to production — the
new address is written to the order and pushed to the fulfilment pipeline, which is the
supported way of correcting a delivery address on an order already in production. The address
is stored as a new record, so the id of a previously stored address is ignored.
Read the result back with GET {orderId}/receiverAddress.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
Address | the delivery address to store on the order |
application/xml |
Address |
| Code | Condition |
|---|---|
| 200 | the receiver address was stored; the response body is empty |
| 401 | no order with the given id exists in this account's shop. The order is validated before the method runs, so a wrong or unknown id is refused as unauthorized rather than as not found, and the response does not reveal whether the order exists elsewhere |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
<address>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</address>
{
"address" : {
"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"
}
}
/accounts/{accountId}/shops/{shopId}/orders/{orderId}/production/senderAddress
Clear the sender address of an order. The order falls back to the shop's own address as the return address. The change is pushed to the fulfilment pipeline, so it also applies to an order already in production. There is no equivalent for the receiver address, which an order cannot be without.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order | |
shopId |
required | path | int | the unique identifier of the shop |
| Code | Condition |
|---|---|
| 200 | the sender address was cleared; the response body is empty |
| 401 | no order with the given id exists in this account's shop. The order is validated before the method runs, so a wrong or unknown id is refused as unauthorized rather than as not found, and the response does not reveal whether the order exists elsewhere |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
/accounts/{accountId}/shops/{shopId}/orders/{orderId}/production/senderAddress
Set the sender address of an order.
The sender address is the return address printed on the parcel; when it is not set, the shop's
own address is used. Unlike most order edits this one is accepted after the order has been sent
to production — the new address is written to the order and pushed to the fulfilment
pipeline, which is the supported way of correcting an address on an order already in production.
The address is stored as a new record, so the id of a previously stored address is
ignored. Read the result back with GET {orderId}/senderAddress.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
Address | the sender address to store on the order |
application/xml |
Address |
| Code | Condition |
|---|---|
| 200 | the sender address was stored; the response body is empty |
| 401 | no order with the given id exists in this account's shop. The order is validated before the method runs, so a wrong or unknown id is refused as unauthorized rather than as not found, and the response does not reveal whether the order exists elsewhere |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
<address>
<id>...</id>
<street>Golborne Road</street>
<streetNo>45</streetNo>
<address2>...</address2>
<city>London</city>
<company>...</company>
<country>United Kingdom</country>
<firstName>John</firstName>
<lastName>Doe</lastName>
<latitude>45.41685</latitude>
<longitude>-71.6822</longitude>
<name>John Doe</name>
<phone>+44208269323</phone>
<email>john.doe@emailservice.com</email>
<province>...</province>
<zip>WC2N 5DU</zip>
<countryCode>UK</countryCode>
<provinceCode>...</provinceCode>
<stateCode>CA</stateCode>
<stateName>California</stateName>
</address>
{
"address" : {
"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"
}
}
/accounts/{accountId}/shops/{shopId}/orders/{orderId}/production/shipping
Change the shipping line of an order.
Picks the carrier the order ships with and the shipping amounts charged for it. The carrier is
addressed by carrier.id, taken from the shop's carriers; when no id is given the
carrier is looked up by carrier.name and then by
carrier.moduleProvider.id, neither of which is unique. Only the fields present in
the request body are changed — the rest of the line keeps its stored value. Shipping
amounts are stored as sent and are deliberately not recalculated against the carrier's zone
prices: the shop configures its own carriers and owns its rate card, so it decides what the
customer is charged for delivery, here and on order create alike.
An order carries a single shipping line, which this endpoint updates in place. Unlike most order edits
it is accepted after the order has been sent to production; the change is pushed to the
fulfilment pipeline, and if the carrier's label has already been booked the pipeline may reject
it asynchronously. Read the result back with GET {orderId}/shipping.
| Name | In | Default | Constraints | Description | |
|---|---|---|---|---|---|
x-auth-token |
header | The authentication token | |||
accountId |
required | path | int | the unique identifier of the account | |
orderId |
required | path | int | the unique identifier of the order | |
shopId |
required | path | int | the unique identifier of the shop |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
OrderShipping | the shipping line to store; carrier is required only when the
order has no carrier stored yet, the amounts and the pickup point are optional |
application/xml |
OrderShipping |
| Code | Condition |
|---|---|
| 200 | the shipping line was stored; the response body is empty |
| 401 | no order with the given id exists in this account's shop. The order is validated before the method runs, so a wrong or unknown id is refused as unauthorized rather than as not found, and the response does not reveal whether the order exists elsewhere |
| 404 | no carrier of this account matches the carrier in the request body, or the
order has no carrier stored yet and the body carries no carrier to supply
one |
| Media Type | Data Type | Description |
|---|---|---|
application/json |
object
|
|
application/xml |
anyType
|
<shippingLine>
<id>...</id>
<title>Zasilkovna - pickup point</title>
<price>...</price>
<codPrice>...</codPrice>
<orderValue>...</orderValue>
<carrier>
<id>...</id>
<name>UPS</name>
<description>Standard domestic shipping method</description>
<phoneRequired>true</phoneRequired>
<moduleProvider>
<id>...</id>
<name>Standard</name>
<provider>ups</provider>
<serviceType>standard</serviceType>
<moduleType/>
<letter>UPS</letter>
<useLastLabel>...</useLastLabel>
<packageLength>...</packageLength>
<packageWidth>...</packageWidth>
<packageHeight>...</packageHeight>
<defaultCountryOfOrigin>CZ</defaultCountryOfOrigin>
</moduleProvider>
<customProvider>...</customProvider>
<premium>...</premium>
<emdorsement>...</emdorsement>
<ddp>...</ddp>
<showTicketLogo>...</showTicketLogo>
<customApiUser>...</customApiUser>
<customApiKey>...</customApiKey>
<htmlTemplate>...</htmlTemplate>
<mainCarrier/>
<perProduct>...</perProduct>
</carrier>
<branchId>3701</branchId>
<preferedDeliveryTime>2019-04-25T18:02:07+02:00</preferedDeliveryTime>
</shippingLine>
{
"shippingLine" : {
"id" : 12345,
"title" : "Zasilkovna - pickup point",
"price" : 12345.0,
"codPrice" : 12345.0,
"orderValue" : 12345.0,
"carrier" : {
"id" : 12345,
"name" : "UPS",
"description" : "Standard domestic shipping method",
"phoneRequired" : true,
"moduleProvider" : {
"id" : 12345,
"name" : "Standard",
"provider" : "ups",
"serviceType" : "standard",
"moduleType" : { },
"letter" : "UPS",
"useLastLabel" : true,
"packageLength" : 12345,
"packageWidth" : 12345,
"packageHeight" : 12345,
"defaultCountryOfOrigin" : "CZ"
},
"customProvider" : "...",
"premium" : true,
"emdorsement" : "...",
"ddp" : true,
"showTicketLogo" : true,
"customApiUser" : "...",
"customApiKey" : "...",
"htmlTemplate" : "...",
"mainCarrier" : { },
"perProduct" : true
},
"branchId" : "3701",
"preferedDeliveryTime" : 12345
}
}