ProductExpanded Data Type

ProductPrime with embedded colors, sizes, views, print areas, and pricing. Use this representation to load the complete product configuration needed to drive a design creator.

Available Since
1.3.0
Properties
Name Type Description
localizations array of ProductLocalized A list of localization objects.
assignedSizes array of AssignedProductSizeExpanded A list of product sizes.
assignedColors array of AssignedProductColorExpanded A list of product colors.
assignedViews array of AssignedProductViewExpanded A list of product views.
Inherited from Product
NameTypeDescription
id number Unique numeric identifier for the Product.
name string The nonlocalized name of the Product.
amountMultiply number
artNr string Some additional identification.
model string Some additional identification.
hsCode string HsCode.
active boolean Wheter the product is enabled.
orderIndex number Sorting data.
Used in
ProductExpanded (JSON)
{
  "productExpanded" : {
    "localizations" : {
      "productLocalized" : [ {
        "id" : 12345,
        "language" : {
          "id" : 12345,
          "code" : "en",
          "name" : "English"
        },
        "name" : "Premium T-shirt",
        "description" : "Men's premium shirt",
        "shortDescription" : "A real classic T-shirt for men."
      }, {
        "id" : 12345,
        "language" : {
          "id" : 12345,
          "code" : "en",
          "name" : "English"
        },
        "name" : "Premium T-shirt",
        "description" : "Men's premium shirt",
        "shortDescription" : "A real classic T-shirt for men."
      } ]
    },
    "assignedSizes" : {
      "assignedProductSizeExpanded" : [ {
        "productSize" : {
          "localizations" : {
            "productSizeLocalized" : [ { }, { } ]
          },
          "id" : 12345,
          "name" : "XXL",
          "dimensions" : 12345,
          "groupingId" : "...",
          "groupingDefault" : true
        },
        "id" : 12345,
        "orderIndex" : 1,
        "default" : true,
        "width" : 47.0,
        "height" : 68.0,
        "length" : 12345.0,
        "accuracy" : 12345.0
      }, {
        "productSize" : {
          "localizations" : {
            "productSizeLocalized" : [ { }, { } ]
          },
          "id" : 12345,
          "name" : "XXL",
          "dimensions" : 12345,
          "groupingId" : "...",
          "groupingDefault" : true
        },
        "id" : 12345,
        "orderIndex" : 1,
        "default" : true,
        "width" : 47.0,
        "height" : 68.0,
        "length" : 12345.0,
        "accuracy" : 12345.0
      } ]
    },
    "assignedColors" : {
      "assignedProductColorExpanded" : [ {
        "productColor" : {
          "localizations" : {
            "productColorLocalized" : [ { }, { } ]
          },
          "id" : 12345,
          "name" : "black"
        },
        "id" : 12345,
        "orderIndex" : 1,
        "default" : true,
        "active" : true
      }, {
        "productColor" : {
          "localizations" : {
            "productColorLocalized" : [ { }, { } ]
          },
          "id" : 12345,
          "name" : "black"
        },
        "id" : 12345,
        "orderIndex" : 1,
        "default" : true,
        "active" : true
      } ]
    },
    "assignedViews" : {
      "assignedProductViewExpanded" : [ {
        "productView" : {
          "localizations" : {
            "productViewLocalized" : [ { }, { } ]
          },
          "id" : 12345,
          "name" : "Front view",
          "position" : "Front"
        },
        "areas" : {
          "productAreaExpanded" : [ {
            "realSizes" : {
              "areaRealSize" : [ { }, { } ]
            },
            "id" : 12345,
            "boundsXTwips" : 3390,
            "boundsYTwips" : 3990,
            "boundsWidthTwips" : 3500,
            "boundsHeightTwips" : 5980,
            "name" : "Front",
            "default" : true,
            "xHotSpotTwips" : 12345,
            "yHotSpotTwips" : 12345,
            "sizeHotSpotTwips" : 12345,
            "enabled" : true
          }, {
            "realSizes" : {
              "areaRealSize" : [ { }, { } ]
            },
            "id" : 12345,
            "boundsXTwips" : 3390,
            "boundsYTwips" : 3990,
            "boundsWidthTwips" : 3500,
            "boundsHeightTwips" : 5980,
            "name" : "Front",
            "default" : true,
            "xHotSpotTwips" : 12345,
            "yHotSpotTwips" : 12345,
            "sizeHotSpotTwips" : 12345,
            "enabled" : true
          } ]
        },
        "id" : 12345,
        "orderIndex" : 1,
        "defaultView" : true,
        "visibleInCreator" : true,
        "prioritizeOnOverview" : true,
        "type" : "TECHNICAL"
      }, {
        "productView" : {
          "localizations" : {
            "productViewLocalized" : [ { }, { } ]
          },
          "id" : 12345,
          "name" : "Front view",
          "position" : "Front"
        },
        "areas" : {
          "productAreaExpanded" : [ {
            "realSizes" : {
              "areaRealSize" : [ { }, { } ]
            },
            "id" : 12345,
            "boundsXTwips" : 3390,
            "boundsYTwips" : 3990,
            "boundsWidthTwips" : 3500,
            "boundsHeightTwips" : 5980,
            "name" : "Front",
            "default" : true,
            "xHotSpotTwips" : 12345,
            "yHotSpotTwips" : 12345,
            "sizeHotSpotTwips" : 12345,
            "enabled" : true
          }, {
            "realSizes" : {
              "areaRealSize" : [ { }, { } ]
            },
            "id" : 12345,
            "boundsXTwips" : 3390,
            "boundsYTwips" : 3990,
            "boundsWidthTwips" : 3500,
            "boundsHeightTwips" : 5980,
            "name" : "Front",
            "default" : true,
            "xHotSpotTwips" : 12345,
            "yHotSpotTwips" : 12345,
            "sizeHotSpotTwips" : 12345,
            "enabled" : true
          } ]
        },
        "id" : 12345,
        "orderIndex" : 1,
        "defaultView" : true,
        "visibleInCreator" : true,
        "prioritizeOnOverview" : true,
        "type" : "TECHNICAL"
      } ]
    },
    "id" : 12345,
    "name" : "Premium T-shirt",
    "amountMultiply" : 12345,
    "artNr" : "180.42",
    "model" : "Exact 190",
    "hsCode" : "ABC123456789",
    "active" : true,
    "orderIndex" : 1
  }
}
ProductExpanded Data Type

