ProductSku Data Type

Stock-keeping unit (SKU) identifying a specific product color and size combination. Use the SKU when submitting orders to unambiguously reference the exact product variant.

Available Since
1.3.0
Properties
Name Type Description
id number Unique numeric identifier for the ProductSku.
stockId number SKU ID
available boolean TRUE if product is available.
assignedSize AssignedProductSize The size variant assigned to this SKU.
assignedColor AssignedProductColor The color variant assigned to this SKU.
Used in
ProductSku (JSON)
{
  "productSku" : {
    "id" : 12345,
    "stockId" : 12345,
    "available" : true,
    "assignedSize" : {
      "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
    },
    "assignedColor" : {
      "id" : 12345,
      "orderIndex" : 1,
      "productColor" : {
        "id" : 12345,
        "name" : "black"
      },
      "default" : true,
      "active" : true
    }
  }
}
ProductSku Data Type

Stock-keeping unit (SKU) identifying a specific product color and size combination. Use the SKU when submitting orders to unambiguously reference the exact product variant.

Available Since
1.3.0
Properties
Name Type Description
assignedColor AssignedProductColor The color variant assigned to this SKU.
assignedSize AssignedProductSize The size variant assigned to this SKU.
available boolean TRUE if product is available.
id int Unique numeric identifier for the ProductSku.
stockId int SKU ID
Used in
ProductSku (XML)
<productSku>
  <id>...</id>
  <stockId>...</stockId>
  <available>...</available>
  <assignedSize>
    <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>
  </assignedSize>
  <assignedColor>
    <id>...</id>
    <orderIndex>1</orderIndex>
    <productColor>
      <id>...</id>
      <name>black</name>
    </productColor>
    <default>...</default>
    <active>...</active>
  </assignedColor>
</productSku>