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:
/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.
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 | shopOrderCreationDate[gte] | string date | 2019-01-31 | The earliest date the shop created an order | |
in query | shopOrderCreationDate[lte] | string date | 2019-10-31 | 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
Order
object. An orderIf change request, it must be equal to the origin order.
| Min Length: 1
| Max Length: 50
| Example: 2019-089013
date-time
| Example: 2019-09-14T16:22:32.123+02:00
Required if order change request, otherwise ignored.
| Format: date-time
| Example: 2019-09-14T16:22:32.123+02:00
int64
| Example: 907041
0
| Max Length: 100
| Example: 2510-19
0
| Max Length: 100
| Example: PR-911 CR7
CustomerData
object. Details of the customer of the order.PERSON
- The customer is a person.COMPANY
- The customer is a company. companyData
is required. | Example: COMPANY
| Possible Values: PERSON
COMPANY
0
| Max Length: 50
| Example: BST-8911.2
0
| Max Length: 255
| Example: CUST-7028A
CompanyData
object. Detailed company data.1
| Max Length: 100
| Example: Intershop Communications AG
0
| Max Length: 50
| Example: Engineering
0
| Max Length: 50
| Example: E-Commerce
0
| Max Length: 50
| Example: CC-1207
0
| Max Length: 50
| Example: HRB 209419
0
| Max Length: 50
| Example: Amtsgericht Jena
0
| Max Length: 50
| Example: Joint-stock company
0
| Max Length: 25
AddressInvoice
object. Details about the invoice addressAddressLocation
object. The location of the address. For type set one of AddressLocationStreet
, AddressLocationPOBox
or AddressLocationPackstation
. The latter is not allowed for invoicing addresses.1
| Max Length: 100
| Example: Jena
1
| Max Length: 25
| Example: 07740
0
| Max Length: 100
DEU
string
literals. Additions to the address. Note that at max 2 additions are allowed for packstation addresses.
Contact
object. Contact informationemail
| Min Length: 1
| Max Length: 100
| Example: peter.sampleman@intershop.de
0
| Max Length: 25
| Example: +49 (3641) 123456
0
| Max Length: 25
| Example: +49 (165) 5673123
0
| Max Length: 25
| Example: +49 (3641) 50-1344
AddressReceiver
object. The receiver of the address, which can be a person or a company. At least one of it must be given.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
object. Name of a person0
| Max Length: 25
| Example: Mr.
0
| Max Length: 25
| Example: C.P.A.
0
| Max Length: 50
| Example: John
1
| Max Length: 50
| Example: Doe
0
| Max Length: 100
| Example: Intershop Communications AG
Sales
object. Sales prices of the orderEUR
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.
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
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.
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
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.`int64
| Example: 10
DELIVERYCHARGE
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
Payment
object. Payment information at order creationPAYPAL
0
| Max Length: 50
| Example: PSP-ORD-0000123
0
| Max Length: 50
| Example: PSP-RN-0000123
0
| Max Length: 100
| Example: BANKX-PSP-ABC
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 order1
AddressShipping
object. Details about the shipping addressAddressLocation
object. The location of the address. For type set one of AddressLocationStreet
, AddressLocationPOBox
or AddressLocationPackstation
. The latter is not allowed for invoicing addresses.1
| Max Length: 100
| Example: Jena
1
| Max Length: 25
| Example: 07740
0
| Max Length: 100
DEU
string
literals. Additions to the address. Note that at max 2 additions are allowed for packstation addresses.
Contact
object. Contact informationemail
| Min Length: 1
| Max Length: 100
| Example: peter.sampleman@intershop.de
0
| Max Length: 25
| Example: +49 (3641) 123456
0
| Max Length: 25
| Example: +49 (165) 5673123
0
| Max Length: 25
| Example: +49 (3641) 50-1344
AddressReceiver
object. The receiver of the address, which can be a person or a company. At least one of it must be given.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
object. Name of a person0
| Max Length: 25
| Example: Mr.
0
| Max Length: 25
| Example: C.P.A.
0
| Max Length: 50
| Example: John
1
| Max Length: 50
| Example: Doe
0
| Max Length: 100
| Example: Intershop Communications AG
DHL
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.`int64
| Example: 10
DELIVERYCHARGE
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
OrderPosition
objects. Positions of the shipping bucket. When returned positions are sorted by number in ascending order.OrderPosition
: An order position of the shipping bucketint32
| Example: 3
liter
Product
object. A productA Philosophy of Software Design
BLK-MED-G123-GUC
978-1732102200
int64
| Example: 47119910
0
| Max Length: 100
| Example: 2510-19
0
| Max Length: 100
| Example: PR-911 CR7
int32
| Example: 5
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.
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
UnitPrice
object. Price per product unit. Note that at least net or gross price must be given. If both given, gross must be greater than or equal to net.
ListPrice
object. A list price100
If given it must not be greater than the amount
. | Example: 90
ListPrice
object. A list price100
If given it must not be greater than the amount
. | Example: 90
Shipping
object. Shipping informationstring
literals. The selected delivery options | Example: DELIVERY_ON_ISLAND
DeliveryDate
object. The type of expected delivery, which can be standard, express, earliest or a desired 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
Go-Express
date-time
int32
| Example: 3
preferred
supplier for the delivery of the position. Note that the delivering supplier can be another one.
| Example: Warehouse Hamburg
0
| Max Length: 255
| Example: 2510-19
ChangeRequestView
: Describes a change request to viewOrder
object. An orderIf change request, it must be equal to the origin order.
| Min Length: 1
| Max Length: 50
| Example: 2019-089013
date-time
| Example: 2019-09-14T16:22:32.123+02:00
Required if order change request, otherwise ignored.
| Format: date-time
| Example: 2019-09-14T16:22:32.123+02:00
int64
| Example: 907041
0
| Max Length: 100
| Example: 2510-19
0
| Max Length: 100
| Example: PR-911 CR7
CustomerData
object. Details of the customer of the order.PERSON
- The customer is a person.COMPANY
- The customer is a company. companyData
is required. | Example: COMPANY
| Possible Values: PERSON
COMPANY
0
| Max Length: 50
| Example: BST-8911.2
0
| Max Length: 255
| Example: CUST-7028A
CompanyData
object. Detailed company data.1
| Max Length: 100
| Example: Intershop Communications AG
0
| Max Length: 50
| Example: Engineering
0
| Max Length: 50
| Example: E-Commerce
0
| Max Length: 50
| Example: CC-1207
0
| Max Length: 50
| Example: HRB 209419
0
| Max Length: 50
| Example: Amtsgericht Jena
0
| Max Length: 50
| Example: Joint-stock company
0
| Max Length: 25
AddressInvoice
object. Details about the invoice addressAddressLocation
object. The location of the address. For type set one of AddressLocationStreet
, AddressLocationPOBox
or AddressLocationPackstation
. The latter is not allowed for invoicing addresses.1
| Max Length: 100
| Example: Jena
1
| Max Length: 25
| Example: 07740
0
| Max Length: 100
DEU
string
literals. Additions to the address. Note that at max 2 additions are allowed for packstation addresses.
Contact
object. Contact informationemail
| Min Length: 1
| Max Length: 100
| Example: peter.sampleman@intershop.de
0
| Max Length: 25
| Example: +49 (3641) 123456
0
| Max Length: 25
| Example: +49 (165) 5673123
0
| Max Length: 25
| Example: +49 (3641) 50-1344
AddressReceiver
object. The receiver of the address, which can be a person or a company. At least one of it must be given.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
object. Name of a person0
| Max Length: 25
| Example: Mr.
0
| Max Length: 25
| Example: C.P.A.
0
| Max Length: 50
| Example: John
1
| Max Length: 50
| Example: Doe
0
| Max Length: 100
| Example: Intershop Communications AG
Sales
object. Sales prices of the orderEUR
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.
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
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.
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
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.`int64
| Example: 10
DELIVERYCHARGE
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
Payment
object. Payment information at order creationPAYPAL
0
| Max Length: 50
| Example: PSP-ORD-0000123
0
| Max Length: 50
| Example: PSP-RN-0000123
0
| Max Length: 100
| Example: BANKX-PSP-ABC
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 order1
AddressShipping
object. Details about the shipping addressAddressLocation
object. The location of the address. For type set one of AddressLocationStreet
, AddressLocationPOBox
or AddressLocationPackstation
. The latter is not allowed for invoicing addresses.1
| Max Length: 100
| Example: Jena
1
| Max Length: 25
| Example: 07740
0
| Max Length: 100
DEU
string
literals. Additions to the address. Note that at max 2 additions are allowed for packstation addresses.
Contact
object. Contact informationemail
| Min Length: 1
| Max Length: 100
| Example: peter.sampleman@intershop.de
0
| Max Length: 25
| Example: +49 (3641) 123456
0
| Max Length: 25
| Example: +49 (165) 5673123
0
| Max Length: 25
| Example: +49 (3641) 50-1344
AddressReceiver
object. The receiver of the address, which can be a person or a company. At least one of it must be given.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
object. Name of a person0
| Max Length: 25
| Example: Mr.
0
| Max Length: 25
| Example: C.P.A.
0
| Max Length: 50
| Example: John
1
| Max Length: 50
| Example: Doe
0
| Max Length: 100
| Example: Intershop Communications AG
DHL
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.`int64
| Example: 10
DELIVERYCHARGE
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
OrderPosition
objects. Positions of the shipping bucket. When returned positions are sorted by number in ascending order.OrderPosition
: An order position of the shipping bucketint32
| Example: 3
liter
Product
object. A productA Philosophy of Software Design
BLK-MED-G123-GUC
978-1732102200
int64
| Example: 47119910
0
| Max Length: 100
| Example: 2510-19
0
| Max Length: 100
| Example: PR-911 CR7
int32
| Example: 5
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.
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
UnitPrice
object. Price per product unit. Note that at least net or gross price must be given. If both given, gross must be greater than or equal to net.
ListPrice
object. A list price100
If given it must not be greater than the amount
. | Example: 90
ListPrice
object. A list price100
If given it must not be greater than the amount
. | Example: 90
Shipping
object. Shipping informationstring
literals. The selected delivery options | Example: DELIVERY_ON_ISLAND
DeliveryDate
object. The type of expected delivery, which can be standard, express, earliest or a desired 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
Go-Express
date-time
int32
| Example: 3
preferred
supplier for the delivery of the position. Note that the delivering supplier can be another one.
| Example: Warehouse Hamburg
0
| Max Length: 255
| Example: 2510-19
date-time
date-time
ACCEPTED
| Possible Values: OPEN
ACCEPTED
APPLIED
FAILED_TO_APPLY
int32
| Example: 400
Error
objects.Error
VALIDATION_EXCEPTION
Attribute XYZ is mandatory
If change request, it must be equal to the origin order.
| Min Length: 1
| Max Length: 50
| Example: 2019-089013
date-time
| Example: 2019-09-14T16:22:32.123+02:00
Required if order change request, otherwise ignored.
| Format: date-time
| Example: 2019-09-14T16:22:32.123+02:00
int64
| Example: 907041
0
| Max Length: 100
| Example: 2510-19
0
| Max Length: 100
| Example: PR-911 CR7
CustomerData
object. Details of the customer of the order.PERSON
- The customer is a person.COMPANY
- The customer is a company. companyData
is required. | Example: COMPANY
| Possible Values: PERSON
COMPANY
0
| Max Length: 50
| Example: BST-8911.2
0
| Max Length: 255
| Example: CUST-7028A
CompanyData
object. Detailed company data.1
| Max Length: 100
| Example: Intershop Communications AG
0
| Max Length: 50
| Example: Engineering
0
| Max Length: 50
| Example: E-Commerce
0
| Max Length: 50
| Example: CC-1207
0
| Max Length: 50
| Example: HRB 209419
0
| Max Length: 50
| Example: Amtsgericht Jena
0
| Max Length: 50
| Example: Joint-stock company
0
| Max Length: 25
AddressInvoice
object. Details about the invoice addressAddressLocation
object. The location of the address. For type set one of AddressLocationStreet
, AddressLocationPOBox
or AddressLocationPackstation
. The latter is not allowed for invoicing addresses.1
| Max Length: 100
| Example: Jena
1
| Max Length: 25
| Example: 07740
0
| Max Length: 100
DEU
string
literals. Additions to the address. Note that at max 2 additions are allowed for packstation addresses.
Contact
object. Contact informationemail
| Min Length: 1
| Max Length: 100
| Example: peter.sampleman@intershop.de
0
| Max Length: 25
| Example: +49 (3641) 123456
0
| Max Length: 25
| Example: +49 (165) 5673123
0
| Max Length: 25
| Example: +49 (3641) 50-1344
AddressReceiver
object. The receiver of the address, which can be a person or a company. At least one of it must be given.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
object. Name of a person0
| Max Length: 25
| Example: Mr.
0
| Max Length: 25
| Example: C.P.A.
0
| Max Length: 50
| Example: John
1
| Max Length: 50
| Example: Doe
0
| Max Length: 100
| Example: Intershop Communications AG
Sales
object. Sales prices of the orderEUR
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.
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
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.
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
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.`int64
| Example: 10
DELIVERYCHARGE
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
Payment
object. Payment information at order creationPAYPAL
0
| Max Length: 50
| Example: PSP-ORD-0000123
0
| Max Length: 50
| Example: PSP-RN-0000123
0
| Max Length: 100
| Example: BANKX-PSP-ABC
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 order1
AddressShipping
object. Details about the shipping addressAddressLocation
object. The location of the address. For type set one of AddressLocationStreet
, AddressLocationPOBox
or AddressLocationPackstation
. The latter is not allowed for invoicing addresses.1
| Max Length: 100
| Example: Jena
1
| Max Length: 25
| Example: 07740
0
| Max Length: 100
DEU
string
literals. Additions to the address. Note that at max 2 additions are allowed for packstation addresses.
Contact
object. Contact informationemail
| Min Length: 1
| Max Length: 100
| Example: peter.sampleman@intershop.de
0
| Max Length: 25
| Example: +49 (3641) 123456
0
| Max Length: 25
| Example: +49 (165) 5673123
0
| Max Length: 25
| Example: +49 (3641) 50-1344
AddressReceiver
object. The receiver of the address, which can be a person or a company. At least one of it must be given.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
object. Name of a person0
| Max Length: 25
| Example: Mr.
0
| Max Length: 25
| Example: C.P.A.
0
| Max Length: 50
| Example: John
1
| Max Length: 50
| Example: Doe
0
| Max Length: 100
| Example: Intershop Communications AG
DHL
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.`int64
| Example: 10
DELIVERYCHARGE
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
OrderPosition
objects. Positions of the shipping bucket. When returned positions are sorted by number in ascending order.OrderPosition
: An order position of the shipping bucketint32
| Example: 3
liter
Product
object. A productA Philosophy of Software Design
BLK-MED-G123-GUC
978-1732102200
int64
| Example: 47119910
0
| Max Length: 100
| Example: 2510-19
0
| Max Length: 100
| Example: PR-911 CR7
int32
| Example: 5
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.
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
UnitPrice
object. Price per product unit. Note that at least net or gross price must be given. If both given, gross must be greater than or equal to net.
ListPrice
object. A list price100
If given it must not be greater than the amount
. | Example: 90
ListPrice
object. A list price100
If given it must not be greater than the amount
. | Example: 90
Shipping
object. Shipping informationstring
literals. The selected delivery options | Example: DELIVERY_ON_ISLAND
DeliveryDate
object. The type of expected delivery, which can be standard, express, earliest or a desired 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
Go-Express
date-time
int32
| Example: 3
preferred
supplier for the delivery of the position. Note that the delivering supplier can be another one.
| Example: Warehouse Hamburg
OrderState
objects. The returned list of order statesOrderState
: Information about the state of the orderIf change request, it must be equal to the origin order.
| Min Length: 1
| Max Length: 50
| Example: 2019-089013
date-time
| Example: 2019-09-14T16:22:32.123+02:00
Required if order change request, otherwise ignored.
| Format: date-time
| Example: 2019-09-14T16:22:32.123+02:00
int64
| Example: 907041
0
| Max Length: 100
| Example: 2510-19
0
| Max Length: 100
| Example: PR-911 CR7
CustomerData
object. Details of the customer of the order.PERSON
- The customer is a person.COMPANY
- The customer is a company. companyData
is required. | Example: COMPANY
| Possible Values: PERSON
COMPANY
0
| Max Length: 50
| Example: BST-8911.2
0
| Max Length: 255
| Example: CUST-7028A
CompanyData
object. Detailed company data.1
| Max Length: 100
| Example: Intershop Communications AG
0
| Max Length: 50
| Example: Engineering
0
| Max Length: 50
| Example: E-Commerce
0
| Max Length: 50
| Example: CC-1207
0
| Max Length: 50
| Example: HRB 209419
0
| Max Length: 50
| Example: Amtsgericht Jena
0
| Max Length: 50
| Example: Joint-stock company
0
| Max Length: 25
AddressInvoice
object. Details about the invoice addressAddressLocation
object. The location of the address. For type set one of AddressLocationStreet
, AddressLocationPOBox
or AddressLocationPackstation
. The latter is not allowed for invoicing addresses.1
| Max Length: 100
| Example: Jena
1
| Max Length: 25
| Example: 07740
0
| Max Length: 100
DEU
string
literals. Additions to the address. Note that at max 2 additions are allowed for packstation addresses.
Contact
object. Contact informationemail
| Min Length: 1
| Max Length: 100
| Example: peter.sampleman@intershop.de
0
| Max Length: 25
| Example: +49 (3641) 123456
0
| Max Length: 25
| Example: +49 (165) 5673123
0
| Max Length: 25
| Example: +49 (3641) 50-1344
AddressReceiver
object. The receiver of the address, which can be a person or a company. At least one of it must be given.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
object. Name of a person0
| Max Length: 25
| Example: Mr.
0
| Max Length: 25
| Example: C.P.A.
0
| Max Length: 50
| Example: John
1
| Max Length: 50
| Example: Doe
0
| Max Length: 100
| Example: Intershop Communications AG
Sales
object. Sales prices of the orderEUR
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.
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
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.
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
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.`int64
| Example: 10
DELIVERYCHARGE
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
Payment
object. Payment information at order creationPAYPAL
0
| Max Length: 50
| Example: PSP-ORD-0000123
0
| Max Length: 50
| Example: PSP-RN-0000123
0
| Max Length: 100
| Example: BANKX-PSP-ABC
ShippingBucketOrderState
objects. The shipping buckets of the orderShippingBucketOrderState
: A shipping bucket of an order state1
AddressShipping
object. Details about the shipping addressAddressLocation
object. The location of the address. For type set one of AddressLocationStreet
, AddressLocationPOBox
or AddressLocationPackstation
. The latter is not allowed for invoicing addresses.1
| Max Length: 100
| Example: Jena
1
| Max Length: 25
| Example: 07740
0
| Max Length: 100
DEU
string
literals. Additions to the address. Note that at max 2 additions are allowed for packstation addresses.
Contact
object. Contact informationemail
| Min Length: 1
| Max Length: 100
| Example: peter.sampleman@intershop.de
0
| Max Length: 25
| Example: +49 (3641) 123456
0
| Max Length: 25
| Example: +49 (165) 5673123
0
| Max Length: 25
| Example: +49 (3641) 50-1344
AddressReceiver
object. The receiver of the address, which can be a person or a company. At least one of it must be given.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
object. Name of a person0
| Max Length: 25
| Example: Mr.
0
| Max Length: 25
| Example: C.P.A.
0
| Max Length: 50
| Example: John
1
| Max Length: 50
| Example: Doe
0
| Max Length: 100
| Example: Intershop Communications AG
DHL
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.`int64
| Example: 10
DELIVERYCHARGE
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions for the charge. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
OrderStatePosition
objects. Positions of the shipping bucketOrderStatePosition
: A position of the order state shipping bucketint32
| Example: 3
liter
Product
object. A productA Philosophy of Software Design
BLK-MED-G123-GUC
978-1732102200
int64
| Example: 47119910
0
| Max Length: 100
| Example: 2510-19
0
| Max Length: 100
| Example: PR-911 CR7
STATE_DO_APPROVE
OrderPositionOrdered
object. Details of an ordered positionOrderStateShipping
object. Shipping informationstring
literals. The selected delivery options | Example: DELIVERY_ON_ISLAND
DeliveryDate
object. The type of expected delivery, which can be standard, express, earliest or a desired 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
Go-Express
date-time
int32
| Example: 3
int32
| Example: 3
date-time
Warehouse Hamburg
int32
| Example: 1
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.
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
Price
object. A price100
If given it must not be greater than the amount
. | Example: 90
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.` 0
| Max Length: 512
| Example: SolidarityTax
1.7
Required
if the tax type is unknown yet for order time.5.3
0
| Max Length: 512
| Example: DEU
Promotion
objects. Promotions related to the prices. When returned promotions are sorted by id in ascending order.Promotion
: A promotion.PERCENTAGE
- The promotion value is a percentage. FIXED
- The promotion value is a fixed amount. | Example: FIXED
| Possible Values: PERCENTAGE
FIXED
10
0
| Max Length: 512
| Example: Promo-2020-12-123
0
| Max Length: 1024
| Example: Silvester 2020 - extra
0
| Max Length: 1024
| Example: SILVESTER
0
| Max Length: 1024
| Example: SILVESTER2020
0
| Max Length: 1024
| Example: Marketing 2020-12
Note that grossValue must be greater than or equal to netValue.
| Example: 10
Note that grossValue must be greater than or equal to netValue.
| Example: 12
UnitPrice
object. Price per product unit. Note that at least net or gross price must be given. If both given, gross must be greater than or equal to net.
ListPrice
object. A list price100
If given it must not be greater than the amount
. | Example: 90
ListPrice
object. A list price100
If given it must not be greater than the amount
. | Example: 90
OrderPositionSupplier
object. Supplier specific informationSupplier X
date-time
| Example: 2019-05-28T14:36:17.158+02:00
OrderPositionConfirmed
object. Confirmed products of the order positiondate-time
OrderPositionConfirmedQuantity
objects. Confirmed quantitiesOrderPositionConfirmedQuantity
: Confirmed quantity for a planned delivery dateint32
| Example: 1
date
OrderPositionConfirmedCancelled
objects. At least one product is not available (already cancelled or recalled)OrderPositionConfirmedCancelled
: Confirmed cancelled productsint32
| Example: 1
date-time
OrderPositionConfirmedCancelledReason
object. Cancellation reasonRCL021
Cancellation due to missing stock
OrderPositionDispatched
objects. Information about dispatched productsOrderPositionDispatched
: Dispatched positionsint32
| Example: 1
980392-481
date-time
OrderStateOrderPositionDispatchedCarrier
object. Carrier of the shipmentDHL
int32
| Example: 1
OrderPositionDispatchedCarrierTracking
object. Tracking information of the shipment929-912-03013
uri
OrderPositionDispatchedUnit
objects. Further information for a single product/ itemOrderPositionDispatchedUnit
: Further information for a single product/ item89712007
OrderPositionReturned
objects. Information about returned productsOrderPositionReturnedQuantities
: Quantity based return informationen of an order positionCLOSED
date-time
int32
| Example: 2
OrderPositionReturnedReason
object. Details about the return reasonRET990
RET
OrderPositionReturnedReturnPayment
object. Return paymentOrderPositionReturnedReturnPaymentReduction
object. Reason for price reductionThe original packaging was badly damaged by the customer.
AK-0
12.87
OrderPositionReturnedUnits
: Unit/ item based return informationen of an order positionCLOSED
date-time
OrderPositionReturnedUnitsUnit
objects. Information about return of individual productsOrderPositionReturnedUnitsUnit
: Return information for a single product/ unit/ item9834JJ-43
OrderPositionReturnedReason
object. Details about the return reasonRET990
RET
OrderPositionReturnedReturnPayment
object. Return paymentOrderPositionReturnedReturnPaymentReduction
object. Reason for price reductionThe original packaging was badly damaged by the customer.
AK-0
12.87
STATE_DISPATCHED
OrderNote
objects. Notes regarding the orderOrderNote
: A note regarding the orderThe customer has a complaint about the delivery.
COMPLAINT
date-time
| Example: 2020-12-28T09:22:44.838+02:00
PaymentState
object. The payment state of the order including payment history1000
5
45
5
0
0
45
0
date-time
| Example: 2020-12-28T19:46:49.838+02:00
date-time
| Example: 2020-12-10T22:16:23.838+02:00
date-time
| Example: 2020-12-28T19:46:49.838+02:00
date-time
| Example: 2020-11-28T19:46:49.838+02:00
EUR
PaymentStateHistoryItem
objects. Payment history of the orderPaymentStateHistoryItem
: Payment history entry of an order109.78
EUR
INBOUND
, OUTBOUND
, ACTION
. | Example: INBOUND
AUTHORIZATION
, REVERSE
, CAPTURE
, REFUND
. | Example: CAPTURE
CREDITCARD
date-time
| Example: 2020-12-28T19:46:49.838+02:00
date-time
| Example: 2020-12-28T19:46:49.838+02:00
OrderDocument
objects. Order-related documents given as links, e.g. invoicesOrderDocument
: An order-related document given as linkinvoiceNote
uri
| Example: https://localhost:8080/servlets/DocumentServlet/v1.0/invoiceNote/InvoiceNote.pdf?k=10218224f70ffdbdfd5d18603ce53424788fe859425056b7e9e058bd94c2410e2e05c43f847fa2dc9cb1fabbc5ae1a899e1f5ec9c93422aa529ecfda79171ed92626c&i=10218&s=200"
date-time
| Example: 2018-12-24T16:22:32.123+02:00
application/pdf
CollectionMetaData
object. The meta data of the collectionint64
| Example: 10000