CreatorSE.Design Data Type

A customized product design created by the end customer in the Creator SE. Contains one or more compositions, each targeting a specific product area (front, back, sleeve, etc.).

Properties
Name Type Description
productId number The identifier for the base product.
amount number Order item amount.
assignedSize CreatorSE.ProductAssignedSize Order item size.
assignedColor CreatorSE.ProductAssignedColor Order item color.
sku string Item SKU.
customReferenceId string Custom identification number.
customLabel string Custom label.
compositions array of CreatorSE.Composition A list of DesignCompositionCse objects.
Used in
POST /accounts/{accountId}/shops/{shopId}/orders/{orderId}/orderedProducts/usingCreatorSE request body
CreatorSE.Design (JSON) 
{
  "creatorse_design" : {
    "productId" : 12345,
    "amount" : 12345,
    "assignedSize" : {
      "id" : 12345,
      "size" : {
        "id" : 12345,
        "name" : "XL"
      }
    },
    "assignedColor" : {
      "id" : 12345,
      "color" : {
        "id" : 12345
      }
    },
    "sku" : "...",
    "customReferenceId" : "Item 123456",
    "customLabel" : "...",
    "compositions" : {
      "creatorse_composition" : [ {
        "productArea" : {
          "id" : 12345,
          "name" : "...",
          "assignedView" : { },
          "realSize" : { }
        },
        "previewResource" : {
          "attachment" : "...",
          "filename" : "...",
          "url" : "..."
        },
        "elements" : [ {
          "creatorse_designElementMotive" : {
            "motive" : { },
            "position" : { },
            "printTechnology" : { },
            "layers" : {
              "creatorse_designElementLayer" : [ { }, { } ]
            }
          }
        }, {
          "creatorse_designElementDdf" : {
            "previewResource" : { },
            "productionResource" : { },
            "position" : { },
            "printTechnology" : { },
            "layers" : {
              "creatorse_designElementLayer" : [ { }, { } ]
            }
          }
        }, {
          "creatorse_designElementDecoration" : {
            "sku" : "STICKER-WOVEN-001",
            "placement" : "chest-left",
            "position" : { },
            "printTechnology" : { },
            "layers" : {
              "creatorse_designElementLayer" : [ { }, { } ]
            }
          }
        } ]
      }, {
        "productArea" : {
          "id" : 12345,
          "name" : "...",
          "assignedView" : { },
          "realSize" : { }
        },
        "previewResource" : {
          "attachment" : "...",
          "filename" : "...",
          "url" : "..."
        },
        "elements" : [ {
          "creatorse_designElementMotive" : {
            "motive" : { },
            "position" : { },
            "printTechnology" : { },
            "layers" : {
              "creatorse_designElementLayer" : [ { }, { } ]
            }
          }
        }, {
          "creatorse_designElementDdf" : {
            "previewResource" : { },
            "productionResource" : { },
            "position" : { },
            "printTechnology" : { },
            "layers" : {
              "creatorse_designElementLayer" : [ { }, { } ]
            }
          }
        }, {
          "creatorse_designElementDecoration" : {
            "sku" : "STICKER-WOVEN-001",
            "placement" : "chest-left",
            "position" : { },
            "printTechnology" : { },
            "layers" : {
              "creatorse_designElementLayer" : [ { }, { } ]
            }
          }
        } ]
      } ]
    }
  }
}
CreatorSE.Design Data Type

A customized product design created by the end customer in the Creator SE. Contains one or more compositions, each targeting a specific product area (front, back, sleeve, etc.).

Properties
Name Type Description
amount int Order item amount.
assignedColor CreatorSE.ProductAssignedColor Order item color.
assignedSize CreatorSE.ProductAssignedSize Order item size.
creatorse_composition list of CreatorSE.Composition A list of DesignCompositionCse objects.
customLabel string Custom label.
customReferenceId string Custom identification number.
productId int The identifier for the base product.
sku string Item SKU.
Used in
POST /accounts/{accountId}/shops/{shopId}/orders/{orderId}/orderedProducts/usingCreatorSE request body
CreatorSE.Design (XML) 
<creatorse_design>
  <productId>...</productId>
  <amount>...</amount>
  <assignedSize>
    <id>...</id>
    <size>
      <id>...</id>
      <name>XL</name>
    </size>
  </assignedSize>
  <assignedColor>
    <id>...</id>
    <color>
      <id>...</id>
    </color>
  </assignedColor>
  <sku>...</sku>
  <customReferenceId>Item 123456</customReferenceId>
  <customLabel>...</customLabel>
  <compositions>
    <creatorse_composition>
      <productArea>
        <id>...</id>
        <name>...</name>
        <assignedView/>
        <realSize/>
      </productArea>
      <previewResource>
        <attachment>...</attachment>
        <filename>...</filename>
        <url>...</url>
      </previewResource>
      <elements>
        <creatorse_designElementMotive>
          <motive/>
        </creatorse_designElementMotive>
        <creatorse_designElementDdf>
          <previewResource/>
          <productionResource/>
        </creatorse_designElementDdf>
        <creatorse_designElementDecoration>
          <sku>STICKER-WOVEN-001</sku>
          <placement>chest-left</placement>
        </creatorse_designElementDecoration>
      </elements>
    </creatorse_composition>
  </compositions>
</creatorse_design>