Reference - IOM REST API - Order 2.3

Document View

This API specification is available for download as an Open API 3.0 YAML file:

Please configure your clients to use this authentication method to submit user name and password.

To generate a valid JSON Web Token (JWT), just log into the OMT, inspect the browser cookies and use the value of the cookie called 'OMS_IDENTITY' as JWT. Within a UI-client (e.g., Postman) choose *Bearer Token* and just type in a valid JWT.

The following permissions must be assigned to a shop:

- The permission
*Create order*is required to create an order. - The permission
*View order*is required to view an order. - The permission
*Order status web service*is required to view an order report/ order states for one or more orders. - The permission
*Change orders*is required to create change requests for an order. - The permission
*View order changes*is required to view change requests for an order.

Introduction

/shops/{shopId}/orders

This operation creates an order and starts order processing.

Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|

in path | shopId | integer `int64` | `1000` | Required | The ID of the shop |

**201** - Created

Response Header | Description |
---|---|

`Location` | The path to the newly created resource | Format: `url` |

**400** - Bad Request

**401** - Unauthorized Authentication information is missing or invalid

**403** - Forbidden

**415** - Unsupported Media Type

**500** - Internal Server Error An unexpected error occured

/shops/{shopId}/orders/{shopOrderNumber}

This operations returns details for an order based on the order number.

--

Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|

in path | shopId | integer `int64` | `1000` | Required | The ID of the shop | |

in path | shopOrderNumber | string | `ORDNB-000001` | Required | The order number as used by the shop |

**200** - OK

**400** - Bad Request

**401** - Unauthorized Authentication information is missing or invalid

**403** - Forbidden

**404** - Not Found

**415** - Unsupported Media Type

**500** - Internal Server Error An unexpected error occured

/shops/{shopId}/orders/{shopOrderNumber}/change-requests

This operation returns all change requests for an order.

--

Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|

in path | shopId | integer `int64` | `1000` | Required | The ID of the shop | |

in path | shopOrderNumber | string | `ORDNB-000001` | Required | The order number as used by the shop | |

in query | excludes | array | `changeRequest` | Excludes attributes from the return |

**200** - OK

**400** - Bad Request

**401** - Unauthorized Authentication information is missing or invalid

**403** - Forbidden

**404** - Not Found

**415** - Unsupported Media Type

**500** - Internal Server Error An unexpected error occured

This operation creates a change request for an order and starts processing.

Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|

in path | shopId | integer `int64` | `1000` | Required | The ID of the shop | |

in path | shopOrderNumber | string | `ORDNB-000001` | Required | The order number as used by the shop |

**201** - Created

Response Header | Description |
---|---|

`Location` | The path to the newly created resource | Format: `url` |

**400** - Bad Request

**401** - Unauthorized Authentication information is missing or invalid

**403** - Forbidden

**415** - Unsupported Media Type

**500** - Internal Server Error An unexpected error occured

/shops/{shopId}/orders/{shopOrderNumber}/change-requests/{changeRequestId}

This operation returns a change requests for an order.

--

Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|

in path | shopId | integer `int64` | `1000` | Required | The ID of the shop | |

in path | shopOrderNumber | string | `ORDNB-000001` | Required | The order number as used by the shop | |

in path | changeRequestId | string | `1573` | Required | The ID of a change request | |

in query | excludes | array | `changeRequest` | Excludes attributes from the return |

**200** - OK

**400** - Bad Request

**401** - Unauthorized Authentication information is missing or invalid

**403** - Forbidden

**404** - Not Found

**415** - Unsupported Media Type

**500** - Internal Server Error An unexpected error occured

/shops/{shopId}/order-states

This operation returns the order states of orders that match the given search criterias.

When using one search attribute with a list, e.g. emails, all orders matching ANY of the list element are selected.

Apart from this, the different search conditions are combined with AND.

--

Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|

in path | shopId | integer `int64` | `1000` | Required | The ID of the shop | |

in query | shopOrderNumbers | array | `2019-17891 | 2019-21432` | Order numbers as used by the shop | |

in query | shopCustomerNumbers | array | `CUST-930293 | 283102` | Customer numbers as used by the shop | |

in query | productNumbers | array | `["100120", "200230]"` | Product numbers as used by the shop | |

in query | statuses | array | `["STATE_COMMISSIONED", "STATE_DISPATCHED]"` | Order statuses as used by the shop | |

in query | emails | array | `["buyer@mycompany.com", "purchase@mycompany.com]"` | Emails defined in the order address(es) | |

in query | shopOrderCreationDate[gte] | string `date` | `2019-01-31T00:00:00.000Z` | The earliest date the shop created an order | |

in query | shopOrderCreationDate[lte] | string `date` | `2019-10-31T00:00:00.000Z` | The latest date the shop created an order | |

in query | orderBy | string | `shopOrderCreationDate` | `shopOrderCreationDate` | The attribute on which should be sorted. If unset, `shopOrderCreationDate` is used. |

in query | sortDirection | string | `ASC` | `ASC` | The sort direction the attribute should be sorted with. If unset, `ASC` is used. |

in query | offset | integer `int32` | `0` | `50` | The starting row (index) of the first element to return | Min Value: `0` |

in query | limit | integer `int32` | `50` | `25` | The number of items to return | Min Value: `1` |

**200** - OK

**400** - Bad Request

**401** - Unauthorized Authentication information is missing or invalid

**403** - Forbidden

**406** - Not Acceptable

**500** - Internal Server Error An unexpected error occured

Request and Response Object Schemata

- "changeRequest":objectRequired | A
`Order`

