SharedProduct Data Type

A customer's saved design — a product with artwork applied, stored as a reusable shared product before it is added to an order.

Available Since
1.4.134
Properties
Name Type Description
id number Unique numeric identifier for the OrderedProduct.
version number Internal optimistic-locking version counter.
created number The autogenerated date and time (ISO 8601 format) when the order item was created.
uuid string The UUID identifier for the OrderedProduct.
assignedProductColor AssignedProductColor The color of this item.
useAllColorSize boolean When true, this design is available for all color and size variants of the product. When false, it is restricted to the color specified in assignedProductColor.
design Design Design data applied to this shared product, including compositions and design elements per view.
rest array of object HATEOAS navigation links to related endpoints.
Used in
POST /accounts/{accountId}/shops/{shopId}/orders/{orderId}/orderedProducts/{orderedProductId}/share response GET /accounts/{accountId}/shops/{shopId}/sharedProducts/{sharedProductId} response
SharedProduct (JSON) 
{
  "sharedProduct" : {
    "id" : 12345,
    "version" : 12345,
    "created" : 12345,
    "uuid" : "...",
    "assignedProductColor" : {
      "id" : 12345,
      "orderIndex" : 1,
      "productColor" : {
        "id" : 12345,
        "name" : "black"
      },
      "default" : true,
      "active" : true
    },
    "useAllColorSize" : true,
    "design" : {
      "id" : 12345,
      "product" : {
        "id" : 12345,
        "name" : "Premium T-shirt",
        "amountMultiply" : 12345,
        "artNr" : "180.42",
        "model" : "Exact 190",
        "hsCode" : "ABC123456789",
        "active" : true,
        "orderIndex" : 1
      },
      "price" : 12345.0
    },
    "rest" : [ { }, { } ]
  }
}
SharedProduct Data Type

A customer's saved design — a product with artwork applied, stored as a reusable shared product before it is added to an order.

Available Since
1.4.134
Properties
Name Type Description
assignedProductColor AssignedProductColor The color of this item.
created dateTime The autogenerated date and time (ISO 8601 format) when the order item was created.
design Design Design data applied to this shared product, including compositions and design elements per view.
id int Unique numeric identifier for the OrderedProduct.
link list of atomLink HATEOAS navigation links to related endpoints.
useAllColorSize boolean When true, this design is available for all color and size variants of the product. When false, it is restricted to the color specified in assignedProductColor.
uuid string The UUID identifier for the OrderedProduct.
version int Internal optimistic-locking version counter.
Used in
POST /accounts/{accountId}/shops/{shopId}/orders/{orderId}/orderedProducts/{orderedProductId}/share response GET /accounts/{accountId}/shops/{shopId}/sharedProducts/{sharedProductId} response
SharedProduct (XML) 
<sharedProduct>
  <id>...</id>
  <version>...</version>
  <created>2019-04-25T18:02:07+02:00</created>
  <uuid>...</uuid>
  <assignedProductColor>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productColor>
      <id>...</id>
      <name>black</name>
    </productColor>
    <default>...</default>
    <active>...</active>
  </assignedProductColor>
  <useAllColorSize>...</useAllColorSize>
  <design>
    <id>...</id>
    <product>
      <id>...</id>
      <name>Premium T-shirt</name>
      <amountMultiply>...</amountMultiply>
      <artNr>180.42</artNr>
      <model>Exact 190</model>
      <hsCode>ABC123456789</hsCode>
      <active>...</active>
      <orderIndex>1</orderIndex>
    </product>
    <price>...</price>
  </design>
  <link href="..." hreflang="..." length="..." rel="..." title="..." type="..." xmlns="http://www.w3.org/2005/Atom"/>
</sharedProduct>