CreatorSE.OrderDeferred Data Type

A deferred order submitted through the Creator SE with full customer, shipping, and design data. Contains the complete order payload including designs, customer information, and shipping address, ready for processing after payment confirmation.

Properties
Name Type Description
uniqueId string Custom orderId
financialStatus OrderFinancialStatus The status of payment associated with the order.
customer Customer Information about the customer. The order might not have a customer and apps should not depend on the existence of a customer object. This value might be null.
shopAddress Address
country Country
orderShipping OrderShipping
customSticker string Custom sticker.
express boolean Express order flag.
validateSuppliers boolean Opt-in supplier/stock availability enforcement. When true, every design and template item is checked against supplier availability and the whole order is rejected if any item lacks sufficient supply. Defaults to false so existing CreatorSE clients keep their current behaviour (no availability enforcement). Passthrough items are never supplier-validated.
comment string Optional comment field.
invoiceGroup string Optional invoiceGroup field.
packagingReceipt string Optional packagingReceipt field.
designs array of CreatorSE.Design A list of DesignCompositionCse objects.
templates array of CreatorSE.DesignedTemplateProduct A list of DesignedTemplateProductCse objects.
customAttributes array of OrderCustomAttribute A list of OrderCustomAttribute objects.
passthroughItems array of CreatorSE.PassthroughItem A list of passthrough items — simple warehouse products that pass through production untouched (no printing, no decoration). Separate from standard products. Max 100 items per order.
Used in
CreatorSE.OrderDeferred (JSON)
{
  "creatorse_productionOrderDeferred" : {
    "uniqueId" : "...",
    "financialStatus" : "PAID",
    "customer" : {
      "id" : 12345,
      "firstName" : "John",
      "lastName" : "Doe",
      "email" : "john.doe@emailservice.com",
      "phone" : "+44208269323",
      "acceptsMarketing" : true,
      "billingAddress" : {
        "id" : 12345,
        "street" : "Golborne Road",
        "streetNo" : "45",
        "address2" : "...",
        "city" : "London",
        "company" : "...",
        "country" : "United Kingdom",
        "firstName" : "John",
        "lastName" : "Doe",
        "latitude" : 45.41685,
        "longitude" : -71.6822,
        "name" : "John Doe",
        "phone" : "+44208269323",
        "email" : "john.doe@emailservice.com",
        "province" : "...",
        "zip" : "WC2N 5DU",
        "countryCode" : "UK",
        "provinceCode" : "...",
        "stateCode" : "CA",
        "stateName" : "California"
      },
      "shippingAddress" : {
        "id" : 12345,
        "street" : "Golborne Road",
        "streetNo" : "45",
        "address2" : "...",
        "city" : "London",
        "company" : "...",
        "country" : "United Kingdom",
        "firstName" : "John",
        "lastName" : "Doe",
        "latitude" : 45.41685,
        "longitude" : -71.6822,
        "name" : "John Doe",
        "phone" : "+44208269323",
        "email" : "john.doe@emailservice.com",
        "province" : "...",
        "zip" : "WC2N 5DU",
        "countryCode" : "UK",
        "provinceCode" : "...",
        "stateCode" : "CA",
        "stateName" : "California"
      }
    },
    "shopAddress" : {
      "id" : 12345,
      "street" : "Golborne Road",
      "streetNo" : "45",
      "address2" : "...",
      "city" : "London",
      "company" : "...",
      "country" : "United Kingdom",
      "firstName" : "John",
      "lastName" : "Doe",
      "latitude" : 45.41685,
      "longitude" : -71.6822,
      "name" : "John Doe",
      "phone" : "+44208269323",
      "email" : "john.doe@emailservice.com",
      "province" : "...",
      "zip" : "WC2N 5DU",
      "countryCode" : "UK",
      "provinceCode" : "...",
      "stateCode" : "CA",
      "stateName" : "California"
    },
    "country" : {
      "id" : 12345,
      "code" : "UK",
      "name" : "United Kingdom",
      "standardVat" : {
        "id" : 12345,
        "percentValue" : 19.0
      },
      "reducedVat" : {
        "id" : 12345,
        "percentValue" : 19.0
      },
      "currency" : {
        "id" : 12345,
        "code" : "EUR",
        "symbol" : "€",
        "name" : "Euro"
      },
      "pricePrecision" : 2,
      "priceFractionalDigits" : 2,
      "default" : true
    },
    "orderShipping" : {
      "id" : 12345,
      "title" : "...",
      "price" : 12345.0,
      "codPrice" : 12345.0,
      "orderValue" : 12345.0,
      "carrier" : {
        "id" : 12345,
        "name" : "UPS",
        "description" : "Standard domestic shipping method",
        "phoneRequired" : true,
        "moduleProvider" : { },
        "customProvider" : "...",
        "premium" : true,
        "emdorsement" : "...",
        "ddp" : true,
        "showTicketLogo" : true,
        "customApiUser" : "...",
        "customApiKey" : "...",
        "htmlTemplate" : "...",
        "mainCarrier" : { },
        "perProduct" : true
      }
    },
    "customSticker" : "...",
    "express" : true,
    "validateSuppliers" : true,
    "comment" : "...",
    "invoiceGroup" : "...",
    "packagingReceipt" : "...",
    "designs" : {
      "creatorse_design" : [ {
        "productId" : 12345,
        "amount" : 12345,
        "assignedSize" : {
          "id" : 12345,
          "size" : { }
        },
        "assignedColor" : {
          "id" : 12345,
          "color" : { }
        },
        "sku" : "...",
        "customReferenceId" : "Item 123456",
        "customLabel" : "...",
        "compositions" : {
          "creatorse_composition" : [ {
            "productArea" : { },
            "previewResource" : { },
            "elements" : [ {
              "creatorse_designElementMotive" : { }
            }, {
              "creatorse_designElementDdf" : { }
            }, {
              "creatorse_designElementDecoration" : { }
            } ]
          }, {
            "productArea" : { },
            "previewResource" : { },
            "elements" : [ {
              "creatorse_designElementMotive" : { }
            }, {
              "creatorse_designElementDdf" : { }
            }, {
              "creatorse_designElementDecoration" : { }
            } ]
          } ]
        }
      }, {
        "productId" : 12345,
        "amount" : 12345,
        "assignedSize" : {
          "id" : 12345,
          "size" : { }
        },
        "assignedColor" : {
          "id" : 12345,
          "color" : { }
        },
        "sku" : "...",
        "customReferenceId" : "Item 123456",
        "customLabel" : "...",
        "compositions" : {
          "creatorse_composition" : [ {
            "productArea" : { },
            "previewResource" : { },
            "elements" : [ {
              "creatorse_designElementMotive" : { }
            }, {
              "creatorse_designElementDdf" : { }
            }, {
              "creatorse_designElementDecoration" : { }
            } ]
          }, {
            "productArea" : { },
            "previewResource" : { },
            "elements" : [ {
              "creatorse_designElementMotive" : { }
            }, {
              "creatorse_designElementDdf" : { }
            }, {
              "creatorse_designElementDecoration" : { }
            } ]
          } ]
        }
      } ]
    },
    "templates" : {
      "creatorse_designedTemplateProduct" : [ {
        "templateProductId" : 12345,
        "amount" : 12345,
        "assignedSize" : {
          "id" : 12345,
          "size" : { }
        },
        "assignedColor" : {
          "id" : 12345,
          "color" : { }
        },
        "templateProductSku" : "..."
      }, {
        "templateProductId" : 12345,
        "amount" : 12345,
        "assignedSize" : {
          "id" : 12345,
          "size" : { }
        },
        "assignedColor" : {
          "id" : 12345,
          "color" : { }
        },
        "templateProductSku" : "..."
      } ]
    },
    "customAttributes" : {
      "orderCustomAttribute" : [ {
        "id" : 12345,
        "name" : "...",
        "value" : "..."
      }, {
        "id" : 12345,
        "name" : "...",
        "value" : "..."
      } ]
    },
    "passthroughItems" : {
      "creatorse_passthroughItem" : [ {
        "metadata" : "...",
        "previewImage" : "...",
        "name" : "...",
        "description" : "...",
        "sku" : "...",
        "referenceId" : "...",
        "quantity" : 12345,
        "brand" : "...",
        "color" : "...",
        "size" : "..."
      }, {
        "metadata" : "...",
        "previewImage" : "...",
        "name" : "...",
        "description" : "...",
        "sku" : "...",
        "referenceId" : "...",
        "quantity" : 12345,
        "brand" : "...",
        "color" : "...",
        "size" : "..."
      } ]
    }
  }
}
CreatorSE.OrderDeferred Data Type

