Order Data Type

A production order submitted to the platform for manufacturing. Contains ordered products, customer shipping address, and current processing and fulfillment status.

Available Since
1.3.0
Subtypes
OrderExpanded
Properties
Name Type Description
id number Unique numeric identifier for the Order.
version number Indicates the version number of the production order. This field is typically used for optimistic locking to handle concurrent updates.
uniqueId string Custom orderId
customSticker string Custom label.
created number The autogenerated date and time (ISO 8601 format) when the order was created.
financialStatus OrderFinancialStatus The status of payment associated with the order.
fulfilmentStatus OrderFulfillmentStatus The order's status in terms of fulfilled line items.
customer Customer Information about the customer. The order might not have a customer and apps should not depend on the existence of a customer object. This value might be null.
country Country Represents the country associated with the production order. This variable is of type CountryPrime and provides information such as the country's code, name, VAT rates, currency, and other country-specific configurations important for order processing.
orderShipping OrderShipping Represents the shipping details associated with an order. This variable is of type OrderShippingPrime and provides information such as the shipping method, shipping company, costs, and other related details. It allows setting or getting the shipping information for a particular production order.
paid number Represents the date and time when the order was paid.
dataErasure OrderDataErasure Represents the data erasure details associated with a production order. Encapsulates information regarding the status and timestamps of the erasure process for personal and print data related to the order.
express boolean Express order flag.
comment string Optional comment field.
Used in
POST /accounts/{accountId}/shops/{shopId}/orders request body GET /accounts/{accountId}/shops/{shopId}/orders/{orderId} response PUT /accounts/{accountId}/shops/{shopId}/orders/{orderId} request body GET /accounts/{accountId}/shops/{shopId}/orders/by-uniqueid/{uniqueId} response
Order (JSON) 
{
  "productionOrder" : {
    "id" : 12345,
    "version" : 12345,
    "uniqueId" : "...",
    "customSticker" : "...",
    "created" : 12345,
    "financialStatus" : "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" : "...",
      "price" : 12345.0,
      "codPrice" : 12345.0,
      "orderValue" : 12345.0,
      "carrier" : {
        "id" : 12345,
        "name" : "UPS",
        "description" : "Standard domestic shipping method",
        "phoneRequired" : true,
        "moduleProvider" : { },
        "customProvider" : "...",
        "premium" : true,
        "emdorsement" : "...",
        "ddp" : true,
        "showTicketLogo" : true,
        "customApiUser" : "...",
        "customApiKey" : "...",
        "htmlTemplate" : "...",
        "mainCarrier" : { },
        "perProduct" : true
      }
    },
    "paid" : 12345,
    "dataErasure" : {
      "id" : 12345,
      "personalDataErased" : true,
      "printDataErased" : true,
      "personalDataEraseDate" : 12345,
      "printDataEraseDate" : 12345
    },
    "express" : true,
    "comment" : "..."
  }
}
Order Data Type

A production order submitted to the platform for manufacturing. Contains ordered products, customer shipping address, and current processing and fulfillment status.

Available Since
1.3.0
Subtypes
OrderExpanded
Properties
Name Type Description
comment string Optional comment field.
country Country Represents the country associated with the production order. This variable is of type CountryPrime and provides information such as the country's code, name, VAT rates, currency, and other country-specific configurations important for order processing.
created dateTime The autogenerated date and time (ISO 8601 format) when the order was created.
customSticker string Custom label.
customer Customer Information about the customer. The order might not have a customer and apps should not depend on the existence of a customer object. This value might be null.
dataErasure OrderDataErasure Represents the data erasure details associated with a production order. Encapsulates information regarding the status and timestamps of the erasure process for personal and print data related to the order.
express boolean Express order flag.
financialStatus OrderFinancialStatus The status of payment associated with the order.
fulfilmentStatus OrderFulfillmentStatus The order's status in terms of fulfilled line items.
id int Unique numeric identifier for the Order.
orderShipping OrderShipping Represents the shipping details associated with an order. This variable is of type OrderShippingPrime and provides information such as the shipping method, shipping company, costs, and other related details. It allows setting or getting the shipping information for a particular production order.
paid dateTime Represents the date and time when the order was paid.
uniqueId string Custom orderId
version int Indicates the version number of the production order. This field is typically used for optimistic locking to handle concurrent updates.
Used in
POST /accounts/{accountId}/shops/{shopId}/orders request body GET /accounts/{accountId}/shops/{shopId}/orders/{orderId} response PUT /accounts/{accountId}/shops/{shopId}/orders/{orderId} request body GET /accounts/{accountId}/shops/{shopId}/orders/by-uniqueid/{uniqueId} response
Order (XML) 
<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>...</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>
  </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>