This API specification is available for download as an Open API 3.0 YAML file:
Authentication
Basic Authentication
Please configure your clients to use this authentication method to submit user name and password.
Bearer Token Authentication
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.
Authorization
The following permissions must be assigned to a shop:
- The permission 'Create order' is required to create an order.
- The permission 'Order status web service' is required view and order report/ order states.
API Specification
/shops/{shopId}/orders
POST: Create an order
Description
This operation creates an order and starts order processing.
Request Body
Order application/vnd.intershop.order.v2+json
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | shopId | integer int64 | | 1000 | Required | The ID of the shop |
Response
201 - Created
Response Header | Description |
---|
Location | The path to the newly created resource | Format: url |
400 - Bad Request
ErrorReport application/json
401 - Unauthorized Authentication information is missing or invalid
403 - Forbidden
415 - Unsupported Media Type
500 - Internal Server Error An unexpected error occured
/shops/{shopId}/order-states
GET: Returns order states by search criteria
Description
This operation returns the order states of orders that match the given search criterias.
Request Body
--
Request Parameters
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 |
in query | limit | integer int32 | 50 | 25 | The number of items to return |
Response
200 - OK
OrderStateCollectionContainer application/vnd.intershop.order.v2+json
400 - Bad Request
ErrorReport application/json
401 - Unauthorized Authentication information is missing or invalid
403 - Forbidden
406 - Not Acceptable
500 - Internal Server Error An unexpected error occured
ErrorReport application/json
{"status":
integer
The HTTP status code applicable to this problem, expressed as a string value | Format: int32
| Example: 400
"errors":
array
An array of Error
objects.
[
Error
{
"code":
string
Required | Exception / Error code | Example: VALIDATION_EXCEPTION
"message":
string
Required | Exception / Error message | Example: Attribute XYZ is mandatory
"value":
object
Value which caused the exception / error
}
]
}Order application/vnd.intershop.order.v2+json
{"shopOrderNumber":
string
Required | Order number as used by the shop (required for order creation) | Min Length: 1
| Max Length: 50
| Example: 2019-089013
"shopOrderCreationDate":
string
Required | Creation date at the shop (ISO-8601) (read only) | Format: date-time
| Example: 2019-09-14T16:22:32.123+02:00
"shopOrderUpdateDate":
string
Time of the (last) processed change-requests (ISO-8601) (read only) | Format: date-time
| Example: 2019-09-14T16:22:32.123+02:00
"reservationId":
integer
ID of the stock reservation that was provided by the IOM reservation service | Format: int64
| Example: 907041
"costCenter":
string
The name/ identifier of the related cost center | Min Length: 0
| Max Length: 100
| Example: 2510-19
"project":
string
The name / identifier of the related project | Min Length: 0
| Max Length: 100
| Example: PR-911 CR7
"customerData":
object
Required | A CustomerData
object. Details of the customer of the order.
{
"customerDataType":
string
Required | Type of the customer.
PERSON
- The customer is a person.
COMPANY
- The customer is a company. company
is required. | Example: COMPANY
| Possible Values: PERSON
COMPANY
"orderNumber":
string
Order number as used by the shop customer | Min Length: 0
| Max Length: 50
| Example: BST-8911.2
"shopCustomerNumber":
string
Customer number as used by the shop | Min Length: 0
| Max Length: 255
| Example: CUST-7028A
"companyData":
object
A CompanyData
object. Detailed company data.
{
"companyName":
string
Required | Name of the company | Min Length: 1
| Max Length: 100
| Example: Intershop Communications AG
"department":
string
Order by department | Min Length: 0
| Max Length: 50
| Example: Engineering
"lineOfBusiness":
string
Line of business | Min Length: 0
| Max Length: 50
| Example: E-Commerce
"costCenterNumber":
string
Cost center number | Min Length: 0
| Max Length: 50
| Example: CC-1207
"commercialRegisterNumber":
string
Commercial register number | Min Length: 0
| Max Length: 50
| Example: HRB 209419
"commercialRegisterLocation":
string
Location of Commercial register | Min Length: 0
| Max Length: 50
| Example: Amtsgericht Jena
"companyType":
string
Corporate type | Min Length: 0
| Max Length: 50
| Example: Joint-stock company
"vatNumber":
string
Min Length: 0
| Max Length: 25
}
}
"invoiceAddress":
object
Required | A AddressInvoice
object. Details about the invoice address
{
"location":
object
Required | 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":
string
Required | Min Length: 1
| Max Length: 100
"postCode":
string
Required | The postcode of the address | Min Length: 1
| Max Length: 25
| Example: 07740
"district":
string
The district of the addres. | Min Length: 0
| Max Length: 100
"countryCode":
string
Required | The country code of the address (ISO-3166 alpha-3) | Example: DEU
"additions":
array
An array of string
literals. Additions to the address. At max 2 additions are allowed for Packstation addresses.
}
"contact":
object
A Contact
object. Contact information
{
"email":
string
Required | An e-mail address. | Format: email
| Example: peter.sampleman@intershop.de
"phone":
string
A phone number | Min Length: 0
| Max Length: 25
| Example: +49 (3641) 123456
"mobile":
string
A mobile phone number | Min Length: 0
| Max Length: 25
| Example: +49 (165) 5673123
"fax":
string
A fax number | Min Length: 0
| Max Length: 25
| Example: +49 (3641) 50-1344
}
"receiver":
object
Required | 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":
string
Required | 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":
object
A Person
object. Name of a person
{
"salutation":
string
Salutation | Min Length: 0
| Max Length: 25
| Example: Mr.
"title":
string
Title | Min Length: 0
| Max Length: 25
| Example: C.P.A.
"firstName":
string
First name | Min Length: 0
| Max Length: 50
| Example: John
"lastName":
string
Required | Last name | Min Length: 1
| Max Length: 50
| Example: Doe
}
"companyName":
string
Name of the company (required if COMPANY) | Example: Intershop Communications AG
}
}
"sales":
object
Required | A Sales
object. Sales prices of the order
{
"currencyCode":
string
Required | The currency of the sales prices (ISO 4217) | Example: EUR
"subTotal":
object
Required | A SumPrice
object. Sum of prices including taxes and promotions. Note that at least net or gross price must be given.
{
"net":
object
A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"gross":
object
A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"taxes":
array
Required | An array of Tax
objects. Taxes related to the prices
[
Tax
:
A tax including type and amount{
"type":
string
Required | The type of tax | Example: NORMAL_TAX
"amount":
number
Required | Amount of the tax | Example: 1.7
}
]
"promotions":
array
An array of Promotion
objects. Promotions related to the prices
[
Promotion
:
A promotion.{
"promotionValueType":
string
Required | 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":
number
Required | The value of the promotion, which can be a percentage or a fixed amount | Example: 10
"id":
string
Required | Identifier of the promotion | Example: Promo-2020-12-123
"name":
string
Required | Name of the promotion | Min Length: 0
| Max Length: 256
| Example: Silvester 2020 - extra
"descriptorId":
string
Required | Descriptor of the promotion | Min Length: 0
| Max Length: 255
| Example: SILVESTER
"code":
string
Code of the promotion | Min Length: 0
| Max Length: 256
| Example: SILVESTER2020
"budgetSourceId":
string
Budget source of the promotion | Min Length: 0
| Max Length: 256
| Example: Marketing 2020-12
"netValue":
number
Required | The net amount given with the promotion | Example: 10
"grossValue":
number
Required | The gross amount given with the promotion | Example: 12
}
]
}
"charges":
array
An array of Charge
objects. Charges on order level
[
Charge
:
A charge.{
"number":
integer
The number of the charge. If set, it has to be unique within the order. | Format: int64
| Example: 10
"type":
string
Required | The type of the charge. | Example: DELIVERYCHARGE
"net":
object
Required | A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"gross":
object
Required | A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"taxes":
array
Required | An array of Tax
objects. Taxes of the charge
[
Tax
:
A tax including type and amount{
"type":
string
Required | The type of tax | Example: NORMAL_TAX
"amount":
number
Required | Amount of the tax | Example: 1.7
}
]
"promotions":
array
An array of Promotion
objects. Promotions for the charge
[
Promotion
:
A promotion.{
"promotionValueType":
string
Required | 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":
number
Required | The value of the promotion, which can be a percentage or a fixed amount | Example: 10
"id":
string
Required | Identifier of the promotion | Example: Promo-2020-12-123
"name":
string
Required | Name of the promotion | Min Length: 0
| Max Length: 256
| Example: Silvester 2020 - extra
"descriptorId":
string
Required | Descriptor of the promotion | Min Length: 0
| Max Length: 255
| Example: SILVESTER
"code":
string
Code of the promotion | Min Length: 0
| Max Length: 256
| Example: SILVESTER2020
"budgetSourceId":
string
Budget source of the promotion | Min Length: 0
| Max Length: 256
| Example: Marketing 2020-12
"netValue":
number
Required | The net amount given with the promotion | Example: 10
"grossValue":
number
Required | The gross amount given with the promotion | Example: 12
}
]
}
]
"total":
object
Required | A TotalPrice
object. Total price including taxes. Note that at least net or gross price must be given.
{
"net":
object
A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"gross":
object
A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"taxes":
array
Required | An array of Tax
objects. Taxes related to the prices.
[
Tax
:
A tax including type and amount{
"type":
string
Required | The type of tax | Example: NORMAL_TAX
"amount":
number
Required | Amount of the tax | Example: 1.7
}
]
}
}
"payment":
object
Required | A Payment
object. Payment information at order creation
{
"paymentMethod":
string
Required | The payment method of the order | Example: PAYPAL
"paymentProviderOrderNo":
string
Order number as used by the payment service provider | Min Length: 0
| Max Length: 50
| Example: PSP-ORD-0000123
"paymentProviderRefNo":
string
Order reference as used by the payment service provider | Min Length: 0
| Max Length: 50
| Example: PSP-RN-0000123
"paymentProviderMerchantAccount":
string
Merchant account used for the payment transaction | Min Length: 0
| Max Length: 100
| Example: BANKX-PSP-ABC
}
"optimizationRule":
string
The rule to optimize the order. If not set, the default rule of the shop will be used.
"splitShipmentAllowed":
boolean
Specifies whether the order is allowed to be splitted for the shipment
"additionalAttributes":
object
Additional attributes of the order that can be grouped by a name
"shippingBuckets":
array
Required | An array of ShippingBucket
objects. The shipping buckets of the order
[
ShippingBucket
:
A shipping bucket of an order{
"number":
string
The number of the shipping bucket (blank values will be ignored). If set, it has to be unique within the order. | Example: 1
"shippingAddress":
object
Required | A AddressShipping
object. Details about the shipping address
{
"location":
object
Required | 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":
string
Required | Min Length: 1
| Max Length: 100
"postCode":
string
Required | The postcode of the address | Min Length: 1
| Max Length: 25
| Example: 07740
"district":
string
The district of the addres. | Min Length: 0
| Max Length: 100
"countryCode":
string
Required | The country code of the address (ISO-3166 alpha-3) | Example: DEU
"additions":
array
An array of string
literals. Additions to the address. At max 2 additions are allowed for Packstation addresses.
}
"contact":
object
A Contact
object. Contact information
{
"email":
string
Required | An e-mail address. | Format: email
| Example: peter.sampleman@intershop.de
"phone":
string
A phone number | Min Length: 0
| Max Length: 25
| Example: +49 (3641) 123456
"mobile":
string
A mobile phone number | Min Length: 0
| Max Length: 25
| Example: +49 (165) 5673123
"fax":
string
A fax number | Min Length: 0
| Max Length: 25
| Example: +49 (3641) 50-1344
}
"receiver":
object
Required | 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":
string
Required | 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":
object
A Person
object. Name of a person
{
"salutation":
string
Salutation | Min Length: 0
| Max Length: 25
| Example: Mr.
"title":
string
Title | Min Length: 0
| Max Length: 25
| Example: C.P.A.
"firstName":
string
First name | Min Length: 0
| Max Length: 50
| Example: John
"lastName":
string
Required | Last name | Min Length: 1
| Max Length: 50
| Example: Doe
}
"companyName":
string
Name of the company (required if COMPANY) | Example: Intershop Communications AG
}
}
"shippingMethod":
string
The desired shipping method | Example: DHL
"charges":
array
An array of Charge
objects. Charges of the shipping bucket, e.g. a shipping charge
[
Charge
:
A charge.{
"number":
integer
The number of the charge. If set, it has to be unique within the order. | Format: int64
| Example: 10
"type":
string
Required | The type of the charge. | Example: DELIVERYCHARGE
"net":
object
Required | A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"gross":
object
Required | A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"taxes":
array
Required | An array of Tax
objects. Taxes of the charge
[
Tax
:
A tax including type and amount{
"type":
string
Required | The type of tax | Example: NORMAL_TAX
"amount":
number
Required | Amount of the tax | Example: 1.7
}
]
"promotions":
array
An array of Promotion
objects. Promotions for the charge
[
Promotion
:
A promotion.{
"promotionValueType":
string
Required | 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":
number
Required | The value of the promotion, which can be a percentage or a fixed amount | Example: 10
"id":
string
Required | Identifier of the promotion | Example: Promo-2020-12-123
"name":
string
Required | Name of the promotion | Min Length: 0
| Max Length: 256
| Example: Silvester 2020 - extra
"descriptorId":
string
Required | Descriptor of the promotion | Min Length: 0
| Max Length: 255
| Example: SILVESTER
"code":
string
Code of the promotion | Min Length: 0
| Max Length: 256
| Example: SILVESTER2020
"budgetSourceId":
string
Budget source of the promotion | Min Length: 0
| Max Length: 256
| Example: Marketing 2020-12
"netValue":
number
Required | The net amount given with the promotion | Example: 10
"grossValue":
number
Required | The gross amount given with the promotion | Example: 12
}
]
}
]
"additionalAttributes":
object
Additional attributes of the shipping bucket that can be grouped by a name
"positions":
array
Required | An array of OrderPosition
objects. Positions of the shipping bucket
[
OrderPosition
:
An order position of the shipping bucket{
"number":
integer
The number of the order position. If set, it has to be unique within the order. | Format: int32
| Example: 3
"productUnit":
string
Unit of the ordered quantity. Note that the unit is only used for invoice printing. | Example: liter
"product":
object
Required | A Product
object. A product
{
"name":
string
Required | The name of the product | Example: A Philosophy of Software Design
"number":
string
Required | The product number or ID, e.g. the stock keeping unit (SKU) | Example: BLK-MED-G123-GUC
"isbn":
string
The International Standard Book Number (ISBN) | Example: 978-1732102200
"ean":
integer
The International Article number (EAN) | Format: int64
| Example: 47119910
}
"costCenter":
string
The name or identifier of the related cost center | Min Length: 0
| Max Length: 100
| Example: 2510-19
"project":
string
The name or identifier of the related project | Min Length: 0
| Max Length: 100
| Example: PR-911 CR7
"additionalAttributes":
object
Additional attributes of the position that can be grouped by a name
"quantity":
integer
Required | The ordered quantity | Format: int32
| Example: 5
"sum":
object
Required | A SumPrice
object. Sum of prices including taxes and promotions. Note that at least net or gross price must be given.
{
"net":
object
A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"gross":
object
A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"taxes":
array
Required | An array of Tax
objects. Taxes related to the prices
[
Tax
:
A tax including type and amount{
"type":
string
Required | The type of tax | Example: NORMAL_TAX
"amount":
number
Required | Amount of the tax | Example: 1.7
}
]
"promotions":
array
An array of Promotion
objects. Promotions related to the prices
[
Promotion
:
A promotion.{
"promotionValueType":
string
Required | 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":
number
Required | The value of the promotion, which can be a percentage or a fixed amount | Example: 10
"id":
string
Required | Identifier of the promotion | Example: Promo-2020-12-123
"name":
string
Required | Name of the promotion | Min Length: 0
| Max Length: 256
| Example: Silvester 2020 - extra
"descriptorId":
string
Required | Descriptor of the promotion | Min Length: 0
| Max Length: 255
| Example: SILVESTER
"code":
string
Code of the promotion | Min Length: 0
| Max Length: 256
| Example: SILVESTER2020
"budgetSourceId":
string
Budget source of the promotion | Min Length: 0
| Max Length: 256
| Example: Marketing 2020-12
"netValue":
number
Required | The net amount given with the promotion | Example: 10
"grossValue":
number
Required | The gross amount given with the promotion | Example: 12
}
]
}
"unitPrice":
object
A UnitPrice
object. Price per product unit. Note that at least net or gross price must be given.
{
"net":
object
A ListPrice
object. A list price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
"listPrice":
number
The list price/ recommended retail price
}
"gross":
object
A ListPrice
object. A list price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
"listPrice":
number
The list price/ recommended retail price
}
}
"shipping":
object
Required | A Shipping
object. Shipping information
{
"freightClass":
string
The shipping freight class
"selectedSupplier":
string
The selected supplier for delivery | Example: Warehouse Berlin
"deliveryOptions":
array
An array of string
literals. The selected delivery options. | Example: DELIVERY_ON_ISLAND
"deliveryDate":
object
Required | A DeliveryDate
object. The type of expected delivery, which can be standard, express, earliest or a desired date.
{
"deliveryDateType":
string
Required | 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":
string
The name of the delivery type for express delivery (required if EXPRESS) | Example: Go-Express
"desiredDeliveryDate":
string
The desired date in relation to the type (required if EARLIEST or FIXED) | Format: date-time
}
"expectedDeliveryDays":
integer
Required | Expected delivery in days | Format: int32
| Example: 3
}
}
]
}
]
}OrderStateCollectionContainer application/vnd.intershop.order.v2+json
{"data":
array
An array of OrderState
objects. The returned list of order states
[
OrderState
:
Information about the state of the order{
"shopOrderNumber":
string
Required | Order number as used by the shop (required for order creation) | Min Length: 1
| Max Length: 50
| Example: 2019-089013
"shopOrderCreationDate":
string
Required | Creation date at the shop (ISO-8601) (read only) | Format: date-time
| Example: 2019-09-14T16:22:32.123+02:00
"shopOrderUpdateDate":
string
Time of the (last) processed change-requests (ISO-8601) (read only) | Format: date-time
| Example: 2019-09-14T16:22:32.123+02:00
"reservationId":
integer
ID of the stock reservation that was provided by the IOM reservation service | Format: int64
| Example: 907041
"costCenter":
string
The name/ identifier of the related cost center | Min Length: 0
| Max Length: 100
| Example: 2510-19
"project":
string
The name / identifier of the related project | Min Length: 0
| Max Length: 100
| Example: PR-911 CR7
"customerData":
object
Required | A CustomerData
object. Details of the customer of the order.
{
"customerDataType":
string
Required | Type of the customer.
PERSON
- The customer is a person.
COMPANY
- The customer is a company. company
is required. | Example: COMPANY
| Possible Values: PERSON
COMPANY
"orderNumber":
string
Order number as used by the shop customer | Min Length: 0
| Max Length: 50
| Example: BST-8911.2
"shopCustomerNumber":
string
Customer number as used by the shop | Min Length: 0
| Max Length: 255
| Example: CUST-7028A
"companyData":
object
A CompanyData
object. Detailed company data.
{
"companyName":
string
Required | Name of the company | Min Length: 1
| Max Length: 100
| Example: Intershop Communications AG
"department":
string
Order by department | Min Length: 0
| Max Length: 50
| Example: Engineering
"lineOfBusiness":
string
Line of business | Min Length: 0
| Max Length: 50
| Example: E-Commerce
"costCenterNumber":
string
Cost center number | Min Length: 0
| Max Length: 50
| Example: CC-1207
"commercialRegisterNumber":
string
Commercial register number | Min Length: 0
| Max Length: 50
| Example: HRB 209419
"commercialRegisterLocation":
string
Location of Commercial register | Min Length: 0
| Max Length: 50
| Example: Amtsgericht Jena
"companyType":
string
Corporate type | Min Length: 0
| Max Length: 50
| Example: Joint-stock company
"vatNumber":
string
Min Length: 0
| Max Length: 25
}
}
"invoiceAddress":
object
Required | A AddressInvoice
object. Details about the invoice address
{
"location":
object
Required | 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":
string
Required | Min Length: 1
| Max Length: 100
"postCode":
string
Required | The postcode of the address | Min Length: 1
| Max Length: 25
| Example: 07740
"district":
string
The district of the addres. | Min Length: 0
| Max Length: 100
"countryCode":
string
Required | The country code of the address (ISO-3166 alpha-3) | Example: DEU
"additions":
array
An array of string
literals. Additions to the address. At max 2 additions are allowed for Packstation addresses.
}
"contact":
object
A Contact
object. Contact information
{
"email":
string
Required | An e-mail address. | Format: email
| Example: peter.sampleman@intershop.de
"phone":
string
A phone number | Min Length: 0
| Max Length: 25
| Example: +49 (3641) 123456
"mobile":
string
A mobile phone number | Min Length: 0
| Max Length: 25
| Example: +49 (165) 5673123
"fax":
string
A fax number | Min Length: 0
| Max Length: 25
| Example: +49 (3641) 50-1344
}
"receiver":
object
Required | 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":
string
Required | 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":
object
A Person
object. Name of a person
{
"salutation":
string
Salutation | Min Length: 0
| Max Length: 25
| Example: Mr.
"title":
string
Title | Min Length: 0
| Max Length: 25
| Example: C.P.A.
"firstName":
string
First name | Min Length: 0
| Max Length: 50
| Example: John
"lastName":
string
Required | Last name | Min Length: 1
| Max Length: 50
| Example: Doe
}
"companyName":
string
Name of the company (required if COMPANY) | Example: Intershop Communications AG
}
}
"sales":
object
Required | A Sales
object. Sales prices of the order
{
"currencyCode":
string
Required | The currency of the sales prices (ISO 4217) | Example: EUR
"subTotal":
object
Required | A SumPrice
object. Sum of prices including taxes and promotions. Note that at least net or gross price must be given.
{
"net":
object
A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"gross":
object
A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"taxes":
array
Required | An array of Tax
objects. Taxes related to the prices
[
Tax
:
A tax including type and amount{
"type":
string
Required | The type of tax | Example: NORMAL_TAX
"amount":
number
Required | Amount of the tax | Example: 1.7
}
]
"promotions":
array
An array of Promotion
objects. Promotions related to the prices
[
Promotion
:
A promotion.{
"promotionValueType":
string
Required | 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":
number
Required | The value of the promotion, which can be a percentage or a fixed amount | Example: 10
"id":
string
Required | Identifier of the promotion | Example: Promo-2020-12-123
"name":
string
Required | Name of the promotion | Min Length: 0
| Max Length: 256
| Example: Silvester 2020 - extra
"descriptorId":
string
Required | Descriptor of the promotion | Min Length: 0
| Max Length: 255
| Example: SILVESTER
"code":
string
Code of the promotion | Min Length: 0
| Max Length: 256
| Example: SILVESTER2020
"budgetSourceId":
string
Budget source of the promotion | Min Length: 0
| Max Length: 256
| Example: Marketing 2020-12
"netValue":
number
Required | The net amount given with the promotion | Example: 10
"grossValue":
number
Required | The gross amount given with the promotion | Example: 12
}
]
}
"charges":
array
An array of Charge
objects. Charges on order level
[
Charge
:
A charge.{
"number":
integer
The number of the charge. If set, it has to be unique within the order. | Format: int64
| Example: 10
"type":
string
Required | The type of the charge. | Example: DELIVERYCHARGE
"net":
object
Required | A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"gross":
object
Required | A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"taxes":
array
Required | An array of Tax
objects. Taxes of the charge
[
Tax
:
A tax including type and amount{
"type":
string
Required | The type of tax | Example: NORMAL_TAX
"amount":
number
Required | Amount of the tax | Example: 1.7
}
]
"promotions":
array
An array of Promotion
objects. Promotions for the charge
[
Promotion
:
A promotion.{
"promotionValueType":
string
Required | 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":
number
Required | The value of the promotion, which can be a percentage or a fixed amount | Example: 10
"id":
string
Required | Identifier of the promotion | Example: Promo-2020-12-123
"name":
string
Required | Name of the promotion | Min Length: 0
| Max Length: 256
| Example: Silvester 2020 - extra
"descriptorId":
string
Required | Descriptor of the promotion | Min Length: 0
| Max Length: 255
| Example: SILVESTER
"code":
string
Code of the promotion | Min Length: 0
| Max Length: 256
| Example: SILVESTER2020
"budgetSourceId":
string
Budget source of the promotion | Min Length: 0
| Max Length: 256
| Example: Marketing 2020-12
"netValue":
number
Required | The net amount given with the promotion | Example: 10
"grossValue":
number
Required | The gross amount given with the promotion | Example: 12
}
]
}
]
"total":
object
Required | A TotalPrice
object. Total price including taxes. Note that at least net or gross price must be given.
{
"net":
object
A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"gross":
object
A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"taxes":
array
Required | An array of Tax
objects. Taxes related to the prices.
[
Tax
:
A tax including type and amount{
"type":
string
Required | The type of tax | Example: NORMAL_TAX
"amount":
number
Required | Amount of the tax | Example: 1.7
}
]
}
}
"payment":
object
Required | A Payment
object. Payment information at order creation
{
"paymentMethod":
string
Required | The payment method of the order | Example: PAYPAL
"paymentProviderOrderNo":
string
Order number as used by the payment service provider | Min Length: 0
| Max Length: 50
| Example: PSP-ORD-0000123
"paymentProviderRefNo":
string
Order reference as used by the payment service provider | Min Length: 0
| Max Length: 50
| Example: PSP-RN-0000123
"paymentProviderMerchantAccount":
string
Merchant account used for the payment transaction | Min Length: 0
| Max Length: 100
| Example: BANKX-PSP-ABC
}
"optimizationRule":
string
The rule to optimize the order. If not set, the default rule of the shop will be used.
"splitShipmentAllowed":
boolean
Specifies whether the order is allowed to be splitted for the shipment
"additionalAttributes":
object
Additional attributes of the order that can be grouped by a name
"shippingBuckets":
array
Required | An array of ShippingBucketOrderState
objects. The shipping buckets of the order
[
ShippingBucketOrderState
:
A shipping bucket of an order state{
"number":
string
The number of the shipping bucket (blank values will be ignored). If set, it has to be unique within the order. | Example: 1
"shippingAddress":
object
Required | A AddressShipping
object. Details about the shipping address
{
"location":
object
Required | 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":
string
Required | Min Length: 1
| Max Length: 100
"postCode":
string
Required | The postcode of the address | Min Length: 1
| Max Length: 25
| Example: 07740
"district":
string
The district of the addres. | Min Length: 0
| Max Length: 100
"countryCode":
string
Required | The country code of the address (ISO-3166 alpha-3) | Example: DEU
"additions":
array
An array of string
literals. Additions to the address. At max 2 additions are allowed for Packstation addresses.
}
"contact":
object
A Contact
object. Contact information
{
"email":
string
Required | An e-mail address. | Format: email
| Example: peter.sampleman@intershop.de
"phone":
string
A phone number | Min Length: 0
| Max Length: 25
| Example: +49 (3641) 123456
"mobile":
string
A mobile phone number | Min Length: 0
| Max Length: 25
| Example: +49 (165) 5673123
"fax":
string
A fax number | Min Length: 0
| Max Length: 25
| Example: +49 (3641) 50-1344
}
"receiver":
object
Required | 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":
string
Required | 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":
object
A Person
object. Name of a person
{
"salutation":
string
Salutation | Min Length: 0
| Max Length: 25
| Example: Mr.
"title":
string
Title | Min Length: 0
| Max Length: 25
| Example: C.P.A.
"firstName":
string
First name | Min Length: 0
| Max Length: 50
| Example: John
"lastName":
string
Required | Last name | Min Length: 1
| Max Length: 50
| Example: Doe
}
"companyName":
string
Name of the company (required if COMPANY) | Example: Intershop Communications AG
}
}
"shippingMethod":
string
The desired shipping method | Example: DHL
"charges":
array
An array of Charge
objects. Charges of the shipping bucket, e.g. a shipping charge
[
Charge
:
A charge.{
"number":
integer
The number of the charge. If set, it has to be unique within the order. | Format: int64
| Example: 10
"type":
string
Required | The type of the charge. | Example: DELIVERYCHARGE
"net":
object
Required | A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"gross":
object
Required | A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"taxes":
array
Required | An array of Tax
objects. Taxes of the charge
[
Tax
:
A tax including type and amount{
"type":
string
Required | The type of tax | Example: NORMAL_TAX
"amount":
number
Required | Amount of the tax | Example: 1.7
}
]
"promotions":
array
An array of Promotion
objects. Promotions for the charge
[
Promotion
:
A promotion.{
"promotionValueType":
string
Required | 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":
number
Required | The value of the promotion, which can be a percentage or a fixed amount | Example: 10
"id":
string
Required | Identifier of the promotion | Example: Promo-2020-12-123
"name":
string
Required | Name of the promotion | Min Length: 0
| Max Length: 256
| Example: Silvester 2020 - extra
"descriptorId":
string
Required | Descriptor of the promotion | Min Length: 0
| Max Length: 255
| Example: SILVESTER
"code":
string
Code of the promotion | Min Length: 0
| Max Length: 256
| Example: SILVESTER2020
"budgetSourceId":
string
Budget source of the promotion | Min Length: 0
| Max Length: 256
| Example: Marketing 2020-12
"netValue":
number
Required | The net amount given with the promotion | Example: 10
"grossValue":
number
Required | The gross amount given with the promotion | Example: 12
}
]
}
]
"additionalAttributes":
object
Additional attributes of the shipping bucket that can be grouped by a name
"positions":
array
Required | An array of OrderStatePosition
objects. Positions of the shipping bucket
[
OrderStatePosition
:
A position of the order state shipping bucket{
"number":
integer
The number of the order position. If set, it has to be unique within the order. | Format: int32
| Example: 3
"productUnit":
string
Unit of the ordered quantity. Note that the unit is only used for invoice printing. | Example: liter
"product":
object
Required | A Product
object. A product
{
"name":
string
Required | The name of the product | Example: A Philosophy of Software Design
"number":
string
Required | The product number or ID, e.g. the stock keeping unit (SKU) | Example: BLK-MED-G123-GUC
"isbn":
string
The International Standard Book Number (ISBN) | Example: 978-1732102200
"ean":
integer
The International Article number (EAN) | Format: int64
| Example: 47119910
}
"costCenter":
string
The name or identifier of the related cost center | Min Length: 0
| Max Length: 100
| Example: 2510-19
"project":
string
The name or identifier of the related project | Min Length: 0
| Max Length: 100
| Example: PR-911 CR7
"additionalAttributes":
object
Additional attributes of the position that can be grouped by a name
"status":
string
Required | The status of the order position | Example: STATE_DO_APPROVE
"ordered":
object
A OrderPositionOrdered
object. Details of an ordered position
{
"shipping":
object
Required | A OrderStateShipping
object. Shipping information
{
"freightClass":
string
The shipping freight class
"selectedSupplier":
string
The selected supplier for delivery | Example: Warehouse Berlin
"deliveryOptions":
array
An array of string
literals. The selected delivery options. | Example: DELIVERY_ON_ISLAND
"deliveryDate":
object
Required | A DeliveryDate
object. The type of expected delivery, which can be standard, express, earliest or a desired date.
{
"deliveryDateType":
string
Required | 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":
string
The name of the delivery type for express delivery (required if EXPRESS) | Example: Go-Express
"desiredDeliveryDate":
string
The desired date in relation to the type (required if EARLIEST or FIXED) | Format: date-time
}
"expectedDeliveryDays":
integer
Required | Expected delivery in days | Format: int32
| Example: 3
"supplierExpectedDeliveryDays":
integer
Supplier expected delivery in days | Format: int32
| Example: 3
"confirmedDeliveryDate":
string
The delivey date, as confirmed by the supplier | Format: date-time
}
"quantity":
integer
Required | The ordered quantity | Format: int32
| Example: 1
"sum":
object
Required | A SumPrice
object. Sum of prices including taxes and promotions. Note that at least net or gross price must be given.
{
"net":
object
A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"gross":
object
A Price
object. A price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
}
"taxes":
array
Required | An array of Tax
objects. Taxes related to the prices
[
Tax
:
A tax including type and amount{
"type":
string
Required | The type of tax | Example: NORMAL_TAX
"amount":
number
Required | Amount of the tax | Example: 1.7
}
]
"promotions":
array
An array of Promotion
objects. Promotions related to the prices
[
Promotion
:
A promotion.{
"promotionValueType":
string
Required | 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":
number
Required | The value of the promotion, which can be a percentage or a fixed amount | Example: 10
"id":
string
Required | Identifier of the promotion | Example: Promo-2020-12-123
"name":
string
Required | Name of the promotion | Min Length: 0
| Max Length: 256
| Example: Silvester 2020 - extra
"descriptorId":
string
Required | Descriptor of the promotion | Min Length: 0
| Max Length: 255
| Example: SILVESTER
"code":
string
Code of the promotion | Min Length: 0
| Max Length: 256
| Example: SILVESTER2020
"budgetSourceId":
string
Budget source of the promotion | Min Length: 0
| Max Length: 256
| Example: Marketing 2020-12
"netValue":
number
Required | The net amount given with the promotion | Example: 10
"grossValue":
number
Required | The gross amount given with the promotion | Example: 12
}
]
}
"unitPrice":
object
A UnitPrice
object. Price per product unit. Note that at least net or gross price must be given.
{
"net":
object
A ListPrice
object. A list price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
"listPrice":
number
The list price/ recommended retail price
}
"gross":
object
A ListPrice
object. A list price
{
"amount":
number
Required | The amount of the price | Example: 100
"amountDiscounted":
number
The discounted price | Example: 90
"listPrice":
number
The list price/ recommended retail price
}
}
}
"commissioned":
object
A OrderPositionSupplier
object. Supplier specific information
{
"name":
string
Required | Name of the supplier as used by the shop | Example: Supplier X
"commissionDate":
string
Timestamp indicating when the order position was commissioned to the supplier | Format: date-time
| Example: 2019-05-28T14:36:17.158+02:00
}
"confirmed":
object
A OrderPositionConfirmed
object. Confirmed products of the order position
{
"type":
string
Required | Type of confirmation of the supplier
"confirmationDate":
string
Required | Date of confirmation of the supplier | Format: date-time
"quantities":
array
An array of OrderPositionConfirmedQuantity
objects. Confirmed quantities
[
OrderPositionConfirmedQuantity
:
Confirmed quantity for a planned delivery date{
"value":
integer
Required | The quantity to be delivered at the planned delivery date | Format: int32
| Example: 1
"plannedDeliveryDate":
string
The planned delivery date | Format: date
}
]
"cancelled":
array
An array of OrderPositionConfirmedCancelled
objects. At least one product is not available (already cancelled or recalled)
[
OrderPositionConfirmedCancelled
:
Confirmed cancelled products{
"quantity":
integer
Required | Cancelled quantity | Format: int32
| Example: 1
"cancelDate":
string
Date of cancellation or recall | Format: date-time
"reason":
object
A OrderPositionConfirmedCancelledReason
object. Cancellation reason
{
"id":
string
Required | Code of reason of the cancellation or recall | Example: RCL021
"value":
string
Reason of cancellation or recall (free text) | Example: Cancellation due to missing stock.
}
}
]
}
"dispatched":
array
An array of OrderPositionDispatched
objects. Information about dispatched products
[
OrderPositionDispatched
:
Dispatched positions{
"quantity":
integer
Required | Dispatched quantity | Format: int32
| Example: 1
"deliveryNoteNumber":
string
Delivery note number | Example: 980392-481
"dispatchDate":
string
Required | Timestamp of the handover of the package to the carrier | Format: date-time
"carrier":
object
A OrderStateOrderPositionDispatchedCarrier
object. Carrier of the shipment
{
"name":
string
Required | Name of the carrier | Example: DHL
"packages":
integer
Required | Number of packages | Format: int32
| Example: 1
"shipmentTracking":
object
A OrderPositionDispatchedCarrierTracking
object. Tracking information of the shipment
{
"number":
string
Required | Tracking number of the package | Example: 929-912-03013
"url":
string
Tracking URL | Format: uri
}
}
"units":
array
An array of OrderPositionDispatchedUnit
objects. Further information for a single product/ item
[
OrderPositionDispatchedUnit
:
Further information for a single product/ item{
"serialNumber":
string
Required | Serial number of the product | Example: 89712007
}
]
}
]
"returned":
array
An array of OrderPositionReturned
objects. Information about returned products
[
Either OrderPositionReturnedQuantities
:
Quantity based return informationen of an order position{
"status":
string
Required | Status of the return | Example: CLOSED
"supplierEntryDate":
string
Timestamp of the entry of the return at the supplier | Format: date-time
"quantity":
integer
Required | Number of returned products of the position | Format: int32
| Example: 2
"returnReason":
object
A OrderPositionReturnedReason
object. Details about the return reason
{
"value":
string
Required | The return reason | Example: RET990
"type":
string
Required | The return type of the return reason | Example: RET
}
"payment":
object
A OrderPositionReturnedReturnPayment
object. Return payment
{
"reduction":
object
Required | A OrderPositionReturnedReturnPaymentReduction
object. Reason for price reduction
{
"reduceText":
string
Required | Reduction reason of the supplier | Example: The original packaging was badly damaged by the customer.
"reduceReason":
string
Required | Name of reduction as used by the shop | Example: AK-0
}
"refundNet":
number
Required | Net amount of the refund | Example: 12.87
}
}
Or OrderPositionReturnedUnits
:
Unit/ item based return informationen of an order position{
"status":
string
Required | Status of the return | Example: CLOSED
"supplierEntryDate":
string
Timestamp of the entry of the return at the supplier | Format: date-time
"units":
array
Required | An array of OrderPositionReturnedUnitsUnit
objects. Information about return of individual products
[
OrderPositionReturnedUnitsUnit
:
Return information for a single product/ unit/ item{
"serialNumber":
string
Required | The serial number of the product/ item | Example: 9834JJ-43
"returnReason":
object
A OrderPositionReturnedReason
object. Details about the return reason
{
"value":
string
Required | The return reason | Example: RET990
"type":
string
Required | The return type of the return reason | Example: RET
}
"payment":
object
A OrderPositionReturnedReturnPayment
object. Return payment
{
"reduction":
object
Required | A OrderPositionReturnedReturnPaymentReduction
object. Reason for price reduction
{
"reduceText":
string
Required | Reduction reason of the supplier | Example: The original packaging was badly damaged by the customer.
"reduceReason":
string
Required | Name of reduction as used by the shop | Example: AK-0
}
"refundNet":
number
Required | Net amount of the refund | Example: 12.87
}
}
]
}
]
}
]
}
]
"status":
string
Required | The status of the order | Example: STATE_DISPATCHED
"notes":
array
An array of OrderNote
objects. Notes regarding the order
[
OrderNote
:
A note regarding the order{
"message":
string
Required | The content of the note | Example: The customer has a complaint about the delivery.
"type":
string
The type of the note | Example: COMPLAINT
"creationDate":
string
The creation date of the note | Format: date-time
| Example: 2020-12-28T09:22:44.838+02:00
}
]
"paymentState":
object
A PaymentState
object. The payment state of the order including payment history
{
"invoicingDebitAmount":
number
Required | Amount of all invoices for this order | Example: 1000
"invoicingCreditAmount":
number
Required | Amount of all credit notes for this order | Example: 5
"chargedDebitAmount":
number
Required | Amount of all captured amounts for this order | Example: 45
"chargedCreditAmount":
number
Required | Amount of all refunded amounts for this order | Example: 5
"chargedOpenAmount":
number
Required | Positive amount (amount of open refunds) - Negative amount (amount of open captures) | Example: 0
"bookedDebitAmount":
number
Required | Amount of all inbound payments for this order | Example: 0
"bookedCreditAmount":
number
Required | Amount of all outbound payments for this order | Example: 45
"bookedOpenAmount":
number
Required | Positive amount (amount of open outbound payments) - Negative amount (amount of open inbound payments) | Example: 0
"creationDate":
string
Required | Creation date of the payment status | Format: date-time
| Example: 2020-12-28T19:46:49.838+02:00
"lastCaptureDate":
string
Date of the last payment capture | Format: date-time
| Example: 2020-12-10T22:16:23.838+02:00
"lastRefundDate":
string
Date of the last refund | Format: date-time
| Example: 2020-12-28T19:46:49.838+02:00
"lastCalculationDate":
string
Required | Date of last calculation of the payment status | Format: date-time
| Example: 2020-11-28T19:46:49.838+02:00
"currencyCode":
string
Required | Currency code of the balance amounts (ISO 4217) | Example: EUR
"paymentHistory":
array
An array of PaymentStateHistoryItem
objects. Payment history of the order
[
PaymentStateHistoryItem
:
Payment history entry of an order{
"amount":
number
Required | Amount of the payment | Example: 109.78
"currencyCode":
string
Required | Currency code of the payment (ISO 4217) | Example: EUR
"type":
string
Required | The type of the payment notification. Possible values are INBOUND
, OUTBOUND
, ACTION
. | Example: INBOUND
"action":
string
Required | The payment action. Possible values are AUTHORIZATION
, REVERSE
, CAPTURE
, REFUND
. | Example: CAPTURE
"paymentMethod":
string
Required | The payment method of the payment | Example: CREDITCARD
"creationDate":
string
Required | Creation date of the payment notification | Format: date-time
| Example: 2020-12-28T19:46:49.838+02:00
"modificationDate":
string
Required | Modification date of the payment notification | Format: date-time
| Example: 2020-12-28T19:46:49.838+02:00
"comment":
string
Comment of the item
"invoiceNumber":
string
Invoice number, if the payment relates to an invoice
}
]
}
"documents":
array
An array of OrderDocument
objects. Order-related documents given as links, e.g. invoices
[
OrderDocument
:
An order-related document given as link{
"type":
string
Required | The type of the document | Example: invoiceNote
"downloadLink":
string
Required | 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":
string
The creation date of the document (ISO-8601) | Format: date-time
| Example: 2018-12-24T16:22:32.123+02:00
"mimeType":
string
The MIME-type of the document | Example: application/pdf
}
]
}
]
"meta":
object
A CollectionMetaData
object. The meta data of the collection
{
"totalCount":
integer
The total number of objects in the collection (without offset and limit) | Format: int64
| Example: 10000
}
"links":
object
Link section
}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.