object. An order{- "shopOrderNumber":stringRequired | Order number as used by the shop (required for order creation).
`If change request, it must be equal to the origin order.`

| Min Length:`1`

| Max Length:`50`

| Example:`2019-089013`

- "shopOrderCreationDate":stringRequired | Creation date at the shop (ISO-8601) | Format:
`date-time`

| Example:`2019-09-14T14:22:32.123Z`

- "shopOrderUpdateDate":stringUpdate date at the shop (ISO-8601).
`Required if order change request, otherwise ignored.`

| Format:`date-time`

| Example:`2019-09-14T14:22:32.123Z`

- "reservationId":integerID of the stock reservation that was provided by the IOM reservation service | Format:
`int64`

| Example:`907041`

- "costCenter":stringThe name/ identifier of the related cost center | Min Length:
`0`

| Max Length:`100`

| Example:`2510-19`

- "project":stringThe name / identifier of the related project | Min Length:
`0`

| Max Length:`100`

| Example:`PR-911 CR7`

- "customerData":objectRequired | A
`CustomerData`

object. Details of the customer of the order.{- "customerDataType":stringRequired | Type of the customer.
`PERSON`

- The customer is a person.`COMPANY`

- The customer is a company.`companyData`

is required. | Example:`COMPANY`

| Possible Values:`PERSON`

`COMPANY`

- "orderNumber":stringOrder number as used by the shop customer | Min Length:
`0`

| Max Length:`50`

| Example:`BST-8911.2`

- "shopCustomerNumber":stringCustomer number as used by the shop | Min Length:
`0`

| Max Length:`255`

| Example:`CUST-7028A`

- "companyData":objectA
`CompanyData`

object. Detailed company data.{- "companyName":stringRequired | Name of the company | Min Length:
`1`

| Max Length:`100`

| Example:`Intershop Communications AG`

- "department":stringOrder by department | Min Length:
`0`

| Max Length:`50`

| Example:`Engineering`

- "lineOfBusiness":stringLine of business | Min Length:
`0`

| Max Length:`50`

| Example:`E-Commerce`

- "costCenterNumber":stringCost center number | Min Length:
`0`

| Max Length:`50`

| Example:`CC-1207`

- "commercialRegisterNumber":stringCommercial register number | Min Length:
`0`

| Max Length:`50`

| Example:`HRB 209419`

- "commercialRegisterLocation":stringLocation of Commercial register | Min Length:
`0`

| Max Length:`50`

| Example:`Amtsgericht Jena`

- "companyType":stringCorporate type | Min Length:
`0`

| Max Length:`50`

| Example:`Joint-stock company`

- "vatNumber":stringMin Length:
`0`

| Max Length:`25`

- "invoiceAddress":objectRequired | A
`AddressInvoice`

object. Details about the invoice address{- "location":objectRequired | A
`AddressLocation`

object. The location of the address. For type set one of`AddressLocationStreet`

,`AddressLocationPOBox`

or`AddressLocationPackstation`

. The latter is not allowed for invoicing addresses.{- "city":stringRequired | The city of the address | Min Length:
`1`

| Max Length:`100`

| Example:`Jena`

- "postCode":stringRequired | The postcode of the address | Min Length:
`1`

| Max Length:`25`

| Example:`07740`

- "district":stringThe district of the address | Min Length:
`0`

| Max Length:`100`

- "countryCode":stringRequired | The country code of the address (ISO-3166 alpha-3) | Example:
`DEU`

- "additions":arrayAn array of
`string`

literals. Additions to the address.`Note that at max 2 additions are allowed for packstation addresses.`

- "type":stringRequired

- "contact":objectA
`Contact`

object. Contact information{- "email":stringRequired | An e-mail address | Format:
`email`

| Min Length:`1`

| Max Length:`100`

| Example:`peter.sampleman@intershop.de`

- "phone":stringA phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 123456`

- "mobile":stringA mobile phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (165) 5673123`

- "fax":stringA fax number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 50-1344`

- "receiver":objectRequired | A
`AddressReceiver`

object. The receiver of the address, which can be a person or a company. At least one of it must be given.{- "addressReceiverType":stringRequired | Type of the receiver.
`PERSON`

- The receiver is a person.`person`

is required.`COMPANY`

- The receiver is a company.`companyName`

is required. | Example:`COMPANY`

| Possible Values:`PERSON`

`COMPANY`

- "person":objectA
`Person`

object. Name of a person{- "salutation":stringSalutation | Min Length:
`0`

| Max Length:`25`

| Example:`Mr.`

- "title":stringTitle | Min Length:
`0`

| Max Length:`25`

| Example:`C.P.A.`

- "firstName":stringFirst name | Min Length:
`0`

| Max Length:`50`

| Example:`John`

- "lastName":stringRequired | Last name | Min Length:
`1`

| Max Length:`50`

| Example:`Doe`

- "companyName":stringName of the company (required if COMPANY) | Min Length:
`0`

| Max Length:`100`

| Example:`Intershop Communications AG`

- "sales":objectRequired | A
`Sales`

object. Sales prices of the order{- "currencyCode":stringRequired | The currency of the sales prices (ISO 4217) | Example:
`EUR`

- "subTotal":objectRequired | A
`SumPrice`

object. Sum of prices including taxes and promotions.`Note that at least net or gross price must be given. If both given, gross must be greater than or equal to net.`

{- "net":objectA
`Price`

object. A price{- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectA
`Price`

object. A price{- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":arrayRequired | An array of
`Tax`

objects. Taxes related to the prices.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by the type in ascending order.[]`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":numberRate of the tax type in percentages. E.g. 5.3 for 5.3 %

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":stringLocation of the tax.

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":arrayAn array of
`Promotion`

objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.[]`Promotion`

: A promotion.

{- "promotionValueType":stringRequired | Type of the promotion value.
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":stringRequired | Identifier of the promotion | Min Length:
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":stringRequired | Name of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":numberRequired | The net amount given with the promotion.
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":numberRequired | The gross amount given with the promotion.
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "total":objectRequired | A
`TotalPrice`

object. Total price including taxes.`Note that at least net or gross price must be given. If both given, gross must be greater than or equal to net.`

{- "net":objectA
`Price`

object. A price{- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":arrayRequired | An array of
`Tax`

objects. Taxes related to the prices.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by type in ascending order.[]`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":numberRate of the tax type in percentages. E.g. 5.3 for 5.3 %

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":stringLocation of the tax.

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "charges":arrayAn array of
`Charge`

objects. Charges on order level. When returned charges are sorted by number in ascending order.[]`Charge`

: A charge. `Note that gross must be greater than or equal to net.`

{- "number":integerThe number of the charge. If set, it has to be unique within the order. | Format:
`int64`

| Example:`10`

- "type":stringRequired | The type of the charge | Example:
`DELIVERYCHARGE`

- "net":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":arrayRequired | An array of
`Tax`

objects. Taxes of the charge.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by type in ascending order.[]`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":numberRate of the tax type in percentages. E.g. 5.3 for 5.3 %

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":stringLocation of the tax.

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":arrayAn array of
`Promotion`

objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.[]`Promotion`

: A promotion.

{- "promotionValueType":stringRequired | Type of the promotion value.
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":stringRequired | Identifier of the promotion | Min Length:
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":stringRequired | Name of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":numberRequired | The net amount given with the promotion.
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":numberRequired | The gross amount given with the promotion.
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "payment":objectRequired | A
`Payment`

object. Payment information at order creation{- "paymentMethod":stringRequired | The payment method of the order | Example:
`PAYPAL`

- "paymentProviderOrderNo":stringOrder number as used by the payment service provider | Min Length:
`0`

| Max Length:`50`

| Example:`PSP-ORD-0000123`

- "paymentProviderRefNo":stringOrder reference as used by the payment service provider | Min Length:
`0`

| Max Length:`50`

| Example:`PSP-RN-0000123`

- "paymentProviderMerchantAccount":stringMerchant account used for the payment transaction | Min Length:
`0`

| Max Length:`100`

| Example:`BANKX-PSP-ABC`

- "optimizationRule":stringThe rule to optimize the order. If not set, the default rule of the shop will be used.
- "splitShipmentAllowed":booleanSpecifies whether the order is allowed to be splitted for the shipment
- "additionalAttributes":objectAdditional attributes of the order that can be grouped by a name
- "shippingBuckets":arrayRequired | An array of
`ShippingBucket`

objects. The shipping buckets of the order. When returned shipping buckets are sorted by number in ascending order.[]`ShippingBucket`

: A shipping bucket of an order

{- "number":stringThe number of the shipping bucket (blank values will be ignored). If set, it has to be unique within the order. | Example:
`1`

- "shippingAddress":objectRequired | A
`AddressShipping`

object. Details about the shipping address{- "location":objectRequired | A
`AddressLocation`

object. The location of the address. For type set one of`AddressLocationStreet`

,`AddressLocationPOBox`

or`AddressLocationPackstation`

. The latter is not allowed for invoicing addresses.{- "city":stringRequired | The city of the address | Min Length:
`1`

| Max Length:`100`

| Example:`Jena`

- "postCode":stringRequired | The postcode of the address | Min Length:
`1`

| Max Length:`25`

| Example:`07740`

- "district":stringThe district of the address | Min Length:
`0`

| Max Length:`100`

- "countryCode":stringRequired | The country code of the address (ISO-3166 alpha-3) | Example:
`DEU`

- "additions":arrayAn array of
`string`

literals. Additions to the address.`Note that at max 2 additions are allowed for packstation addresses.`

- "type":stringRequired

- "contact":objectA
`Contact`

object. Contact information{- "email":stringRequired | An e-mail address | Format:
`email`

| Min Length:`1`

| Max Length:`100`

| Example:`peter.sampleman@intershop.de`

- "phone":stringA phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 123456`

- "mobile":stringA mobile phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (165) 5673123`

- "fax":stringA fax number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 50-1344`

- "receiver":objectRequired | A
`AddressReceiver`

object. The receiver of the address, which can be a person or a company. At least one of it must be given.{- "addressReceiverType":stringRequired | Type of the receiver.
`PERSON`

- The receiver is a person.`person`

is required.`COMPANY`

- The receiver is a company.`companyName`

is required. | Example:`COMPANY`

| Possible Values:`PERSON`

`COMPANY`

- "person":objectA
`Person`

object. Name of a person{- "salutation":stringSalutation | Min Length:
`0`

| Max Length:`25`

| Example:`Mr.`

- "title":stringTitle | Min Length:
`0`

| Max Length:`25`

| Example:`C.P.A.`

- "firstName":stringFirst name | Min Length:
`0`

| Max Length:`50`

| Example:`John`

- "lastName":stringRequired | Last name | Min Length:
`1`

| Max Length:`50`

| Example:`Doe`

- "companyName":stringName of the company (required if COMPANY) | Min Length:
`0`

| Max Length:`100`

| Example:`Intershop Communications AG`

- "shippingMethod":stringThe desired shipping method | Example:
`DHL`

- "charges":arrayAn array of
`Charge`

objects. Charges of the shipping bucket, e.g. a shipping charge. When returned charges are sorted by number in ascending order.[]`Charge`

: A charge. `Note that gross must be greater than or equal to net.`

{- "number":integerThe number of the charge. If set, it has to be unique within the order. | Format:
`int64`

| Example:`10`

- "type":stringRequired | The type of the charge | Example:
`DELIVERYCHARGE`

- "net":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":arrayRequired | An array of
`Tax`

objects. Taxes of the charge.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":arrayAn array of
`Promotion`

objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.[]`Promotion`

: A promotion.

{- "promotionValueType":stringRequired | Type of the promotion value.
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":stringRequired | Identifier of the promotion | Min Length:
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":stringRequired | Name of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":numberRequired | The net amount given with the promotion.
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":numberRequired | The gross amount given with the promotion.
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "additionalAttributes":objectAdditional attributes of the shipping bucket that can be grouped by a name
- "positions":arrayRequired | An array of
`OrderPosition`

objects. Positions of the shipping bucket. When returned positions are sorted by number in ascending order.[]`OrderPosition`

: An order position of the shipping bucket

{- "number":integerThe number of the order position. If set, it has to be unique within the order. | Format:
`int32`

| Example:`3`

- "productUnit":stringUnit of the ordered quantity. Note that the unit is only used for invoice printing. | Example:
`liter`

- "product":objectRequired | A
`Product`

object. A product{- "name":stringRequired | The name of the product | Example:
`A Philosophy of Software Design`

- "number":stringRequired | The product number or ID, e.g. the stock keeping unit (SKU) | Example:
`BLK-MED-G123-GUC`

- "isbn":stringThe International Standard Book Number (ISBN) | Example:
`978-1732102200`

- "ean":integerThe International Article number (EAN) | Format:
`int64`

| Example:`47119910`

- "costCenter":stringThe name or identifier of the related cost center | Min Length:
`0`

| Max Length:`100`

| Example:`2510-19`

- "project":stringThe name or identifier of the related project | Min Length:
`0`

| Max Length:`100`

| Example:`PR-911 CR7`

- "additionalAttributes":objectAdditional attributes of the position that can be grouped by a name
- "quantity":integerRequired | The ordered quantity | Format:
`int32`

| Example:`5`

- "sum":objectRequired | A
`SumPrice`

object. Sum of prices including taxes and promotions.`Note that at least net or gross price must be given. If both given, gross must be greater than or equal to net.`

{- "net":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":arrayRequired | An array of
`Tax`

objects. Taxes related to the prices.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by the type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":arrayAn array of
`Promotion`

objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.`Promotion`

: A promotion.

{- "promotionValueType":string
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":string
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":string
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "unitPrice":objectA
`UnitPrice`

object. Price per product unit.{- "net":objectA
`ListPrice`

object. A list price{- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "listPrice":numberThe list price/ recommended retail price

- "gross":objectA
`ListPrice`

object. A list price{- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "listPrice":numberThe list price/ recommended retail price

- "shipping":objectRequired | A
`Shipping`

object. Shipping information{- "freightClass":stringThe shipping freight class
- "deliveryOptions":arrayAn array of
`string`

literals. The selected delivery options | Example:`DELIVERY_ON_ISLAND`

- "deliveryDate":objectRequired | A
`DeliveryDate`

object. The type of expected delivery, which can be standard, express, earliest or a desired date.{- "deliveryDateType":stringRequired | Type of the desired delivery date.
`STANDARD`

- The standard as configured by the shop.`EXPRESS`

- An express method of the shop.`name`

is required.`EARLIEST`

- Delivery not before this date.`desiredDeliveryDate`

is required.`FIXED`

- Delivery at that day.`desiredDeliveryDate`

is required. | Example:`STANDARD`

| Possible Values:`STANDARD`

`EXPRESS`

`EARLIEST`

`FIXED`

- "name":stringThe name of the delivery type for express delivery (required if EXPRESS, otherwise ignored) | Example:
`Go-Express`

- "desiredDeliveryDate":stringThe desired date in relation to the type (required if EARLIEST or FIXED, otherwise ignored) | Format:
`date-time`

- "expectedDeliveryDays":integerRequired | Expected delivery in days | Format:
`int32`

| Example:`3`

- "selectedSupplier":stringThe
`preferred`

supplier for the delivery of the position.`Note that the delivering supplier can be another one.`

| Example:`Warehouse Hamburg`

- "changeRequestId":stringRequired | The identifier of the change request | Min Length:
`0`

| Max Length:`255`

| Example:`2510-19`

`ChangeRequestView`

: Describes a change request to view{

- "changeRequest":objectRequired | A
`Order`

object. An order{- "shopOrderNumber":stringRequired | Order number as used by the shop (required for order creation).
`If change request, it must be equal to the origin order.`

| Min Length:`1`

| Max Length:`50`

| Example:`2019-089013`

- "shopOrderCreationDate":stringRequired | Creation date at the shop (ISO-8601) | Format:
`date-time`

| Example:`2019-09-14T14:22:32.123Z`

- "shopOrderUpdateDate":stringUpdate date at the shop (ISO-8601).
`Required if order change request, otherwise ignored.`

| Format:`date-time`

| Example:`2019-09-14T14:22:32.123Z`

- "reservationId":integerID of the stock reservation that was provided by the IOM reservation service | Format:
`int64`

| Example:`907041`

- "costCenter":stringThe name/ identifier of the related cost center | Min Length:
`0`

| Max Length:`100`

| Example:`2510-19`

- "project":stringThe name / identifier of the related project | Min Length:
`0`

| Max Length:`100`

| Example:`PR-911 CR7`

- "customerData":objectRequired | A
`CustomerData`

object. Details of the customer of the order.{- "customerDataType":stringRequired | Type of the customer.
`PERSON`

- The customer is a person.`COMPANY`

- The customer is a company.`companyData`

is required. | Example:`COMPANY`

| Possible Values:`PERSON`

`COMPANY`

- "orderNumber":stringOrder number as used by the shop customer | Min Length:
`0`

| Max Length:`50`

| Example:`BST-8911.2`

- "shopCustomerNumber":stringCustomer number as used by the shop | Min Length:
`0`

| Max Length:`255`

| Example:`CUST-7028A`

- "companyData":objectA
`CompanyData`

object. Detailed company data.{- "companyName":stringRequired | Name of the company | Min Length:
`1`

| Max Length:`100`

| Example:`Intershop Communications AG`

- "department":stringOrder by department | Min Length:
`0`

| Max Length:`50`

| Example:`Engineering`

- "lineOfBusiness":stringLine of business | Min Length:
`0`

| Max Length:`50`

| Example:`E-Commerce`

- "costCenterNumber":stringCost center number | Min Length:
`0`

| Max Length:`50`

| Example:`CC-1207`

- "commercialRegisterNumber":stringCommercial register number | Min Length:
`0`

| Max Length:`50`

| Example:`HRB 209419`

- "commercialRegisterLocation":stringLocation of Commercial register | Min Length:
`0`

| Max Length:`50`

| Example:`Amtsgericht Jena`

- "companyType":stringCorporate type | Min Length:
`0`

| Max Length:`50`

| Example:`Joint-stock company`

- "vatNumber":stringMin Length:
`0`

| Max Length:`25`

- "invoiceAddress":objectRequired | A
`AddressInvoice`

object. Details about the invoice address{- "location":objectRequired | A
`AddressLocation`

object. The location of the address. For type set one of`AddressLocationStreet`

,`AddressLocationPOBox`

or`AddressLocationPackstation`

. The latter is not allowed for invoicing addresses.{- "city":stringRequired | The city of the address | Min Length:
`1`

| Max Length:`100`

| Example:`Jena`

- "postCode":stringRequired | The postcode of the address | Min Length:
`1`

| Max Length:`25`

| Example:`07740`

- "district":stringThe district of the address | Min Length:
`0`

| Max Length:`100`

- "countryCode":stringRequired | The country code of the address (ISO-3166 alpha-3) | Example:
`DEU`

- "additions":arrayAn array of
`string`

literals. Additions to the address.`Note that at max 2 additions are allowed for packstation addresses.`

- "type":stringRequired

- "contact":objectA
`Contact`

object. Contact information{- "email":stringRequired | An e-mail address | Format:
`email`

| Min Length:`1`

| Max Length:`100`

| Example:`peter.sampleman@intershop.de`

- "phone":stringA phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 123456`

- "mobile":stringA mobile phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (165) 5673123`

- "fax":stringA fax number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 50-1344`

- "receiver":objectRequired | A
`AddressReceiver`

object. The receiver of the address, which can be a person or a company. At least one of it must be given.{- "addressReceiverType":stringRequired | Type of the receiver.
`PERSON`

- The receiver is a person.`person`

is required.`COMPANY`

- The receiver is a company.`companyName`

is required. | Example:`COMPANY`

| Possible Values:`PERSON`

`COMPANY`

- "person":objectA
`Person`

object. Name of a person{- "salutation":stringSalutation | Min Length:
`0`

| Max Length:`25`

| Example:`Mr.`

- "title":stringTitle | Min Length:
`0`

| Max Length:`25`

| Example:`C.P.A.`

- "firstName":stringFirst name | Min Length:
`0`

| Max Length:`50`

| Example:`John`

- "lastName":stringRequired | Last name | Min Length:
`1`

| Max Length:`50`

| Example:`Doe`

- "companyName":stringName of the company (required if COMPANY) | Min Length:
`0`

| Max Length:`100`

| Example:`Intershop Communications AG`

- "sales":objectRequired | A
`Sales`

object. Sales prices of the order{- "currencyCode":stringRequired | The currency of the sales prices (ISO 4217) | Example:
`EUR`

- "subTotal":objectRequired | A
`SumPrice`

object. Sum of prices including taxes and promotions.{- "net":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":arrayRequired | An array of
`Tax`

objects. Taxes related to the prices.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by the type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":arrayAn array of
`Promotion`

objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.`Promotion`

: A promotion.

{- "promotionValueType":string
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":string
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":string
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "total":objectRequired | A
`TotalPrice`

object. Total price including taxes.{- "net":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":arrayRequired | An array of
`Tax`

objects. Taxes related to the prices.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "charges":arrayAn array of
`Charge`

objects. Charges on order level. When returned charges are sorted by number in ascending order.[]`Charge`

: A charge. `Note that gross must be greater than or equal to net.`

{- "number":integerThe number of the charge. If set, it has to be unique within the order. | Format:
`int64`

| Example:`10`

- "type":stringRequired | The type of the charge | Example:
`DELIVERYCHARGE`

- "net":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":arrayRequired | An array of
`Tax`

objects. Taxes of the charge.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":arrayAn array of
`Promotion`

objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.`Promotion`

: A promotion.

{- "promotionValueType":string
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":string
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":string
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "payment":objectRequired | A
`Payment`

object. Payment information at order creation{- "paymentMethod":stringRequired | The payment method of the order | Example:
`PAYPAL`

- "paymentProviderOrderNo":stringOrder number as used by the payment service provider | Min Length:
`0`

| Max Length:`50`

| Example:`PSP-ORD-0000123`

- "paymentProviderRefNo":stringOrder reference as used by the payment service provider | Min Length:
`0`

| Max Length:`50`

| Example:`PSP-RN-0000123`

- "paymentProviderMerchantAccount":stringMerchant account used for the payment transaction | Min Length:
`0`

| Max Length:`100`

| Example:`BANKX-PSP-ABC`

- "optimizationRule":stringThe rule to optimize the order. If not set, the default rule of the shop will be used.
- "splitShipmentAllowed":booleanSpecifies whether the order is allowed to be splitted for the shipment
- "additionalAttributes":objectAdditional attributes of the order that can be grouped by a name
- "shippingBuckets":arrayRequired | An array of
`ShippingBucket`

objects. The shipping buckets of the order. When returned shipping buckets are sorted by number in ascending order.[]`ShippingBucket`

: A shipping bucket of an order

{- "number":stringThe number of the shipping bucket (blank values will be ignored). If set, it has to be unique within the order. | Example:
`1`

- "shippingAddress":objectRequired | A
`AddressShipping`

object. Details about the shipping address- "location":object
`AddressLocation`

object. The location of the address. For type set one of`AddressLocationStreet`

,`AddressLocationPOBox`

or`AddressLocationPackstation`

. The latter is not allowed for invoicing addresses.- "city":stringRequired | The city of the address | Min Length:
`1`

| Max Length:`100`

| Example:`Jena`

- "postCode":stringRequired | The postcode of the address | Min Length:
`1`

| Max Length:`25`

| Example:`07740`

- "district":stringThe district of the address | Min Length:
`0`

| Max Length:`100`

- "countryCode":stringRequired | The country code of the address (ISO-3166 alpha-3) | Example:
`DEU`

- "additions":array
`string`

literals. Additions to the address.`Note that at max 2 additions are allowed for packstation addresses.`

- "type":stringRequired

- "contact":objectA
`Contact`

object. Contact information- "email":string
`email`

| Min Length:`1`

| Max Length:`100`

| Example:`peter.sampleman@intershop.de`

- "phone":stringA phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 123456`

- "mobile":stringA mobile phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (165) 5673123`

- "fax":stringA fax number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 50-1344`

- "receiver":object
`AddressReceiver`

object. The receiver of the address, which can be a person or a company. At least one of it must be given.- "addressReceiverType":string
`PERSON`

- The receiver is a person.`person`

is required.`COMPANY`

- The receiver is a company.`companyName`

is required. | Example:`COMPANY`

| Possible Values:`PERSON`

`COMPANY`

- "person":objectA
`Person`

object. Name of a person- "salutation":stringSalutation | Min Length:
`0`

| Max Length:`25`

| Example:`Mr.`

- "title":stringTitle | Min Length:
`0`

| Max Length:`25`

| Example:`C.P.A.`

- "firstName":stringFirst name | Min Length:
`0`

| Max Length:`50`

| Example:`John`

- "lastName":stringRequired | Last name | Min Length:
`1`

| Max Length:`50`

| Example:`Doe`

- "companyName":string
`0`

| Max Length:`100`

| Example:`Intershop Communications AG`

- "shippingMethod":stringThe desired shipping method | Example:
`DHL`

- "charges":arrayAn array of
`Charge`

objects. Charges of the shipping bucket, e.g. a shipping charge. When returned charges are sorted by number in ascending order.`Charge`

: A charge. `Note that gross must be greater than or equal to net.`

{- "number":integer
`int64`

| Example:`10`

- "type":stringRequired | The type of the charge | Example:
`DELIVERYCHARGE`

- "net":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":array
`Tax`

objects. Taxes of the charge.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":array
`Promotion`

objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.`Promotion`

: A promotion.

{- "promotionValueType":string
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":string
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":string
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "additionalAttributes":objectAdditional attributes of the shipping bucket that can be grouped by a name
- "positions":arrayRequired | An array of
`OrderPosition`

objects. Positions of the shipping bucket. When returned positions are sorted by number in ascending order.[]`OrderPosition`

: An order position of the shipping bucket

{- "number":integerThe number of the order position. If set, it has to be unique within the order. | Format:
`int32`

| Example:`3`

- "productUnit":stringUnit of the ordered quantity. Note that the unit is only used for invoice printing. | Example:
`liter`

- "product":objectRequired | A
`Product`

object. A product{- "name":stringRequired | The name of the product | Example:
`A Philosophy of Software Design`

- "number":stringRequired | The product number or ID, e.g. the stock keeping unit (SKU) | Example:
`BLK-MED-G123-GUC`

- "isbn":stringThe International Standard Book Number (ISBN) | Example:
`978-1732102200`

- "ean":integerThe International Article number (EAN) | Format:
`int64`

| Example:`47119910`

- "costCenter":stringThe name or identifier of the related cost center | Min Length:
`0`

| Max Length:`100`

| Example:`2510-19`

- "project":stringThe name or identifier of the related project | Min Length:
`0`

| Max Length:`100`

| Example:`PR-911 CR7`

- "additionalAttributes":objectAdditional attributes of the position that can be grouped by a name
- "quantity":integerRequired | The ordered quantity | Format:
`int32`

| Example:`5`

- "sum":object
`SumPrice`

object. Sum of prices including taxes and promotions.- "net":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":array
`Tax`

objects. Taxes related to the prices.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by the type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":array
`Promotion`

objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.`Promotion`

: A promotion.

{- "promotionValueType":string
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":string
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":string
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "unitPrice":objectA
`UnitPrice`

object. Price per product unit.{- "net":objectA
`ListPrice`

object. A list price{- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "listPrice":numberThe list price/ recommended retail price

- "gross":objectA
`ListPrice`

object. A list price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "listPrice":numberThe list price/ recommended retail price

- "shipping":objectRequired | A
`Shipping`

object. Shipping information{- "freightClass":stringThe shipping freight class
- "deliveryOptions":arrayAn array of
`string`

literals. The selected delivery options | Example:`DELIVERY_ON_ISLAND`

- "deliveryDate":objectRequired | A
`DeliveryDate`

object. The type of expected delivery, which can be standard, express, earliest or a desired date.{- "deliveryDateType":stringRequired | Type of the desired delivery date.
`STANDARD`

- The standard as configured by the shop.`EXPRESS`

- An express method of the shop.`name`

is required.`EARLIEST`

- Delivery not before this date.`desiredDeliveryDate`

is required.`FIXED`

- Delivery at that day.`desiredDeliveryDate`

is required. | Example:`STANDARD`

| Possible Values:`STANDARD`

`EXPRESS`

`EARLIEST`

`FIXED`

- "name":stringThe name of the delivery type for express delivery (required if EXPRESS, otherwise ignored) | Example:
`Go-Express`

- "desiredDeliveryDate":stringThe desired date in relation to the type (required if EARLIEST or FIXED, otherwise ignored) | Format:
`date-time`

- "expectedDeliveryDays":integerRequired | Expected delivery in days | Format:
`int32`

| Example:`3`

- "selectedSupplier":stringThe
`preferred`

supplier for the delivery of the position.`Note that the delivering supplier can be another one.`

| Example:`Warehouse Hamburg`

- "changeRequestId":stringRequired | The identifier of the change request | Min Length:
`0`

| Max Length:`255`

| Example:`2510-19`

- "creator":stringRequired | Name of the creator of the change request
- "creationDate":stringRequired | Date of creation | Format:
`date-time`

- "updateDate":stringDate of the last update | Format:
`date-time`

- "status":stringRequired | The status of the change request | Example:
`ACCEPTED`

| Possible Values:`OPEN`

`ACCEPTED`

`APPLIED`

`FAILED_TO_APPLY`

- "status":integerThe HTTP-status code applicable to this problem, expressed as a string value | Format:
`int32`

| Example:`400`

- "errors":arrayAn array of
`Error`

objects.[]`Error`

{- "code":stringRequired | The code of the error | Example:
`VALIDATION_EXCEPTION`

- "message":stringRequired | The message of the error | Example:
`Attribute XYZ is mandatory`

- "value":objectThe value which caused the error

- "shopOrderNumber":stringRequired | Order number as used by the shop (required for order creation).
`If change request, it must be equal to the origin order.`

| Min Length:`1`

| Max Length:`50`

| Example:`2019-089013`

- "shopOrderCreationDate":stringRequired | Creation date at the shop (ISO-8601) | Format:
`date-time`

| Example:`2019-09-14T14:22:32.123Z`

- "shopOrderUpdateDate":stringUpdate date at the shop (ISO-8601).
`Required if order change request, otherwise ignored.`

| Format:`date-time`

| Example:`2019-09-14T14:22:32.123Z`

- "reservationId":integerID of the stock reservation that was provided by the IOM reservation service | Format:
`int64`

| Example:`907041`

- "costCenter":stringThe name/ identifier of the related cost center | Min Length:
`0`

| Max Length:`100`

| Example:`2510-19`

- "project":stringThe name / identifier of the related project | Min Length:
`0`

| Max Length:`100`

| Example:`PR-911 CR7`

- "customerData":objectRequired | A
`CustomerData`

object. Details of the customer of the order.{- "customerDataType":stringRequired | Type of the customer.
`PERSON`

- The customer is a person.`COMPANY`

- The customer is a company.`companyData`

is required. | Example:`COMPANY`

| Possible Values:`PERSON`

`COMPANY`

- "orderNumber":stringOrder number as used by the shop customer | Min Length:
`0`

| Max Length:`50`

| Example:`BST-8911.2`

- "shopCustomerNumber":stringCustomer number as used by the shop | Min Length:
`0`

| Max Length:`255`

| Example:`CUST-7028A`

- "companyData":objectA
`CompanyData`

object. Detailed company data.{- "companyName":stringRequired | Name of the company | Min Length:
`1`

| Max Length:`100`

| Example:`Intershop Communications AG`

- "department":stringOrder by department | Min Length:
`0`

| Max Length:`50`

| Example:`Engineering`

- "lineOfBusiness":stringLine of business | Min Length:
`0`

| Max Length:`50`

| Example:`E-Commerce`

- "costCenterNumber":stringCost center number | Min Length:
`0`

| Max Length:`50`

| Example:`CC-1207`

- "commercialRegisterNumber":stringCommercial register number | Min Length:
`0`

| Max Length:`50`

| Example:`HRB 209419`

- "commercialRegisterLocation":stringLocation of Commercial register | Min Length:
`0`

| Max Length:`50`

| Example:`Amtsgericht Jena`

- "companyType":stringCorporate type | Min Length:
`0`

| Max Length:`50`

| Example:`Joint-stock company`

- "vatNumber":stringMin Length:
`0`

| Max Length:`25`

- "invoiceAddress":objectRequired | A
`AddressInvoice`

object. Details about the invoice address- "location":object
`AddressLocation`

object. The location of the address. For type set one of`AddressLocationStreet`

,`AddressLocationPOBox`

or`AddressLocationPackstation`

. The latter is not allowed for invoicing addresses.- "city":stringRequired | The city of the address | Min Length:
`1`

| Max Length:`100`

| Example:`Jena`

- "postCode":stringRequired | The postcode of the address | Min Length:
`1`

| Max Length:`25`

| Example:`07740`

- "district":stringThe district of the address | Min Length:
`0`

| Max Length:`100`

- "countryCode":stringRequired | The country code of the address (ISO-3166 alpha-3) | Example:
`DEU`

- "additions":array
`string`

literals. Additions to the address.`Note that at max 2 additions are allowed for packstation addresses.`

- "type":stringRequired

- "contact":objectA
`Contact`

object. Contact information- "email":string
`email`

| Min Length:`1`

| Max Length:`100`

| Example:`peter.sampleman@intershop.de`

- "phone":stringA phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 123456`

- "mobile":stringA mobile phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (165) 5673123`

- "fax":stringA fax number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 50-1344`

- "receiver":object
`AddressReceiver`

object. The receiver of the address, which can be a person or a company. At least one of it must be given.- "addressReceiverType":string
`PERSON`

- The receiver is a person.`person`

is required.`COMPANY`

- The receiver is a company.`companyName`

is required. | Example:`COMPANY`

| Possible Values:`PERSON`

`COMPANY`

- "person":objectA
`Person`

object. Name of a person- "salutation":stringSalutation | Min Length:
`0`

| Max Length:`25`

| Example:`Mr.`

- "title":stringTitle | Min Length:
`0`

| Max Length:`25`

| Example:`C.P.A.`

- "firstName":stringFirst name | Min Length:
`0`

| Max Length:`50`

| Example:`John`

- "lastName":stringRequired | Last name | Min Length:
`1`

| Max Length:`50`

| Example:`Doe`

- "companyName":string
`0`

| Max Length:`100`

| Example:`Intershop Communications AG`

- "sales":objectRequired | A
`Sales`

object. Sales prices of the order{- "currencyCode":stringRequired | The currency of the sales prices (ISO 4217) | Example:
`EUR`

- "subTotal":object
`SumPrice`

object. Sum of prices including taxes and promotions.- "net":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":array
`Tax`

objects. Taxes related to the prices.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by the type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":array
`Promotion`

objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.`Promotion`

: A promotion.

{- "promotionValueType":string
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":string
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":string
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "total":objectRequired | A
`TotalPrice`

object. Total price including taxes.{- "net":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":arrayRequired | An array of
`Tax`

objects. Taxes related to the prices.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "charges":arrayAn array of
`Charge`

objects. Charges on order level. When returned charges are sorted by number in ascending order.`Charge`

: A charge. `Note that gross must be greater than or equal to net.`

{- "number":integer
`int64`

| Example:`10`

- "type":stringRequired | The type of the charge | Example:
`DELIVERYCHARGE`

- "net":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":array
`Tax`

objects. Taxes of the charge.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":array
`Promotion`

objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.`Promotion`

: A promotion.

{- "promotionValueType":string
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":string
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":string
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "payment":objectRequired | A
`Payment`

object. Payment information at order creation{- "paymentMethod":stringRequired | The payment method of the order | Example:
`PAYPAL`

- "paymentProviderOrderNo":stringOrder number as used by the payment service provider | Min Length:
`0`

| Max Length:`50`

| Example:`PSP-ORD-0000123`

- "paymentProviderRefNo":stringOrder reference as used by the payment service provider | Min Length:
`0`

| Max Length:`50`

| Example:`PSP-RN-0000123`

- "paymentProviderMerchantAccount":stringMerchant account used for the payment transaction | Min Length:
`0`

| Max Length:`100`

| Example:`BANKX-PSP-ABC`

- "optimizationRule":stringThe rule to optimize the order. If not set, the default rule of the shop will be used.
- "splitShipmentAllowed":booleanSpecifies whether the order is allowed to be splitted for the shipment
- "additionalAttributes":objectAdditional attributes of the order that can be grouped by a name
- "shippingBuckets":arrayRequired | An array of
`ShippingBucket`

objects. The shipping buckets of the order. When returned shipping buckets are sorted by number in ascending order.[]`ShippingBucket`

: A shipping bucket of an order

{- "number":stringThe number of the shipping bucket (blank values will be ignored). If set, it has to be unique within the order. | Example:
`1`

- "shippingAddress":objectRequired | A
`AddressShipping`

object. Details about the shipping address- "location":object
`AddressLocation`

object. The location of the address. For type set one of`AddressLocationStreet`

,`AddressLocationPOBox`

or`AddressLocationPackstation`

. The latter is not allowed for invoicing addresses.- "city":stringRequired | The city of the address | Min Length:
`1`

| Max Length:`100`

| Example:`Jena`

- "postCode":stringRequired | The postcode of the address | Min Length:
`1`

| Max Length:`25`

| Example:`07740`

- "district":stringThe district of the address | Min Length:
`0`

| Max Length:`100`

- "countryCode":stringRequired | The country code of the address (ISO-3166 alpha-3) | Example:
`DEU`

- "additions":array
`string`

literals. Additions to the address.`Note that at max 2 additions are allowed for packstation addresses.`

- "type":stringRequired

- "contact":objectA
`Contact`

object. Contact information- "email":string
`email`

| Min Length:`1`

| Max Length:`100`

| Example:`peter.sampleman@intershop.de`

- "phone":stringA phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 123456`

- "mobile":stringA mobile phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (165) 5673123`

- "fax":stringA fax number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 50-1344`

- "receiver":object
`AddressReceiver`

object. The receiver of the address, which can be a person or a company. At least one of it must be given.- "addressReceiverType":string
`PERSON`

- The receiver is a person.`person`

is required.`COMPANY`

- The receiver is a company.`companyName`

is required. | Example:`COMPANY`

| Possible Values:`PERSON`

`COMPANY`

- "person":objectA
`Person`

object. Name of a person- "salutation":stringSalutation | Min Length:
`0`

| Max Length:`25`

| Example:`Mr.`

- "title":stringTitle | Min Length:
`0`

| Max Length:`25`

| Example:`C.P.A.`

- "firstName":stringFirst name | Min Length:
`0`

| Max Length:`50`

| Example:`John`

- "lastName":stringRequired | Last name | Min Length:
`1`

| Max Length:`50`

| Example:`Doe`

- "companyName":string
`0`

| Max Length:`100`

| Example:`Intershop Communications AG`

- "shippingMethod":stringThe desired shipping method | Example:
`DHL`

- "charges":arrayAn array of
`Charge`

objects. Charges of the shipping bucket, e.g. a shipping charge. When returned charges are sorted by number in ascending order.`Charge`

: A charge. `Note that gross must be greater than or equal to net.`

{- "number":integer
`int64`

| Example:`10`

- "type":stringRequired | The type of the charge | Example:
`DELIVERYCHARGE`

- "net":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":array
`Tax`

objects. Taxes of the charge.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":array
`Promotion`

objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.`Promotion`

: A promotion.

{- "promotionValueType":string
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":string
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":string
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "additionalAttributes":objectAdditional attributes of the shipping bucket that can be grouped by a name
- "positions":arrayRequired | An array of
`OrderPosition`

objects. Positions of the shipping bucket. When returned positions are sorted by number in ascending order.[]`OrderPosition`

: An order position of the shipping bucket

{- "number":integerThe number of the order position. If set, it has to be unique within the order. | Format:
`int32`

| Example:`3`

- "productUnit":stringUnit of the ordered quantity. Note that the unit is only used for invoice printing. | Example:
`liter`

- "product":objectRequired | A
`Product`

object. A product{- "name":stringRequired | The name of the product | Example:
`A Philosophy of Software Design`

- "number":stringRequired | The product number or ID, e.g. the stock keeping unit (SKU) | Example:
`BLK-MED-G123-GUC`

- "isbn":stringThe International Standard Book Number (ISBN) | Example:
`978-1732102200`

- "ean":integerThe International Article number (EAN) | Format:
`int64`

| Example:`47119910`

- "costCenter":stringThe name or identifier of the related cost center | Min Length:
`0`

| Max Length:`100`

| Example:`2510-19`

- "project":stringThe name or identifier of the related project | Min Length:
`0`

| Max Length:`100`

| Example:`PR-911 CR7`

- "additionalAttributes":objectAdditional attributes of the position that can be grouped by a name
- "quantity":integerRequired | The ordered quantity | Format:
`int32`

| Example:`5`

- "sum":object
`SumPrice`

object. Sum of prices including taxes and promotions.- "net":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":array
`Tax`

objects. Taxes related to the prices.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by the type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":array
`Promotion`

objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.`Promotion`

: A promotion.

{- "promotionValueType":string
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":string
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":string
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "unitPrice":objectA
`UnitPrice`

object. Price per product unit.{- "net":objectA
`ListPrice`

object. A list price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "listPrice":numberThe list price/ recommended retail price

- "gross":objectA
`ListPrice`

object. A list price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "listPrice":numberThe list price/ recommended retail price

- "shipping":objectRequired | A
`Shipping`

object. Shipping information{- "freightClass":stringThe shipping freight class
- "deliveryOptions":arrayAn array of
`string`

literals. The selected delivery options | Example:`DELIVERY_ON_ISLAND`

- "deliveryDate":objectRequired | A
`DeliveryDate`

object. The type of expected delivery, which can be standard, express, earliest or a desired date.{- "deliveryDateType":stringRequired | Type of the desired delivery date.
`STANDARD`

- The standard as configured by the shop.`EXPRESS`

- An express method of the shop.`name`

is required.`EARLIEST`

- Delivery not before this date.`desiredDeliveryDate`

is required.`FIXED`

- Delivery at that day.`desiredDeliveryDate`

is required. | Example:`STANDARD`

| Possible Values:`STANDARD`

`EXPRESS`

`EARLIEST`

`FIXED`

- "name":stringThe name of the delivery type for express delivery (required if EXPRESS, otherwise ignored) | Example:
`Go-Express`

- "desiredDeliveryDate":stringThe desired date in relation to the type (required if EARLIEST or FIXED, otherwise ignored) | Format:
`date-time`

- "expectedDeliveryDays":integerRequired | Expected delivery in days | Format:
`int32`

| Example:`3`

- "selectedSupplier":stringThe
`preferred`

supplier for the delivery of the position.`Note that the delivering supplier can be another one.`

| Example:`Warehouse Hamburg`

- "data":arrayAn array of
`OrderState`

objects. The returned list of order states[]`OrderState`

: Information about the state of the order

{- "shopOrderNumber":string
`If change request, it must be equal to the origin order.`

| Min Length:`1`

| Max Length:`50`

| Example:`2019-089013`

- "shopOrderCreationDate":string
`date-time`

| Example:`2019-09-14T14:22:32.123Z`

- "shopOrderUpdateDate":string
`Required if order change request, otherwise ignored.`

| Format:`date-time`

| Example:`2019-09-14T14:22:32.123Z`

- "reservationId":integer
`int64`

| Example:`907041`

- "costCenter":stringThe name/ identifier of the related cost center | Min Length:
`0`

| Max Length:`100`

| Example:`2510-19`

- "project":stringThe name / identifier of the related project | Min Length:
`0`

| Max Length:`100`

| Example:`PR-911 CR7`

- "customerData":objectRequired | A
`CustomerData`

object. Details of the customer of the order.- "customerDataType":string
`PERSON`

- The customer is a person.`COMPANY`

- The customer is a company.`companyData`

is required. | Example:`COMPANY`

| Possible Values:`PERSON`

`COMPANY`

- "orderNumber":stringOrder number as used by the shop customer | Min Length:
`0`

| Max Length:`50`

| Example:`BST-8911.2`

- "shopCustomerNumber":stringCustomer number as used by the shop | Min Length:
`0`

| Max Length:`255`

| Example:`CUST-7028A`

- "companyData":objectA
`CompanyData`

object. Detailed company data.- "companyName":string
`1`

| Max Length:`100`

| Example:`Intershop Communications AG`

- "department":stringOrder by department | Min Length:
`0`

| Max Length:`50`

| Example:`Engineering`

- "lineOfBusiness":stringLine of business | Min Length:
`0`

| Max Length:`50`

| Example:`E-Commerce`

- "costCenterNumber":stringCost center number | Min Length:
`0`

| Max Length:`50`

| Example:`CC-1207`

- "commercialRegisterNumber":stringCommercial register number | Min Length:
`0`

| Max Length:`50`

| Example:`HRB 209419`

- "commercialRegisterLocation":stringLocation of Commercial register | Min Length:
`0`

| Max Length:`50`

| Example:`Amtsgericht Jena`

- "companyType":stringCorporate type | Min Length:
`0`

| Max Length:`50`

| Example:`Joint-stock company`

- "vatNumber":stringMin Length:
`0`

| Max Length:`25`

- "invoiceAddress":objectRequired | A
`AddressInvoice`

object. Details about the invoice address- "location":object
`AddressLocation`

object. The location of the address. For type set one of`AddressLocationStreet`

,`AddressLocationPOBox`

or`AddressLocationPackstation`

. The latter is not allowed for invoicing addresses.- "city":stringRequired | The city of the address | Min Length:
`1`

| Max Length:`100`

| Example:`Jena`

- "postCode":stringRequired | The postcode of the address | Min Length:
`1`

| Max Length:`25`

| Example:`07740`

- "district":stringThe district of the address | Min Length:
`0`

| Max Length:`100`

- "countryCode":stringRequired | The country code of the address (ISO-3166 alpha-3) | Example:
`DEU`

- "additions":array
`string`

literals. Additions to the address.`Note that at max 2 additions are allowed for packstation addresses.`

- "type":stringRequired

- "contact":objectA
`Contact`

object. Contact information- "email":string
`email`

| Min Length:`1`

| Max Length:`100`

| Example:`peter.sampleman@intershop.de`

- "phone":stringA phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 123456`

- "mobile":stringA mobile phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (165) 5673123`

- "fax":stringA fax number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 50-1344`

- "receiver":object
`AddressReceiver`

object. The receiver of the address, which can be a person or a company. At least one of it must be given.- "addressReceiverType":string
`PERSON`

- The receiver is a person.`person`

is required.`COMPANY`

- The receiver is a company.`companyName`

is required. | Example:`COMPANY`

| Possible Values:`PERSON`

`COMPANY`

- "person":objectA
`Person`

object. Name of a person- "salutation":stringSalutation | Min Length:
`0`

| Max Length:`25`

| Example:`Mr.`

- "title":stringTitle | Min Length:
`0`

| Max Length:`25`

| Example:`C.P.A.`

- "firstName":stringFirst name | Min Length:
`0`

| Max Length:`50`

| Example:`John`

- "lastName":stringRequired | Last name | Min Length:
`1`

| Max Length:`50`

| Example:`Doe`

- "companyName":string
`0`

| Max Length:`100`

| Example:`Intershop Communications AG`

- "sales":objectRequired | A
`Sales`

object. Sales prices of the order- "currencyCode":stringRequired | The currency of the sales prices (ISO 4217) | Example:
`EUR`

- "subTotal":object
`SumPrice`

object. Sum of prices including taxes and promotions.- "net":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":array
`Tax`

objects. Taxes related to the prices.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by the type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":array
`Promotion`

objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.`Promotion`

: A promotion.

{- "promotionValueType":string
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":string
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":string
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "total":object
`TotalPrice`

object. Total price including taxes.- "net":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":array
`Tax`

objects. Taxes related to the prices.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "charges":array
`Charge`

objects. Charges on order level. When returned charges are sorted by number in ascending order.`Charge`

: A charge. `Note that gross must be greater than or equal to net.`

{- "number":integer
`int64`

| Example:`10`

- "type":stringRequired | The type of the charge | Example:
`DELIVERYCHARGE`

- "net":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":array
`Tax`

objects. Taxes of the charge.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":array
`Promotion`

objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.`Promotion`

: A promotion.

{- "promotionValueType":string
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":string
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":string
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "payment":objectRequired | A
`Payment`

object. Payment information at order creation- "paymentMethod":stringRequired | The payment method of the order | Example:
`PAYPAL`

- "paymentProviderOrderNo":string
`0`

| Max Length:`50`

| Example:`PSP-ORD-0000123`

- "paymentProviderRefNo":string
`0`

| Max Length:`50`

| Example:`PSP-RN-0000123`

- "paymentProviderMerchantAccount":string
`0`

| Max Length:`100`

| Example:`BANKX-PSP-ABC`

- "optimizationRule":stringThe rule to optimize the order. If not set, the default rule of the shop will be used.
- "splitShipmentAllowed":booleanSpecifies whether the order is allowed to be splitted for the shipment
- "additionalAttributes":objectAdditional attributes of the order that can be grouped by a name
- "shippingBuckets":arrayRequired | An array of
`ShippingBucketOrderState`

objects. The shipping buckets of the order[]`ShippingBucketOrderState`

: A shipping bucket of an order state

{- "number":string
`1`

- "shippingAddress":objectRequired | A
`AddressShipping`

object. Details about the shipping address- "location":object
`AddressLocation`

object. The location of the address. For type set one of`AddressLocationStreet`

,`AddressLocationPOBox`

or`AddressLocationPackstation`

. The latter is not allowed for invoicing addresses.- "city":stringRequired | The city of the address | Min Length:
`1`

| Max Length:`100`

| Example:`Jena`

- "postCode":stringRequired | The postcode of the address | Min Length:
`1`

| Max Length:`25`

| Example:`07740`

- "district":stringThe district of the address | Min Length:
`0`

| Max Length:`100`

- "countryCode":stringRequired | The country code of the address (ISO-3166 alpha-3) | Example:
`DEU`

- "additions":array
`string`

literals. Additions to the address.`Note that at max 2 additions are allowed for packstation addresses.`

- "type":stringRequired

- "contact":objectA
`Contact`

object. Contact information- "email":string
`email`

| Min Length:`1`

| Max Length:`100`

| Example:`peter.sampleman@intershop.de`

- "phone":stringA phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 123456`

- "mobile":stringA mobile phone number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (165) 5673123`

- "fax":stringA fax number | Min Length:
`0`

| Max Length:`25`

| Example:`+49 (3641) 50-1344`

- "receiver":object
`AddressReceiver`

object. The receiver of the address, which can be a person or a company. At least one of it must be given.- "addressReceiverType":string
`PERSON`

- The receiver is a person.`person`

is required.`COMPANY`

- The receiver is a company.`companyName`

is required. | Example:`COMPANY`

| Possible Values:`PERSON`

`COMPANY`

- "person":objectA
`Person`

object. Name of a person- "salutation":stringSalutation | Min Length:
`0`

| Max Length:`25`

| Example:`Mr.`

- "title":stringTitle | Min Length:
`0`

| Max Length:`25`

| Example:`C.P.A.`

- "firstName":stringFirst name | Min Length:
`0`

| Max Length:`50`

| Example:`John`

- "lastName":stringRequired | Last name | Min Length:
`1`

| Max Length:`50`

| Example:`Doe`

- "companyName":string
`0`

| Max Length:`100`

| Example:`Intershop Communications AG`

- "shippingMethod":stringThe desired shipping method | Example:
`DHL`

- "charges":array
`Charge`

objects. Charges of the shipping bucket, e.g. a shipping charge. When returned charges are sorted by number in ascending order.`Charge`

: A charge. `Note that gross must be greater than or equal to net.`

{- "number":integer
`int64`

| Example:`10`

- "type":stringRequired | The type of the charge | Example:
`DELIVERYCHARGE`

- "net":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectRequired | A
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":array
`Tax`

objects. Taxes of the charge.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":array
`Promotion`

objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.`Promotion`

: A promotion.

{- "promotionValueType":string
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":string
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":string
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "additionalAttributes":objectAdditional attributes of the shipping bucket that can be grouped by a name
- "positions":arrayRequired | An array of
`OrderStatePosition`

objects. Positions of the shipping bucket[]`OrderStatePosition`

: A position of the order state shipping bucket

{- "number":integer
`int32`

| Example:`3`

- "productUnit":stringUnit of the ordered quantity. Note that the unit is only used for invoice printing. | Example:
`liter`

- "product":objectRequired | A
`Product`

object. A product- "name":stringRequired | The name of the product | Example:
`A Philosophy of Software Design`

- "number":stringRequired | The product number or ID, e.g. the stock keeping unit (SKU) | Example:
`BLK-MED-G123-GUC`

- "isbn":stringThe International Standard Book Number (ISBN) | Example:
`978-1732102200`

- "ean":integerThe International Article number (EAN) | Format:
`int64`

| Example:`47119910`

- "costCenter":string
`0`

| Max Length:`100`

| Example:`2510-19`

- "project":string
`0`

| Max Length:`100`

| Example:`PR-911 CR7`

- "additionalAttributes":objectAdditional attributes of the position that can be grouped by a name
- "status":stringRequired | The status of the order position | Example:
`STATE_DO_APPROVE`

- "ordered":objectA
`OrderPositionOrdered`

object. Details of an ordered position{- "shipping":objectRequired | A
`OrderStateShipping`

object. Shipping information{- "freightClass":stringThe shipping freight class
- "deliveryOptions":arrayAn array of
`string`

literals. The selected delivery options | Example:`DELIVERY_ON_ISLAND`

- "deliveryDate":object
`DeliveryDate`

object. The type of expected delivery, which can be standard, express, earliest or a desired date.- "deliveryDateType":string
`STANDARD`

- The standard as configured by the shop.`EXPRESS`

- An express method of the shop.`name`

is required.`EARLIEST`

- Delivery not before this date.`desiredDeliveryDate`

is required.`FIXED`

- Delivery at that day.`desiredDeliveryDate`

is required. | Example:`STANDARD`

| Possible Values:`STANDARD`

`EXPRESS`

`EARLIEST`

`FIXED`

- "name":string
`Go-Express`

- "desiredDeliveryDate":string
`date-time`

- "expectedDeliveryDays":integerRequired | Expected delivery in days | Format:
`int32`

| Example:`3`

- "supplierExpectedDeliveryDays":integerSupplier expected delivery in days | Format:
`int32`

| Example:`3`

- "confirmedDeliveryDate":stringThe delivey date, as confirmed by the supplier | Format:
`date-time`

- "selectedSupplier":stringThe selected supplier for delivery | Example:
`Warehouse Hamburg`

- "quantity":integerRequired | The ordered quantity | Format:
`int32`

| Example:`1`

- "sum":object
`SumPrice`

object. Sum of prices including taxes and promotions.- "net":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "gross":objectA
`Price`

object. A price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "taxes":array
`Tax`

objects. Taxes related to the prices.`Note that each type of tax is allowed once only.`

When returned taxes are sorted by the type in ascending order.`Tax`

: A tax including type and amount and optionally a rate and location. `Note that rate must be given if tax type is unknown yet for order time.`

{- "type":stringRequired | The type of tax | Min Length:
`0`

| Max Length:`512`

| Example:`SolidarityTax`

- "amount":numberRequired | Amount of the tax | Example:
`1.7`

- "rate":number

`Required`

if the tax type is unknown yet for order time.

Max precision is 5 decimals. | Example:`5.3`

- "location":string

Recommended to use ISO-3166 alpha-3 in case of countries.

Will be set to the country of the shop if not provided. | Min Length:`0`

| Max Length:`512`

| Example:`DEU`

- "promotions":array
`Promotion`

objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.`Promotion`

: A promotion.

{- "promotionValueType":string
`PERCENTAGE`

- The promotion value is a percentage.`FIXED`

- The promotion value is a fixed amount. | Example:`FIXED`

| Possible Values:`PERCENTAGE`

`FIXED`

- "promotionValue":numberRequired | The value of the promotion, which can be a percentage or a fixed amount | Example:
`10`

- "id":string
`0`

| Max Length:`512`

| Example:`Promo-2020-12-123`

- "name":string
`0`

| Max Length:`1024`

| Example:`Silvester 2020 - extra`

- "descriptorId":stringRequired | Descriptor of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER`

- "code":stringCode of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`SILVESTER2020`

- "budgetSourceId":stringBudget source of the promotion | Min Length:
`0`

| Max Length:`1024`

| Example:`Marketing 2020-12`

- "netValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`10`

- "grossValue":number
`Note that grossValue must be greater than or equal to netValue.`

| Example:`12`

- "unitPrice":object
`UnitPrice`

object. Price per product unit.- "net":objectA
`ListPrice`

object. A list price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "listPrice":numberThe list price/ recommended retail price

- "gross":objectA
`ListPrice`

object. A list price- "amount":numberRequired | The amount of the price | Example:
`100`

- "amountDiscounted":numberThe discounted price.
`If given it must not be greater than the amount`

. | Example:`90`

- "listPrice":numberThe list price/ recommended retail price

- "commissioned":objectA
`OrderPositionSupplier`

object. Supplier specific information{- "name":stringRequired | Name of the supplier as used by the shop | Example:
`Supplier X`

- "commissionDate":stringTimestamp indicating when the order position was commissioned to the supplier | Format:
`date-time`

| Example:`2019-05-28T12:36:17.158Z`

- "confirmed":objectA
`OrderPositionConfirmed`

object. Confirmed products of the order position{- "type":stringRequired | Type of confirmation of the supplier
- "confirmationDate":stringRequired | Date of confirmation of the supplier | Format:
`date-time`

- "quantities":arrayAn array of
`OrderPositionConfirmedQuantity`

objects. Confirmed quantities[]`OrderPositionConfirmedQuantity`

: Confirmed quantity for a planned delivery date

{- "value":integerRequired | The quantity to be delivered at the planned delivery date | Format:
`int32`

| Example:`1`

- "plannedDeliveryDate":stringThe planned delivery date | Format:
`date`

- "cancelled":arrayAn array of
`OrderPositionConfirmedCancelled`

objects. At least one product is not available (already cancelled or recalled)[]`OrderPositionConfirmedCancelled`

: Confirmed cancelled products

{- "quantity":integerRequired | Cancelled quantity | Format:
`int32`

| Example:`1`

- "cancelDate":stringDate of cancellation or recall | Format:
`date-time`

- "reason":objectA
`OrderPositionConfirmedCancelledReason`

object. Cancellation reason{- "id":stringRequired | Code of reason of the cancellation or recall | Example:
`RCL021`

- "value":stringReason of cancellation or recall (free text) | Example:
`Cancellation due to missing stock`

- "dispatched":arrayAn array of
`OrderPositionDispatched`

objects. Information about dispatched products[]`OrderPositionDispatched`

: Dispatched positions

{- "quantity":integerRequired | Dispatched quantity | Format:
`int32`

| Example:`1`

- "deliveryNoteNumber":stringDelivery note number | Example:
`980392-481`

- "dispatchDate":stringRequired | Timestamp of the handover of the package to the carrier | Format:
`date-time`

- "carrier":objectA
`OrderStateOrderPositionDispatchedCarrier`

object. Carrier of the shipment{- "name":stringRequired | Name of the carrier | Example:
`DHL`

- "packages":integerRequired | Number of packages | Format:
`int32`

| Example:`1`

- "shipmentTracking":objectA
`OrderPositionDispatchedCarrierTracking`

object. Tracking information of the shipment{- "number":stringRequired | Tracking number of the package | Example:
`929-912-03013`

- "url":stringTracking URL | Format:
`uri`

- "units":arrayAn array of
`OrderPositionDispatchedUnit`

objects. Further information for a single product/ item[]`OrderPositionDispatchedUnit`

: Further information for a single product/ item

{- "serialNumber":stringRequired | Serial number of the product | Example:
`89712007`

- "returned":arrayAn array of
`OrderPositionReturned`

objects. Information about returned products[Either]`OrderPositionReturnedQuantities`

: Quantity based return informationen of an order position

{- "status":stringRequired | Status of the return | Example:
`CLOSED`

- "supplierEntryDate":stringTimestamp of the entry of the return at the supplier | Format:
`date-time`

- "quantity":integerRequired | Number of returned products of the position | Format:
`int32`

| Example:`2`

- "returnReason":objectA
`OrderPositionReturnedReason`

object. Details about the return reason{- "value":stringRequired | The return reason | Example:
`RET990`

- "type":stringRequired | The return type of the return reason | Example:
`RET`

- "payment":objectA
`OrderPositionReturnedReturnPayment`

object. Return payment{- "reduction":objectRequired | A
`OrderPositionReturnedReturnPaymentReduction`

object. Reason for price reduction{- "reduceText":stringRequired | Reduction reason of the supplier | Example:
`The original packaging was badly damaged by the customer.`

- "reduceReason":stringRequired | Name of reduction as used by the shop | Example:
`AK-0`

- "refundNet":numberRequired | Net amount of the refund | Example:
`12.87`

Or`OrderPositionReturnedUnits`

: Unit/ item based return informationen of an order position

{- "status":stringRequired | Status of the return | Example:
`CLOSED`

- "supplierEntryDate":stringTimestamp of the entry of the return at the supplier | Format:
`date-time`

- "units":arrayRequired | An array of
`OrderPositionReturnedUnitsUnit`

objects. Information about return of individual products[]`OrderPositionReturnedUnitsUnit`

: Return information for a single product/ unit/ item

{- "serialNumber":stringRequired | The serial number of the product/ item | Example:
`9834JJ-43`

- "returnReason":objectA
`OrderPositionReturnedReason`

object. Details about the return reason{- "value":stringRequired | The return reason | Example:
`RET990`

- "type":stringRequired | The return type of the return reason | Example:
`RET`

- "payment":objectA
`OrderPositionReturnedReturnPayment`

object. Return payment{- "reduction":objectRequired | A
`OrderPositionReturnedReturnPaymentReduction`

object. Reason for price reduction{- "reduceText":stringRequired | Reduction reason of the supplier | Example:
`The original packaging was badly damaged by the customer.`

- "reduceReason":stringRequired | Name of reduction as used by the shop | Example:
`AK-0`

- "refundNet":numberRequired | Net amount of the refund | Example:
`12.87`

- "status":stringRequired | The status of the order | Example:
`STATE_DISPATCHED`

- "notes":arrayAn array of
`OrderNote`

objects. Notes regarding the order[]`OrderNote`

: A note regarding the order

{- "message":stringRequired | The content of the note | Example:
`The customer has a complaint about the delivery.`

- "type":stringThe type of the note | Example:
`COMPLAINT`

- "creationDate":stringThe creation date of the note | Format:
`date-time`

| Example:`2020-12-28T07:22:44.838Z`

- "paymentState":objectA
`PaymentState`

object. The payment state of the order including payment history{- "invoicingDebitAmount":numberRequired | Amount of all invoices for this order | Example:
`1000`

- "invoicingCreditAmount":numberRequired | Amount of all credit notes for this order | Example:
`5`

- "chargedDebitAmount":numberRequired | Amount of all captured amounts for this order | Example:
`45`

- "chargedCreditAmount":numberRequired | Amount of all refunded amounts for this order | Example:
`5`

- "chargedOpenAmount":numberRequired | Positive amount (amount of open refunds) - Negative amount (amount of open captures) | Example:
`0`

- "bookedDebitAmount":numberRequired | Amount of all inbound payments for this order | Example:
`0`

- "bookedCreditAmount":numberRequired | Amount of all outbound payments for this order | Example:
`45`

- "bookedOpenAmount":numberRequired | Positive amount (amount of open outbound payments) - Negative amount (amount of open inbound payments) | Example:
`0`

- "creationDate":stringRequired | Creation date of the payment status | Format:
`date-time`

| Example:`2020-12-28T17:46:49.838Z`

- "lastCaptureDate":stringDate of the last payment capture | Format:
`date-time`

| Example:`2020-12-10T20:16:23.838Z`

- "lastRefundDate":stringDate of the last refund | Format:
`date-time`

| Example:`2020-12-28T17:46:49.838Z`

- "lastCalculationDate":stringRequired | Date of last calculation of the payment status | Format:
`date-time`

| Example:`2020-11-28T17:46:49.838Z`

- "currencyCode":stringRequired | Currency code of the balance amounts (ISO 4217) | Example:
`EUR`

- "paymentHistory":arrayAn array of
`PaymentStateHistoryItem`

objects. Payment history of the order[]`PaymentStateHistoryItem`

: Payment history entry of an order

{- "amount":numberRequired | Amount of the payment | Example:
`109.78`

- "currencyCode":stringRequired | Currency code of the payment (ISO 4217) | Example:
`EUR`

- "type":stringRequired | The type of the payment notification. Possible values are
`INBOUND`

,`OUTBOUND`

,`ACTION`

. | Example:`INBOUND`

- "action":stringRequired | The payment action. Possible values are
`AUTHORIZATION`

,`REVERSE`

,`CAPTURE`

,`REFUND`

. | Example:`CAPTURE`

- "paymentMethod":stringRequired | The payment method of the payment | Example:
`CREDITCARD`

- "creationDate":stringRequired | Creation date of the payment notification | Format:
`date-time`

| Example:`2020-12-28T17:46:49.838Z`

- "modificationDate":stringRequired | Modification date of the payment notification | Format:
`date-time`

| Example:`2020-12-28T17:46:49.838Z`

- "comment":stringComment of the item
- "invoiceNumber":stringInvoice number, if the payment relates to an invoice

- "documents":arrayAn array of
`OrderDocument`

objects. Order-related documents given as links, e.g. invoices[]`OrderDocument`

: An order-related document given as link

{- "type":stringRequired | The type of the document | Example:
`invoiceNote`

- "downloadLink":stringRequired | The URI to get the document | Format:
`uri`

| Example:`https://localhost:8080/servlets/DocumentServlet/v1.0/invoiceNote/InvoiceNote.pdf?k=10218224f70ffdbdfd5d18603ce53424788fe859425056b7e9e058bd94c2410e2e05c43f847fa2dc9cb1fabbc5ae1a899e1f5ec9c93422aa529ecfda79171ed92626c&i=10218&s=200"`

- "creationDate":stringThe creation date of the document (ISO-8601) | Format:
`date-time`

| Example:`2018-12-24T14:22:32.123Z`

- "mimeType":stringThe MIME-type of the document | Example:
`application/pdf`

- "meta":objectA
`CollectionMetaData`

object. The meta data of the collection{- "totalCount":integerThe total number of objects in the collection (without offset and limit) | Format:
`int64`

| Example:`10000`

- "links":objectLink section

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.