Interface IOrderConfig

Provides properties for the personalized orders. You can use these properties in params of the AuWidgetOrder class.

{
  "widgets": [
    {
      "name": "order-details",
      "type": "order",
      "params": {
        "images": "{{$['editor'].proofImages}}",
        "downloadUrls": "{{$['editor'].hiResUrls}}",
        "data": {
          "stateId": "{{$['editor'].stateId}}"
        }
      }
    }
  ]
}

Package: ui-framework

Properties

customPrice

The custom price for the order.

Declaration

customPrice: number

Property Value

Type	Description
number	The custom price for the order.

data

Custom data (as a JSON object).

Declaration

data: Object

Property Value

Type	Description
Object	Custom data (as a JSON object).

downloadUrls

An array of the print-ready files, which should be stored along with the order in your e-commerce system.

Declaration

downloadUrls: Array<string>

Property Value

Type	Description
Array<string>	An array of the print-ready files, which should be stored along with the order in your e-commerce system.

images

An array of URLs to preview images which should be stored along with the order in your e-commerce system.

Declaration

images: Array<string>

Property Value

Type	Description
Array<string>	An array of URLs to preview images which should be stored along with the order in your e-commerce system.

logRequest

If true, logging 'add-to-cart' requests (for Shopify only).

Declaration

logRequest: boolean

Property Value

Type	Description
boolean	If true, logging 'add-to-cart' requests (for Shopify only).

props

Custom properties. They don't appear in the order, but are available in the onSubmitting callback.

Declaration

props: Object

Property Value

Type	Description
Object	Custom properties. They don't appear in the order, but are available in the onSubmitting callback.

quantity

The number of ordered products. The default value is 1.

Declaration

quantity: number

Property Value

Type	Description
number	The number of ordered products. The default value is 1.

sku

Order line item SKU (for option-based product).

Declaration

sku: string

Property Value

Type	Description
string	Order line item SKU (for option-based product).

useBackOffice

Indicates if driver should perform some BackOffice actions.

Declaration

useBackOffice: boolean

Property Value

Type	Description
boolean	Indicates if driver should perform some BackOffice actions.