OrderedProduct Data Type

A customized product line item within a production order. Contains the chosen product, color, size, applied design, and production-specific identifiers.

Available Since
1.3.0
Properties
Name Type Description
id number Unique numeric identifier for the OrderedProduct.
created number The autogenerated date and time (ISO 8601 format) when the order item was created.
assignedProductColor AssignedProductColor The color of this order item.
assignedProductSize AssignedProductSize The size of this order item.
amount number The number of items that were purchased.
price number The price of the item in the order currency.
uuid string The UUID identifier for the OrderedProduct.
customReferenceId string Custom identification number.
customLabel string Custom label.
Used in
POST /accounts/{accountId}/shops/{shopId}/orders/{orderId}/orderedProducts/usingCreatorSE response GET /accounts/{accountId}/shops/{shopId}/orders/{orderId}/orderedProducts/{orderedProductId} response
OrderedProduct (JSON) 
{
  "orderedProduct" : {
    "id" : 12345,
    "created" : 12345,
    "assignedProductColor" : {
      "id" : 12345,
      "orderIndex" : 1,
      "productColor" : {
        "id" : 12345,
        "name" : "black"
      },
      "default" : true,
      "active" : true
    },
    "assignedProductSize" : {
      "id" : 12345,
      "orderIndex" : 1,
      "default" : true,
      "productSize" : {
        "id" : 12345,
        "name" : "XXL",
        "dimensions" : 12345,
        "groupingId" : "...",
        "groupingDefault" : true
      },
      "width" : 47.0,
      "height" : 68.0,
      "length" : 12345.0,
      "accuracy" : 12345.0
    },
    "amount" : 2,
    "price" : 9.99,
    "uuid" : "...",
    "customReferenceId" : "Item 123456",
    "customLabel" : "..."
  }
}
OrderedProduct Data Type

A customized product line item within a production order. Contains the chosen product, color, size, applied design, and production-specific identifiers.

Available Since
1.3.0
Properties
Name Type Description
amount int The number of items that were purchased.
assignedProductColor AssignedProductColor The color of this order item.
assignedProductSize AssignedProductSize The size of this order item.
created dateTime The autogenerated date and time (ISO 8601 format) when the order item was created.
customLabel string Custom label.
customReferenceId string Custom identification number.
id int Unique numeric identifier for the OrderedProduct.
price decimal The price of the item in the order currency.
uuid string The UUID identifier for the OrderedProduct.
Used in
POST /accounts/{accountId}/shops/{shopId}/orders/{orderId}/orderedProducts/usingCreatorSE response GET /accounts/{accountId}/shops/{shopId}/orders/{orderId}/orderedProducts/{orderedProductId} response
OrderedProduct (XML) 
<orderedProduct>
  <id>...</id>
  <created>2019-04-25T18:02:07+02:00</created>
  <assignedProductColor>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productColor>
      <id>...</id>
      <name>black</name>
    </productColor>
    <default>...</default>
    <active>...</active>
  </assignedProductColor>
  <assignedProductSize>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <default>...</default>
    <productSize>
      <id>...</id>
      <name>XXL</name>
      <dimensions>...</dimensions>
      <groupingId>...</groupingId>
      <groupingDefault>...</groupingDefault>
    </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>