A deferred order submitted through the Creator SE with full customer, shipping, and design data. Contains the complete order payload including designs, customer information, and shipping address, ready for processing after payment confirmation.

Properties
Name Type Description
comment string Optional comment field.
country Country  
creatorse_design list of CreatorSE.Design A list of DesignCompositionCse objects.
creatorse_designedTemplateProduct list of CreatorSE.DesignedTemplateProduct A list of DesignedTemplateProductCse objects.
creatorse_passthroughItem list of CreatorSE.PassthroughItem A list of passthrough items — simple warehouse products that pass through production untouched (no printing, no decoration). Separate from standard products. Max 100 items per order.
customSticker string Custom sticker.
customer Customer Information about the customer. The order might not have a customer and apps should not depend on the existence of a customer object. This value might be null.
express boolean Express order flag.
financialStatus OrderFinancialStatus The status of payment associated with the order.
invoiceGroup string Optional invoiceGroup field.
orderCustomAttribute list of OrderCustomAttribute A list of OrderCustomAttribute objects.
orderShipping OrderShipping  
packagingReceipt string Optional packagingReceipt field.
shopAddress Address  
uniqueId string Custom orderId
validateSuppliers boolean Opt-in supplier/stock availability enforcement. When true, every design and template item is checked against supplier availability and the whole order is rejected if any item lacks sufficient supply. Defaults to false so existing CreatorSE clients keep their current behaviour (no availability enforcement). Passthrough items are never supplier-validated.
Used in
CreatorSE.OrderDeferred (XML)
<creatorse_productionOrderDeferred>
  <uniqueId>...</uniqueId>
  <financialStatus>...</financialStatus>
  <customer>
    <id>...</id>
    <firstName>John</firstName>
    <lastName>Doe</lastName>
    <email>john.doe@emailservice.com</email>
    <phone>+44208269323</phone>
    <acceptsMarketing>...</acceptsMarketing>
    <billingAddress>
      <id>...</id>
      <street>Golborne Road</street>
      <streetNo>45</streetNo>
      <address2>...</address2>
      <city>London</city>
      <company>...</company>
      <country>United Kingdom</country>
      <firstName>John</firstName>
      <lastName>Doe</lastName>
      <latitude>45.41685</latitude>
      <longitude>-71.6822</longitude>
      <name>John Doe</name>
      <phone>+44208269323</phone>
      <email>john.doe@emailservice.com</email>
      <province>...</province>
      <zip>WC2N 5DU</zip>
      <countryCode>UK</countryCode>
      <provinceCode>...</provinceCode>
      <stateCode>CA</stateCode>
      <stateName>California</stateName>
    </billingAddress>
    <shippingAddress>
      <id>...</id>
      <street>Golborne Road</street>
      <streetNo>45</streetNo>
      <address2>...</address2>
      <city>London</city>
      <company>...</company>
      <country>United Kingdom</country>
      <firstName>John</firstName>
      <lastName>Doe</lastName>
      <latitude>45.41685</latitude>
      <longitude>-71.6822</longitude>
      <name>John Doe</name>
      <phone>+44208269323</phone>
      <email>john.doe@emailservice.com</email>
      <province>...</province>
      <zip>WC2N 5DU</zip>
      <countryCode>UK</countryCode>
      <provinceCode>...</provinceCode>
      <stateCode>CA</stateCode>
      <stateName>California</stateName>
    </shippingAddress>
  </customer>
  <shopAddress>
    <id>...</id>
    <street>Golborne Road</street>
    <streetNo>45</streetNo>
    <address2>...</address2>
    <city>London</city>
    <company>...</company>
    <country>United Kingdom</country>
    <firstName>John</firstName>
    <lastName>Doe</lastName>
    <latitude>45.41685</latitude>
    <longitude>-71.6822</longitude>
    <name>John Doe</name>
    <phone>+44208269323</phone>
    <email>john.doe@emailservice.com</email>
    <province>...</province>
    <zip>WC2N 5DU</zip>
    <countryCode>UK</countryCode>
    <provinceCode>...</provinceCode>
    <stateCode>CA</stateCode>
    <stateName>California</stateName>
  </shopAddress>
  <country>
    <id>...</id>
    <code>UK</code>
    <name>United Kingdom</name>
    <standardVat>
      <id>...</id>
      <percentValue>19</percentValue>
    </standardVat>
    <reducedVat>
      <id>...</id>
      <percentValue>19</percentValue>
    </reducedVat>
    <currency>
      <id>...</id>
      <code>EUR</code>
      <symbol>€</symbol>
      <name>Euro</name>
    </currency>
    <pricePrecision>2</pricePrecision>
    <priceFractionalDigits>2</priceFractionalDigits>
    <default>...</default>
  </country>
  <orderShipping>
    <id>...</id>
    <title>...</title>
    <price>...</price>
    <codPrice>...</codPrice>
    <orderValue>...</orderValue>
    <carrier>
      <id>...</id>
      <name>UPS</name>
      <description>Standard domestic shipping method</description>
      <phoneRequired>true</phoneRequired>
      <moduleProvider/>
      <customProvider>...</customProvider>
      <premium>...</premium>
      <emdorsement>...</emdorsement>
      <ddp>...</ddp>
      <showTicketLogo>...</showTicketLogo>
      <customApiUser>...</customApiUser>
      <customApiKey>...</customApiKey>
      <htmlTemplate>...</htmlTemplate>
      <mainCarrier/>
      <perProduct>...</perProduct>
    </carrier>
  </orderShipping>
  <customSticker>...</customSticker>
  <express>...</express>
  <validateSuppliers>...</validateSuppliers>
  <comment>...</comment>
  <invoiceGroup>...</invoiceGroup>
  <packagingReceipt>...</packagingReceipt>
  <designs>
    <creatorse_design>
      <productId>...</productId>
      <amount>...</amount>
      <assignedSize>
        <id>...</id>
        <size/>
      </assignedSize>
      <assignedColor>
        <id>...</id>
        <color/>
      </assignedColor>
      <sku>...</sku>
      <customReferenceId>Item 123456</customReferenceId>
      <customLabel>...</customLabel>
      <compositions>
        <creatorse_composition>
          <productArea/>
          <previewResource/>
          <elements>
            <creatorse_designElementMotive/>
            <creatorse_designElementDdf/>
            <creatorse_designElementDecoration/>
          </elements>
        </creatorse_composition>
      </compositions>
    </creatorse_design>
  </designs>
  <templates>
    <creatorse_designedTemplateProduct>
      <templateProductId>...</templateProductId>
      <amount>...</amount>
      <assignedSize>
        <id>...</id>
        <size/>
      </assignedSize>
      <assignedColor>
        <id>...</id>
        <color/>
      </assignedColor>
      <templateProductSku>...</templateProductSku>
    </creatorse_designedTemplateProduct>
  </templates>
  <customAttributes>
    <orderCustomAttribute>
      <id>...</id>
      <name>...</name>
      <value>...</value>
    </orderCustomAttribute>
  </customAttributes>
  <passthroughItems>
    <creatorse_passthroughItem>
      <metadata>...</metadata>
      <previewImage>...</previewImage>
      <name>...</name>
      <description>...</description>
      <sku>...</sku>
      <referenceId>...</referenceId>
      <quantity>...</quantity>
      <brand>...</brand>
      <color>...</color>
      <size>...</size>
    </creatorse_passthroughItem>
  </passthroughItems>
</creatorse_productionOrderDeferred>