ProductPrime with embedded colors, sizes, views, print areas, and pricing. Use this representation to load the complete product configuration needed to drive a design creator.

Available Since
1.3.0
Properties
Name Type Description
assignedProductColorExpanded list of AssignedProductColorExpanded A list of product colors.
assignedProductSizeExpanded list of AssignedProductSizeExpanded A list of product sizes.
assignedProductViewExpanded list of AssignedProductViewExpanded A list of product views.
productLocalized list of ProductLocalized A list of localization objects.
Inherited from Product
NameTypeDescription
active boolean Wheter the product is enabled.
amountMultiply int  
artNr string Some additional identification.
hsCode string HsCode.
id int Unique numeric identifier for the Product.
model string Some additional identification.
name string The nonlocalized name of the Product.
orderIndex int Sorting data.
Used in
ProductExpanded (XML)
<productExpanded>
  <localizations>
    <productLocalized>
      <id>...</id>
      <language>
        <id>...</id>
        <code>en</code>
        <name>English</name>
      </language>
      <name>Premium T-shirt</name>
      <description>Men's premium shirt</description>
      <shortDescription>A real classic T-shirt for men.</shortDescription>
    </productLocalized>
  </localizations>
  <assignedSizes>
    <assignedProductSizeExpanded>
      <productSize>
        <localizations>
          <productSizeLocalized/>
        </localizations>
      </productSize>
      <id>...</id>
      <orderIndex>1</orderIndex>
      <default>...</default>
      <productSize/>
      <width>47</width>
      <height>68</height>
      <length>...</length>
      <accuracy>...</accuracy>
    </assignedProductSizeExpanded>
  </assignedSizes>
  <assignedColors>
    <assignedProductColorExpanded>
      <productColor>
        <localizations>
          <productColorLocalized/>
        </localizations>
      </productColor>
      <id>...</id>
      <orderIndex>1</orderIndex>
      <productColor/>
      <default>...</default>
      <active>...</active>
    </assignedProductColorExpanded>
  </assignedColors>
  <assignedViews>
    <assignedProductViewExpanded>
      <productView>
        <localizations>
          <productViewLocalized/>
        </localizations>
      </productView>
      <areas>
        <productAreaExpanded>
          <realSizes>
            <areaRealSize/>
          </realSizes>
        </productAreaExpanded>
      </areas>
      <id>...</id>
      <orderIndex>1</orderIndex>
      <productView/>
      <defaultView>...</defaultView>
      <visibleInCreator>...</visibleInCreator>
      <prioritizeOnOverview>...</prioritizeOnOverview>
      <type>...</type>
    </assignedProductViewExpanded>
  </assignedViews>
  <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>
</productExpanded>