Personal Library

Kbid	H29772
Last Modified	23-Feb-2021
Added to KB	26-Jan-2021
Public Access	Everyone
Status	Online
Doc Type	References
Product	ICM 7.10

Reference - Order API 1.0.1

https://support.intershop.com/kb/H29772

Share this document

Product Version	7.10.27.0
Product To Version
Status	final

Download Specification

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

icm-b2b-order-1x0x1.yaml

API Specification

Introduction

OpenAPI Version: 3.0.1

Order Version: 1.0.1

This is Intershop ICM REST API documentation.

This reference lists the REST API for storefront development. The REST API covers features of both, the B2C (SMB - Small and Medium-sized businesses) and the B2B storefront development.
This reference is intended for developers who want to make use of an easy-to-use API when developing frontend solutions.
You can find more information at Intershop Communications. Contact our Intershop experts at Support - Intershop Communications

Introduction

This API is documented in OpenAPI format.

General API

/orders

GET: Returns the list of orders for the user.

Description

Returns the list of orders for the user. If user authentication fails, a 401 error with body string 'Unauthorized' is returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.order.OrderListResource.getOrders_V1(java.lang.String,java.lang.String,java.lang.Integer)

Request Body

Request Parameters

Location	Name	Format	Description
in query	include	array	Related objects (as a comma separated list) which are to be included with the response. \| Possible Values: `allbucketsbuyingContextcommonShipToAddresscommonShippingMethoddiscountsinvoiceToAddresslineItemspayments`
in query	filter[statusCode]	string	Filters orders by their (case-sensitive) order status. \| Example: `filter[statusCode]=NEW,PENDING`
in query	page[limit]	integer	Limits the number of orders returned in th response. \| Format: `int32` \| Example: `page[limit]=10`

Response

200 - OK

The list of orders.

OrderListCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.

422 - Unprocessable Entity

In case of semantical errors of the request, e.g. invalid status code filter.

OrderListCtnrRO_v1 application/json

POST: Creates a new order for the user from a given basket.

Description

Creates a new order for the user from a given basket. If the basket is not valid or there are other errors during order creation, then status 422 together with a cause description is returned. If user authentication fails, a 401 error with body string 'Unauthorized' is returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.order.OrderListResource.createOrder_V1(com.intershop.sellside.rest.order.v1.capi.resourceobject.order.OrderRO,java.lang.String)

Request Body

OrderRO_v1 application/json

Request Parameters

Location	Name	Format	Description
in query	include	array	Related objects (as a comma separated list) which are to be included with the response. \| Possible Values: `allbucketsbuyingContextcommonShipToAddresscommonShippingMethoddiscountsinvoiceToAddresslineItemspayments`

Response

201 - Created

The created order if the process finished successfully.

OrderCtnrRO_v1 application/json

202 - Accepted

If the order creation was successfully started, but additional steps need to be performed before the order creation is finished (e. g. a redirect to the payment service provider, order approval etc.). Depending on the state of the order creation, further actions could include changing to a different resource with a provided link (e.g. for order approval switching to "Requisition" resource), a "PATCH" request on the order item resource to continue the order creation process or others.

OrderCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.

422 - Unprocessable Entity

If the order could not be created because of semantical errors.

OrderCtnrRO_v1 application/json

/orders/{orderKey}

GET: Returns the order with the given ID.

Description

Returns the order with the given ID for the user. If no order with this ID is found, a 404 error will be returned. If user authentication fails, a 401 error with body string 'Unauthorized' is returned. Error 403 is returned, if the user does not have the required access privileges. Error 410 is returned, if order is abort with payment canceled.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.order.OrderItemResource.getOrder_V1(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in path	orderKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in query	include	array	Related objects (as a comma separated list) which are to be included with the response. \| Possible Values: `allbucketsbuyingContextcommonShipToAddresscommonShippingMethoddiscountsinvoiceToAddresslineItemspayments`

Response

200 - OK

The order with the given ID.

OrderCtnrRO_v1 application/json

401 - Unauthorized

If the user could not be authenticated.

403 - Forbidden

If the user does not have the required access privileges.

404 - Not Found

If no order is found.

OrderCtnrRO_v1 application/json

410 - Gone

If order is abort with payment canceled.

PATCH: Updates the order with the given ID.

Description

Updates the order with the given ID. This is currently only used to continue an interrupted order creation process (e. g. because of a payment which required a redirect) by setting the "orderCreation.status" field to "CONTINUE". If there are errors during the continued order process, status 422 with an appropriate cause description is returned. If no order with this ID is found for the user, a 404 error will be returned. If user authentication fails, a 401 error with body string "Unauthorized" is returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.order.OrderItemResource.updateOrder_V1(com.intershop.sellside.rest.order.v1.capi.resourceobject.order.OrderRO,java.lang.String)

Request Body

OrderRO_v1 application/json

Request Parameters

Location	Name	Format	Description
in path	orderKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in query	include	array	Related objects (as a comma separated list) which are to be included with the response. \| Possible Values: `allbucketsbuyingContextcommonShipToAddresscommonShippingMethoddiscountsinvoiceToAddresslineItemspayments`

Response

200 - OK

The updated order if the order process is completed.

OrderCtnrRO_v1 application/json

202 - Accepted

If the order process was continued, but additional steps need to be performed by the client before the order creation is finished (e. g. another redirect to a different payment service provider).

OrderCtnrRO_v1 application/json

401 - Unauthorized

If the user could not be authenticated.

404 - Not Found

If an order with the given ID is not found in the list of user orders.

OrderCtnrRO_v1 application/json

422 - Unprocessable Entity

If the order could not be updated because of semantical errors.

OrderCtnrRO_v1 application/json

/orders/{orderKey}/attributes

GET: Returns (custom) attributes for the order.

Description

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.attribute.OrderAttributeListResource.getAttributes_V1(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in path	orderKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in query	include	string	Related objects (as a comma separated list) which are to be included with the response.

Response

200 - OK

The list of attributes.

AttributeListCtnrRO_v1 application/json

POST: Creates a new (custom) attribute at the order.

Description

Creates a new (custom) attribute at the order. The name of the attribute is used as identifier for the created sub resource. If an attribute with this name already exists or if an unknown type is passed or the value does not match the type, error 422 will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.attribute.OrderAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)

Request Body

AttributeRO_v1 application/json

Request Parameters

Location	Name	Format	Description
in path	orderKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in query	include	string	Related objects (as a comma separated list) which are to be included with the response.

Response

201 - Created

The created attribute.

AttributeCtnrRO_v1 application/json

422 - Unprocessable Entity

If the attribute could not be created because of semantic errors in the passed data.

AttributeCtnrRO_v1 application/json

Line Item API

/orders/{orderKey}/items

GET: Returns the list of line items for the selected order.

Description

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.lineitem.LineItemListResource.getLineItems_V1(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in path	orderKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in query	include	array	Related objects (as a comma separated list) which are to be included with the response. \| Possible Values: `alldiscountsproductshipToAddressshippingMethodwarranty`

Response

200 - OK

The list of line items.

OrderLineItemListCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.

/orders/{orderKey}/items/{LineItemKey}

GET: Returns the line item for the given ID.

Description

Returns the line item for the given ID. If no line item with this ID is found, a 404 error will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.lineitem.LineItemItemResource.getLineItem_V1(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in path	orderKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in path	LineItemKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in query	include	array	Related objects (as a comma separated list) which are to be included with the response. \| Possible Values: `alldiscountsproductshipToAddressshippingMethodwarranty`

Response

200 - OK

Information message describing success status.

OrderLineItemCtnrRO_v1 application/json

404 - Not Found

If a line item with the given ID is not found in the order.

OrderLineItemCtnrRO_v1 application/json

/orders/{orderKey}/items/{LineItemKey}/attributes

GET: Returns (custom) attributes for the line item.

Description

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.attribute.LineItemAttributeListResource.getAttributes_V1(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in path	orderKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in path	LineItemKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in query	include	string	Related objects (as a comma separated list) which are to be included with the response.

Response

200 - OK

The list of attributes.

AttributeListCtnrRO_v1 application/json

POST: Creates a new (custom) attribute at the line item.

Description

Creates a new (custom) attribute at the line item. The name of the attribute is used as identifier for the created sub resource. If an attribute with this name already exists or if an unknown type is passed or the value does not match the type, error 422 will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.attribute.LineItemAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)

Request Body

AttributeRO_v1 application/json

Request Parameters

Location	Name	Format	Description
in path	orderKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in path	LineItemKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in query	include	string	Related objects (as a comma separated list) which are to be included with the response.

Response

201 - Created

The created attribute.

AttributeCtnrRO_v1 application/json

422 - Unprocessable Entity

If the attribute could not be created because of semantic errors in the passed data.

AttributeCtnrRO_v1 application/json

Payment API

/orders/{orderKey}/payments

GET: Returns the list of payments assigned to the order.

Description

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.payment.PaymentListResource.getPayments_V1(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in path	orderKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in query	include	array	Related objects (as a comma separated list) which are to be included with the response. \| Possible Values: `allpaymentInstrumentpaymentMethod`

Response

200 - OK

The list of payments.

PaymentCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.

/orders/{orderKey}/payments/{PaymentKey}

PATCH: Updates the payment.

Description

Updates the payment. If the payment could not be updated, a 422 error will be returned. Note that this will only allow to set/update redirect data, e.g. the return URLS'. Other changes are not supported and will be ignored.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.payment.PaymentItemResource.updatePayment_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO,java.lang.String)

Request Body

PaymentRO_v1 application/json

Request Parameters

Location	Name	Format	Description
in path	orderKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in path	PaymentKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in query	include	array	Related objects (as a comma separated list) which are to be included with the response. \| Possible Values: `allpaymentInstrumentpaymentMethod`

Response

200 - OK

Information message describing success status.

PaymentCtnrRO_v1 application/json

422 - Unprocessable Entity

If the payment could not be updated.

PaymentCtnrRO_v1 application/json

Shipping Bucket API

/orders/{orderKey}/buckets

GET: Returns the list of shipping buckets for the selected order.

Description

Returns the list of shipping buckets for the selected order. Note that buckets are built dynamically and are not persisted. Bucket assignments and IDs could change if items are moved to a different bucket (by changing ship-to address or shipping method of a line item). It is therefore recommended to always retrieve the list of buckets before performing any operation on a single bucket.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.shipping.ShippingBucketListResource.getShippingBuckets_V1(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in path	orderKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in query	include	array	Related objects which are to be included with the response. \| Possible Values: `alldiscountsshipToAddressshippingMethod`

Response

200 - OK

The list of shipping buckets.

Object application/json

401 - Unauthorized

If the user couldn't be authenticated.

/orders/{orderKey}/buckets/{ShippingBucketKey}

GET: Returns the shipping bucket with the given ID.

Description

Returns the shipping bucket with the given ID. If no shipping bucket with this ID is found, a 404 error will be returned. Note that this could also mean that items have been added or removed from the bucket, as buckets are not persisted and IDs are determined dynamically through a hash over all items in the bucket. If such changes occur, the shipping bucket list needs to be retrieved again before working on single buckets.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.order.v1.capi.resource.shipping.ShippingBucketItemResource.getShippingBucket_V1(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in path	orderKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in path	ShippingBucketKey	string	Required \| The key or UUID to resolve a single item \| Example: `ExampleKey`
in query	include	array	Related objects (as a comma separated list) which are to be included with the response. \| Possible Values: `alldiscountsshipToAddressshippingMethod`

Response

200 - OK

The shipping bucket.

OrderShippingBucketCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.

404 - Not Found

If a shipping bucket with the given ID is not found in the order.

OrderShippingBucketCtnrRO_v1 application/json

Request and Response Object Schemata

AttributeCtnrRO_v1 application/json

{

"data":
object
A AttributeRO_v1Object object. A representation of an attribute.
{
- "name":
  string
  Required | The name of an element.
- "type":
  string
  Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
- "value":
  object
}
"errors":
array
Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Optionally included related data objects.
"infos":
array
Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.

}

AttributeListCtnrRO_v1 application/json

{

"data":
array
An array of AttributeRO_v1Object objects. The core data of the response object.
[
AttributeRO_v1Object: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
{
- "name":
  string
  Required | The name of an element.
- "type":
  string
  Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
- "value":
  object
}
]
"errors":
array
Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Optionally included related data objects.
"infos":
array
Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.

}

AttributeRO_v1 application/json

{

"name":
string
Required | The name of an element.
"type":
string
Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
"value":
object

}

OrderCtnrRO_v1 application/json

{

"data":
object
A OrderRO_v1 object. A representation of an order
{
- "affiliatePartner":
  string
  Readonly | The affiliate partner id of the order. | Example: 4bcKAB2Ykg4AAAFbjvEYRPJ7
- "affiliateProgram":
  string
  Readonly | The affiliate program id of the order. | Example: uzMKAB2YvKAAAAFb7DUYRPJ8
- "attributes":
  array
  An array of AttributeRO_v1 objects.
  [
  AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
  {
  "name":
  string
  Required | The name of an element.
  "type":
  string
  Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
  "value":
  object
  }
  ]
- "basket":
  string
  Required | The basket (ID) which this order is created from. | Example: b45KeTsBizQBBBFjXFAA6S15
- "buckets":
  array
  Readonly | An array of string literals. The bucket ids of all shipping buckets of an order.
- "buyingContext":
  string
  Readonly | The buying context group identifier of the order. | Example: OilCorp_Germany
- "commonShipToAddress":
  string
  Readonly | The common ship-to address URN of the order. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
- "commonShippingMethod":
  string
  Readonly | The common shipping method id of the order. | Example: STD_5DAY
- "costCenter":
  string
  Readonly | The cost center id of the order. | Example: 511288
- "creationDate":
  string
  Readonly | The creation date of the order. | Format: date-time | Example: 2019-06-30T11:23:45.000Z
- "customer":
  string
  Readonly | The order owner customer number.
- "department":
  string
  Readonly | The department name of the order. | Example: SALES
- "discounts":
  object
  A OrderDiscountsRO_v1 object. Provides details about the applied discounts.
  {
  - "freeGiftDiscounts":
    array
    Readonly | An array of string literals. The IDs of all free gift discounts granted on the order.
  - "shippingBasedDiscounts":
    array
    Readonly | An array of string literals. The IDs of all discounts granted on shipping and handling costs.
  - "valueBasedDiscounts":
    array
    Readonly | An array of string literals. The IDs of all discounts granted on the order total.
  }
- "documentNumber":
  string
  Readonly | The document number of the order.
- "externalOrderReference":
  string
  Readonly | The external order reference id of the order. | Example: 30000008899
- "id":
  string
  Readonly | The ID of the order. | Example: q2QKAEsBiyQAAAFjXFBB6G14
- "invoiceToAddress":
  string
  Readonly | The invoice-to address URN of the order. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
- "lineItems":
  array
  Readonly | An array of string literals. The IDs of all line items of an order.
- "messageToMerchant":
  string
  Readonly | Something what the buyer would like to tell the merchant. | Example: Is it possible to send the ordered articles before Christmas?
- "orderCreation":
  object
  A OrderCreationRO_v1 object. A resource object containing data about an ongoing order creation process. Includes information about the status of the order creation and whether additional actions need to be performed before the order creation is finished (e. g. redirects to payment providers).
  {
  - "redirect":
    object
    A PaymentRedirectRO_v1 object. Describes a payment redirect. Note: Beta version - This class can still be subject of change!
    {
    "cancelUrl":
    string
    Required | The URL to be called when the user cancelled payment and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/cancel?paymentID=*paymentID*
    "failureUrl":
    string
    Required | The URL to be called when the payment failed and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/failure
    "parameters":
    array
    An array of ParameterRO_v1 objects. List of parameters returned in the redirect response from the PSP.
    [
    ParameterRO_v1: A representation of a parameter value.
    {
    "name":
    string
    The name of an element. | Example: expiryDate
    "value":
    object
    The value of the parameter. | Example: 12/30
    }
    ]
    "redirectUrl":
    string
    Readonly | The URL to be called when redirecting the user to the payment providers page. | Format: uri | Example: https://psp-server/pay
    "status":
    string
    The final status of the redirect returned to the shop. | Example: SUCCESS | Possible Values: SUCCESSCANCELFAILURE
    "successUrl":
    string
    Required | The URL to be called on successful payment redirect back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/success?orderID=*orderID*
    }
  - "status":
    string
    Represents the status of the order creation process. If this returns "COMPLETED", then the order creation is finished. If this returns "ROLLED_BACK", then the order creation was unsuccessful (e. g. because of a failed or cancelled payment) and the order is rolled back and becomes inaccessible. If this returns "STOPPED", then the client needs to perform the action from the "stopAction" field first. Once done, the order creation can be continued by setting this to "CONTINUE". Passing other values than "CONTINUE" will result in an error. | Possible Values: COMPLETEDSTOPPEDROLLED_BACKCONTINUE
  - "stopAction":
    object
    A StopActionRO_v1 object. A representation of a stop action. A stop action is an action that needs to be performed before a certain process (e. g. creation of an order) can be continued.
    {
    "type":
    string
    Required | Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    }
  }
- "payments":
  array
  Readonly | An array of string literals. The payments used to pay the order.
- "promotionCodes":
  array
  Readonly | An array of string literals. The promotion codes of the order.
- "purchaseCurrency":
  string
  Readonly | The purchase currency of the order. | Example: USD
- "recurringOrderDocumentNo":
  string
  Readonly | The recurring order number.
- "requisitionDocumentNo":
  string
  Readonly | The requisition documentnumber. | Example: 00001052
- "status":
  string
  Readonly | The localized display name of the order status. | Example: in progress
- "statusCode":
  string
  Readonly | The status code of the order. | Example: INPROGRESS
- "surcharges":
  object
  A OrderSurchargesRO_v1 object. Surcharges that are applied to an order.
  {
  - "bucketSurcharges":
    array
    Readonly | An array of OrderSurchargeRO_v1 objects. All bucket based extra charges arising from surcharges with action type 'bucket'.
    [
    OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
    {
    "amount":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "name":
    string
    Readonly | The name of an element. | Example: Fridge Box
    "description":
    string
    Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
    "taxes":
    array
    Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
    [
    TaxItemRO_v1: Represents a single tax item.
    {
    "calculatedTax":
    object
    Required | A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "effectiveTaxRate":
    number
    Required | The effective rate used to calculate the tax.
    "jurisdiction":
    object
    A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
    {
    "id":
    string
    The jurisdiction ID. | Example: CANADA
    "level":
    string
    The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
    }
    "nonTaxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "situs":
    string
    Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
    "taxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    ]
    }
    ]
  - "itemSurcharges":
    array
    Readonly | An array of OrderSurchargeRO_v1 objects. All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item'.
    [
    OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
    {
    "amount":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "name":
    string
    Readonly | The name of an element. | Example: Fridge Box
    "description":
    string
    Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
    "taxes":
    array
    Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
    [
    TaxItemRO_v1: Represents a single tax item.
    {
    "calculatedTax":
    object
    Required | A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "effectiveTaxRate":
    number
    Required | The effective rate used to calculate the tax.
    "jurisdiction":
    object
    A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
    {
    "id":
    string
    The jurisdiction ID. | Example: CANADA
    "level":
    string
    The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
    }
    "nonTaxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "situs":
    string
    Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
    "taxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    ]
    }
    ]
  }
- "taxIdentificationNumber":
  string
  Readonly | The tax identification number of the buyer/company. | Example: 11111111
- "termsAndConditionsAccepted":
  boolean
  Required | Flag for specifying whether the terms and conditions have been accepted. A value of 'false' will cause the order creation to fail.
- "totalProductQuantity":
  number
  Readonly | The sum of all quantities of products in the order. | Example: 23
- "totals":
  object
  A OrderTotalsRO_v1 object. Total price values for an order.
  {
  - "grandTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "paymentCostsTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "undiscountedItemTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "undiscountedShippingTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "bucketShippingDiscountsTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "discountTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "giftingTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "itemShippingDiscountsTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "itemTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "itemValueDiscountsTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "orderShippingDiscountsTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "orderValueDiscountsTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "salesTaxTotalsByTaxRate":
    array
    Readonly | An array of TaxItemRO_v1 objects. All sales taxes applied to the order, accumulated by their tax rates.
    [
    TaxItemRO_v1: Represents a single tax item.
    {
    "calculatedTax":
    object
    Required | A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "effectiveTaxRate":
    number
    Required | The effective rate used to calculate the tax.
    "jurisdiction":
    object
    A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
    {
    "id":
    string
    The jurisdiction ID. | Example: CANADA
    "level":
    string
    The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
    }
    "nonTaxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "situs":
    string
    Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
    "taxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    ]
  - "shippingDiscountsTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "shippingTaxTotalsByTaxRate":
    array
    Readonly | An array of TaxItemRO_v1 objects. All shipping taxes applied to the order, accumulated by their tax rates.
    [
    TaxItemRO_v1: Represents a single tax item.
    {
    "calculatedTax":
    object
    Required | A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "effectiveTaxRate":
    number
    Required | The effective rate used to calculate the tax.
    "jurisdiction":
    object
    A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
    {
    "id":
    string
    The jurisdiction ID. | Example: CANADA
    "level":
    string
    The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
    }
    "nonTaxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "situs":
    string
    Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
    "taxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    ]
  - "shippingTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "surchargeTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "taxTotalsByTaxRate":
    array
    Readonly | An array of TaxItemRO_v1 objects. All taxes applied to the order, accumulated by their tax rates (includes taxes levied to sales, prices, shipping and surcharges.
    [
    TaxItemRO_v1: Represents a single tax item.
    {
    "calculatedTax":
    object
    Required | A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "effectiveTaxRate":
    number
    Required | The effective rate used to calculate the tax.
    "jurisdiction":
    object
    A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
    {
    "id":
    string
    The jurisdiction ID. | Example: CANADA
    "level":
    string
    The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
    }
    "nonTaxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "situs":
    string
    Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
    "taxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    ]
  - "valueDiscountsTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  }
- "user":
  string
  Readonly | The order owner user login.
}
"errors":
array
Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Readonly | Optionally included related data objects. Included via "include" query parameter.
{
- "lineItems":
  object
  {
  - "":
    object
    A OrderLineItemRO_v1 object. Describes a line item that is part of an order.
    {
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "description":
    string
    Readonly | The description for the product line item. | Example: 20
    "desiredDelivery":
    string
    Readonly | The desired delivery date for the Item. | Format: date | Example: 2001-07-04T00:00:00.000Z
    "discounts":
    array
    Readonly | An array of string literals. The IDs of the discounts applied to the item pricing.
    "displayName":
    string
    Readonly | The display name of the product line item. | Example: Acer C20 silver edition
    "freeGift":
    boolean
    Readonly | Flag indicating that this product line item is a free gift and has been automatically placed in the line item container. | Example: false
    "fulfillmentStatus":
    string
    Readonly | The fulfillment status of this line item. | Example: NEW
    "giftMessage":
    string
    Readonly | Additional gift message for this the line item.
    "giftWrap":
    string
    Readonly | Additional gift wrapping for this the line item.
    "hiddenGift":
    boolean
    Readonly | Flag indicating that this product line item is a free gift, that will not be displayed in line item container. | Example: false
    "id":
    string
    Readonly | The line item's unique identifier.
    "order":
    string
    Readonly | The order this line item belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
    "position":
    integer
    Readonly | The position of the item in the order. | Format: int32
    "pricing":
    object
    A OrderLineItemPricingRO_v1 object. total price values of a line item
    {
    "giftingTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "price":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "salesTaxTotal":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "shippingRebatesTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "shippingTaxTotal":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "singleBasePrice":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "undiscountedPrice":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "undiscountedShippingTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "undiscountedSingleBasePrice":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "valueRebatesTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    }
    "product":
    string
    Required | Readonly | The product represented as stock keeping unit (SKU). | Example: 5079747
    "quantity":
    object
    Required | A QuantityRO_v1 object. A quantity of a business entity.
    {
    "unit":
    string
    The quantity's unit code. | Example: kg
    "value":
    number
    Required | The quantity's value. | Example: 10
    }
    "quote":
    string
    Readonly | The quote this item was created from. | Example: Qu0T3MgoyuMAx9Es2sx0Ue1
    "shipToAddress":
    string
    Readonly | The ship-to address URN for this line item. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
    "shippingMethod":
    string
    Readonly | The shipping method id for this line item. | Example: STD_5DAY
    "surcharges":
    array
    Readonly | An array of OrderSurchargeRO_v1 objects. Details about additional surcharges applied to the item.
    [
    OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
    {
    "amount":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "name":
    string
    Readonly | The name of an element. | Example: Fridge Box
    "description":
    string
    Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
    "taxes":
    array
    Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
    [
    TaxItemRO_v1: Represents a single tax item.
    {
    "calculatedTax":
    object
    Required | A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "effectiveTaxRate":
    number
    Required | The effective rate used to calculate the tax.
    "jurisdiction":
    object
    A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
    {
    "id":
    string
    The jurisdiction ID. | Example: CANADA
    "level":
    string
    The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
    }
    "nonTaxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "situs":
    string
    Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
    "taxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    ]
    }
    ]
    "thumbnail":
    string
    Readonly | The thumbnail uri of the Product. | Example: /INTERSHOP/static/WFS/inSPIRED-inTRONICS-Site/-/inSPIRED/en_US/M/3957288-5427.jpg
    "warranty":
    string
    Readonly | A warranty assigned to the line item.
    }
  }
- "buckets":
  object
  {
  - "":
    object
    A OrderShippingBucketRO_v1 object. Describes a shipping bucket.
    {
    "deliveryTimeMax":
    object
    Readonly | The maximum time the delivery will take based on the chosen shipping method (in ISO-8601 period format). | Example: P7D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "deliveryTimeMin":
    object
    Readonly | The minimum time the delivery will take based on the chosen shipping method (in ISO-8601 period format). | Example: P3D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "discounts":
    array
    Readonly | An array of string literals. The IDs of the discounts applied to the bucket totals.
    "id":
    string
    Readonly | The ID of the bucket. | Example: 54489489212
    "lineItems":
    array
    Readonly | An array of string literals. The ids of all line items which are associated with this bucket.
    "order":
    string
    Readonly | The order this shipping bucket belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
    "shipToAddress":
    string
    Readonly | The ship-to address URN for this bucket. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
    "shippingCosts":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "shippingMethod":
    string
    Readonly | The shipping method id for this bucket. | Example: STD_5DAY
    "surcharges":
    array
    Readonly | An array of OrderSurchargeRO_v1 objects. All extra charges arising from surcharges directly specified on product or by shipping rules with action type 'bucket'.
    [
    OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
    {
    "amount":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "name":
    string
    Readonly | The name of an element. | Example: Fridge Box
    "description":
    string
    Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
    "taxes":
    array
    Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
    [
    TaxItemRO_v1: Represents a single tax item.
    {
    "calculatedTax":
    object
    Required | A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "effectiveTaxRate":
    number
    Required | The effective rate used to calculate the tax.
    "jurisdiction":
    object
    A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
    {
    "id":
    string
    The jurisdiction ID. | Example: CANADA
    "level":
    string
    The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
    }
    "nonTaxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "situs":
    string
    Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
    "taxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    ]
    }
    ]
    }
  }
- "discounts":
  object
  {
  - "":
    object
    A OrderDiscountRO_v1 object. Describes a discount arising from an applied promotion.
    {
    "id":
    string
    Required | Readonly | The ID of the promotion that triggered the discount. | Example: 92YKAM6dZtIAAAFb_KwtfPFU
    "amount":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "code":
    string
    Readonly | The used promotion code. | Example: Intershop
    "promotion":
    string
    Readonly | The promotion id. | Example: FreeShippingOnLEDTVs
    }
  }
- "invoiceToAddress":
  object
  {
  - "":
    object
    A AddressRO_v1 object. The address
    {
    "addressLine1":
    string
    The first address line, that usual contains street and house number. | Example: Berliner Str. 20
    "addressLine2":
    string
    The second address line.
    "addressLine3":
    string
    The third address line.
    "aristocraticTitle":
    string
    The aristocratic title of the contact person, like 'Lord' or 'Lady'.
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "city":
    string
    The name of the city. | Example: Potsdam
    "companyName1":
    string
    The company name in case it is a business address. | Example: Intershop Communications AG
    "companyName2":
    string
    The second company name
    "country":
    string
    Readonly | The localized display name of the country | Example: Germany
    "countryCode":
    string
    The ISO 3166-1 country code | Example: DE
    "customer":
    string
    "eligibleInstallToAddress":
    boolean
    Flag indicating that the address can be used as install-to address. | Example: false
    "eligibleInvoiceToAddress":
    boolean
    Flag indicating that the address can be used as invoice-to address. | Example: true
    "eligibleServiceToAddress":
    boolean
    Flag indicating that the address can be used as service-to address. | Example: false
    "eligibleShipFromAddress":
    boolean
    Flag indicating that the address can be used as ship-from address. | Example: false
    "eligibleShipToAddress":
    boolean
    Flag indicating that the address can be used as ship-to address. | Example: true
    "email":
    string
    The e-mail address of the contact person. | Example: patricia@test.intershop.de
    "externalId":
    string
    The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
    "externalUrn":
    string
    The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
    "fax":
    string
    The fax number.
    "firstName":
    string
    The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
    "honorific":
    string
    The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
    "id":
    string
    The ID that identifies the address. | Example: 0987654321
    "jobTitle":
    string
    The job title of the contact person.
    "lastName":
    string
    The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
    "mainDivision":
    string
    Readonly | The localized display name of the main division | Example: Alabama
    "mainDivisionCode":
    string
    The main division code of the country, e. g. a state or province. | Example: Al
    "phoneBusiness":
    string
    The phone number of the contact person's company.
    "phoneBusinessDirect":
    string
    The business phone number of the contact person that allows an outside caller to connect directly to the
    contact person without any help of an attendant or operator.
    "phoneHome":
    string
    The phone number of the house or apartment where the contact person lives. | Example: 049364112677
    "phoneMobile":
    string
    The number of the contact person's cell phone.
    "postBox":
    string
    The post-office box.
    "postalCode":
    string
    The postal code of the city. | Example: 14482
    "secondLastName":
    string
    The second last name of the contact person.
    "secondName":
    string
    The second given name of the contact person.
    "subDivision":
    string
    Readonly | The localized display name of the sub division. | Example: City of Westminster
    "subDivisionCode":
    string
    The sub division code. | Example: 020
    "title":
    string
    The (personal) title of the contact person. | Example: Ms.
    "urn":
    string
    The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
    "usage":
    object
    The usage information for the address. Every bit in the returned set marks a specific usage type: [invoice-to, ship-to, ship-from, service-to, install-to]. If a bit is set, the address may be used for the specific purpose mapped to this bit. By default, all values are set to true.
    {
    "empty":
    boolean
    }
    }
  }
- "commonShipToAddress":
  object
  {
  - "":
    object
    A AddressRO_v1 object. The address
    {
    "addressLine1":
    string
    The first address line, that usual contains street and house number. | Example: Berliner Str. 20
    "addressLine2":
    string
    The second address line.
    "addressLine3":
    string
    The third address line.
    "aristocraticTitle":
    string
    The aristocratic title of the contact person, like 'Lord' or 'Lady'.
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "city":
    string
    The name of the city. | Example: Potsdam
    "companyName1":
    string
    The company name in case it is a business address. | Example: Intershop Communications AG
    "companyName2":
    string
    The second company name
    "country":
    string
    Readonly | The localized display name of the country | Example: Germany
    "countryCode":
    string
    The ISO 3166-1 country code | Example: DE
    "customer":
    string
    "eligibleInstallToAddress":
    boolean
    Flag indicating that the address can be used as install-to address. | Example: false
    "eligibleInvoiceToAddress":
    boolean
    Flag indicating that the address can be used as invoice-to address. | Example: true
    "eligibleServiceToAddress":
    boolean
    Flag indicating that the address can be used as service-to address. | Example: false
    "eligibleShipFromAddress":
    boolean
    Flag indicating that the address can be used as ship-from address. | Example: false
    "eligibleShipToAddress":
    boolean
    Flag indicating that the address can be used as ship-to address. | Example: true
    "email":
    string
    The e-mail address of the contact person. | Example: patricia@test.intershop.de
    "externalId":
    string
    The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
    "externalUrn":
    string
    The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
    "fax":
    string
    The fax number.
    "firstName":
    string
    The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
    "honorific":
    string
    The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
    "id":
    string
    The ID that identifies the address. | Example: 0987654321
    "jobTitle":
    string
    The job title of the contact person.
    "lastName":
    string
    The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
    "mainDivision":
    string
    Readonly | The localized display name of the main division | Example: Alabama
    "mainDivisionCode":
    string
    The main division code of the country, e. g. a state or province. | Example: Al
    "phoneBusiness":
    string
    The phone number of the contact person's company.
    "phoneBusinessDirect":
    string
    The business phone number of the contact person that allows an outside caller to connect directly to the
    contact person without any help of an attendant or operator.
    "phoneHome":
    string
    The phone number of the house or apartment where the contact person lives. | Example: 049364112677
    "phoneMobile":
    string
    The number of the contact person's cell phone.
    "postBox":
    string
    The post-office box.
    "postalCode":
    string
    The postal code of the city. | Example: 14482
    "secondLastName":
    string
    The second last name of the contact person.
    "secondName":
    string
    The second given name of the contact person.
    "subDivision":
    string
    Readonly | The localized display name of the sub division. | Example: City of Westminster
    "subDivisionCode":
    string
    The sub division code. | Example: 020
    "title":
    string
    The (personal) title of the contact person. | Example: Ms.
    "urn":
    string
    The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
    "usage":
    object
    The usage information for the address. Every bit in the returned set marks a specific usage type: [invoice-to, ship-to, ship-from, service-to, install-to]. If a bit is set, the address may be used for the specific purpose mapped to this bit. By default, all values are set to true.
    {
    "empty":
    boolean
    }
    }
  }
- "commonShippingMethod":
  object
  {
  - "":
    object
    A OrderShippingMethodRO_v1 object. Describes a shipping method that has been selected as delivery option.
    {
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "deliveryTimeMax":
    object
    Readonly | The maximum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P7D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "deliveryTimeMin":
    object
    Readonly | The minimum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P3D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "description":
    string
    Readonly | The shipping method's localized description. | Example: Delivered to you 3-7 business days after we process your order.
    "digitalDelivery":
    boolean
    Readonly | Whether this shipping method is a digital delivery method (e. g. for e-mail delivery).
    "id":
    string
    Readonly | The shipping method's unique identifier. | Example: STD_GROUND
    "name":
    string
    Readonly | The name of an element. | Example: Standard Ground
    "shippingCosts":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "shortName":
    string
    Readonly | The shipping method's localized short Name. | Example: Int'l Express Delivery.
    }
  }
- "payments":
  object
  {
  - "":
    object
    A PaymentRO_v1 object. A payment assigned to the basket/order to pay the bill with.
    {
    "baseAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "id":
    string
    Readonly | The ID of the payment. | Example: AAFjXFq2QKAEsBiyQABB6G14
    "openTender":
    boolean
    Readonly | Whether or not the payment is an 'open-tender' payment.
    "paymentCosts":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "paymentInstrument":
    string
    Required | The reference to the payment instrument that was selected for this payment. | Example: c2UKAEsBar8AAAFmxYVBTOiI
    "paymentMethod":
    string
    Readonly | The reference to the payment method that was used for this payment. | Example: ISH_INVOICE
    "redirect":
    object
    A PaymentRedirectRO_v1 object. Describes a payment redirect. Note: Beta version - This class can still be subject of change!
    {
    "cancelUrl":
    string
    Required | The URL to be called when the user cancelled payment and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/cancel?paymentID=*paymentID*
    "failureUrl":
    string
    Required | The URL to be called when the payment failed and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/failure
    "parameters":
    array
    An array of ParameterRO_v1 objects. List of parameters returned in the redirect response from the PSP.
    [
    ParameterRO_v1: A representation of a parameter value.
    {
    "name":
    string
    The name of an element. | Example: expiryDate
    "value":
    object
    The value of the parameter. | Example: 12/30
    }
    ]
    "redirectUrl":
    string
    Readonly | The URL to be called when redirecting the user to the payment providers page. | Format: uri | Example: https://psp-server/pay
    "status":
    string
    The final status of the redirect returned to the shop. | Example: SUCCESS | Possible Values: SUCCESSCANCELFAILURE
    "successUrl":
    string
    Required | The URL to be called on successful payment redirect back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/success?orderID=*orderID*
    }
    "redirectRequired":
    boolean
    Readonly | Whether or not a redirect is required to finish the payment. The type of redirect (before or after the checkout process) can be determined via the capabilities of the payment method.
    "status":
    string
    Readonly | The localized display name of the payment status. | Example: Partially captured
    "totalAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  }
- "buyingContext":
  object
  {
  - "":
    object
    A BuyingContextRO_v1 object. Provides details about the buying context.
    {
    "groupPath":
    array
    Readonly | An array of string literals. The hierarchy path from the root to the selected group. | Example: [OilCorp, OilCorp_EMEA, OilCorp_Germany]
    "id":
    string
    Readonly | The group identifier of the buying context. | Example: OilCorp_Germany
    }
  }
}
"infos":
array
Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.

}

OrderLineItemCtnrRO_v1 application/json

{

"data":
object
A OrderLineItemRO_v1 object. Describes a line item that is part of an order.
{
- "attributes":
  array
  An array of AttributeRO_v1 objects.
  [
  AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
  {
  "name":
  string
  Required | The name of an element.
  "type":
  string
  Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
  "value":
  object
  }
  ]
- "description":
  string
  Readonly | The description for the product line item. | Example: 20
- "desiredDelivery":
  string
  Readonly | The desired delivery date for the Item. | Format: date | Example: 2001-07-04T00:00:00.000Z
- "discounts":
  array
  Readonly | An array of string literals. The IDs of the discounts applied to the item pricing.
- "displayName":
  string
  Readonly | The display name of the product line item. | Example: Acer C20 silver edition
- "freeGift":
  boolean
  Readonly | Flag indicating that this product line item is a free gift and has been automatically placed in the line item container. | Example: false
- "fulfillmentStatus":
  string
  Readonly | The fulfillment status of this line item. | Example: NEW
- "giftMessage":
  string
  Readonly | Additional gift message for this the line item.
- "giftWrap":
  string
  Readonly | Additional gift wrapping for this the line item.
- "hiddenGift":
  boolean
  Readonly | Flag indicating that this product line item is a free gift, that will not be displayed in line item container. | Example: false
- "id":
  string
  Readonly | The line item's unique identifier.
- "order":
  string
  Readonly | The order this line item belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
- "position":
  integer
  Readonly | The position of the item in the order. | Format: int32
- "pricing":
  object
  A OrderLineItemPricingRO_v1 object. total price values of a line item
  {
  - "giftingTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "price":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "salesTaxTotal":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "shippingRebatesTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "shippingTaxTotal":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "singleBasePrice":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "undiscountedPrice":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "undiscountedShippingTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "undiscountedSingleBasePrice":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  - "valueRebatesTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  }
- "product":
  string
  Required | Readonly | The product represented as stock keeping unit (SKU). | Example: 5079747
- "quantity":
  object
  Required | A QuantityRO_v1 object. A quantity of a business entity.
  {
  - "unit":
    string
    The quantity's unit code. | Example: kg
  - "value":
    number
    Required | The quantity's value. | Example: 10
  }
- "quote":
  string
  Readonly | The quote this item was created from. | Example: Qu0T3MgoyuMAx9Es2sx0Ue1
- "shipToAddress":
  string
  Readonly | The ship-to address URN for this line item. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
- "shippingMethod":
  string
  Readonly | The shipping method id for this line item. | Example: STD_5DAY
- "surcharges":
  array
  Readonly | An array of OrderSurchargeRO_v1 objects. Details about additional surcharges applied to the item.
  [
  OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
  {
  "amount":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "name":
  string
  Readonly | The name of an element. | Example: Fridge Box
  "description":
  string
  Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
  "taxes":
  array
  Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
  }
  ]
- "thumbnail":
  string
  Readonly | The thumbnail uri of the Product. | Example: /INTERSHOP/static/WFS/inSPIRED-inTRONICS-Site/-/inSPIRED/en_US/M/3957288-5427.jpg
- "warranty":
  string
  Readonly | A warranty assigned to the line item.
}
"errors":
array
Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Readonly | Optionally included related data objects. Included via "include" query parameter.
{
- "discounts":
  object
  {
  - "":
    object
    A OrderDiscountRO_v1 object. Describes a discount arising from an applied promotion.
    {
    "id":
    string
    Required | Readonly | The ID of the promotion that triggered the discount. | Example: 92YKAM6dZtIAAAFb_KwtfPFU
    "amount":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "code":
    string
    Readonly | The used promotion code. | Example: Intershop
    "promotion":
    string
    Readonly | The promotion id. | Example: FreeShippingOnLEDTVs
    }
  }
- "product":
  object
  {
  - "":
    object
    A OrderProductRO_v1 object. A sellable entity that is offered to a customer.
    {
    "available":
    boolean
    Readonly | Checks if the product is available to be ordered. | Example: true
    "inStock":
    boolean
    Readonly | Gets the product inventory status. | Example: true
    "longDescription":
    string
    Readonly | The product's long description. | Example: Looking for an easy-to-use camera that's easy on your budget? You'll love the KODAK EASYSHARE C142 Digital Camera. With Kodak�s Smart Capture feature, brilliant pictures happen automatically. No worries. No hassles. Just beautiful pictures. And because it�s from Kodak, your memories will be as vivid as the moment they happened. If you want an affordable camera you'll feel good about, look to the name you know and trust. Whether it�s for you, or a gift for someone else, the C142 Camera is the perfect fit for sharing your memories. One-button upload�turn moments into memories - Snap your picture. - Press the Share button and tag it to YouTube, FACEBOOK, FLICKR and KODAK Gallery sites, plus e-mail too. - Connect your camera to your computer, and with Kodak's Share button app, your pictures are automatically uploaded. - Your pictures and videos are automatically transferred to your computer. KODAK EASYSHARE Software The complete solution for transferring, online sharing, e-mailing, organizing, editing, and creative printing of your pictures. - Organize your pictures with your own tags, star ratings, and date and time stamps, then use the search feature to quickly find any picture in your collection. - Edit your pictures with ease'select from a variety of simple tools that reduce red-eye, improve lighting, remove wrinkles and blemishes, and add text. - Create photo projects online or at home'choose from hundreds of templates and designs to create album pages, cards, invitations and much more. - Manually upload to YouTube, FACEBOOK, FLICKR and KODAK Gallery sites, plus e-mail too. Exceptional quality prints with 10 MP - 10 MP means you can make stunning prints up to 76 x 102 cm (30 ' 40 in.). - More megapixels means you can crop and enlarge and still have great picture quality. - However you choose to print'at home, at retail, or online'trust Kodak for picture quality that's truly exceptional and for memories that will last. 3X digital zoom lens - 3X optical zoom (35 mm equivalent: 35'102 mm) gets you closer to your subjects without reducing image quality. - The KODAK AF Optical Zoom Lens captures crisp details. - Zoom in close and capture all the details.
    "name":
    string
    Readonly | The name of an element. | Example: InTRONICS IS-25Y Portable
    "productBundle":
    boolean
    Readonly | Checks if the product is a product bundle. | Example: false
    "shortDescription":
    string
    Readonly | The product's short description. | Example: EasyShare C142, 10.3Mp, 1/ 6.35 cm (2.5 \") CCD, 3x opt, SD/SDHC, USB 2.0
    "sku":
    string
    Readonly | The stock keeping unit (SKU) of the product. | Example: 5079747
    "variationProduct":
    boolean
    Readonly | Checks if the product is a variation product. | Example: true
    }
  }
- "shipToAddress":
  object
  {
  - "":
    object
    A AddressRO_v1 object. The address
    {
    "addressLine1":
    string
    The first address line, that usual contains street and house number. | Example: Berliner Str. 20
    "addressLine2":
    string
    The second address line.
    "addressLine3":
    string
    The third address line.
    "aristocraticTitle":
    string
    The aristocratic title of the contact person, like 'Lord' or 'Lady'.
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "city":
    string
    The name of the city. | Example: Potsdam
    "companyName1":
    string
    The company name in case it is a business address. | Example: Intershop Communications AG
    "companyName2":
    string
    The second company name
    "country":
    string
    Readonly | The localized display name of the country | Example: Germany
    "countryCode":
    string
    The ISO 3166-1 country code | Example: DE
    "customer":
    string
    "eligibleInstallToAddress":
    boolean
    Flag indicating that the address can be used as install-to address. | Example: false
    "eligibleInvoiceToAddress":
    boolean
    Flag indicating that the address can be used as invoice-to address. | Example: true
    "eligibleServiceToAddress":
    boolean
    Flag indicating that the address can be used as service-to address. | Example: false
    "eligibleShipFromAddress":
    boolean
    Flag indicating that the address can be used as ship-from address. | Example: false
    "eligibleShipToAddress":
    boolean
    Flag indicating that the address can be used as ship-to address. | Example: true
    "email":
    string
    The e-mail address of the contact person. | Example: patricia@test.intershop.de
    "externalId":
    string
    The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
    "externalUrn":
    string
    The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
    "fax":
    string
    The fax number.
    "firstName":
    string
    The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
    "honorific":
    string
    The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
    "id":
    string
    The ID that identifies the address. | Example: 0987654321
    "jobTitle":
    string
    The job title of the contact person.
    "lastName":
    string
    The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
    "mainDivision":
    string
    Readonly | The localized display name of the main division | Example: Alabama
    "mainDivisionCode":
    string
    The main division code of the country, e. g. a state or province. | Example: Al
    "phoneBusiness":
    string
    The phone number of the contact person's company.
    "phoneBusinessDirect":
    string
    The business phone number of the contact person that allows an outside caller to connect directly to the
    contact person without any help of an attendant or operator.
    "phoneHome":
    string
    The phone number of the house or apartment where the contact person lives. | Example: 049364112677
    "phoneMobile":
    string
    The number of the contact person's cell phone.
    "postBox":
    string
    The post-office box.
    "postalCode":
    string
    The postal code of the city. | Example: 14482
    "secondLastName":
    string
    The second last name of the contact person.
    "secondName":
    string
    The second given name of the contact person.
    "subDivision":
    string
    Readonly | The localized display name of the sub division. | Example: City of Westminster
    "subDivisionCode":
    string
    The sub division code. | Example: 020
    "title":
    string
    The (personal) title of the contact person. | Example: Ms.
    "urn":
    string
    The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
    "usage":
    object
    The usage information for the address. Every bit in the returned set marks a specific usage type: [invoice-to, ship-to, ship-from, service-to, install-to]. If a bit is set, the address may be used for the specific purpose mapped to this bit. By default, all values are set to true.
    {
    "empty":
    boolean
    }
    }
  }
- "shippingMethod":
  object
  {
  - "":
    object
    A OrderShippingMethodRO_v1 object. Describes a shipping method that has been selected as delivery option.
    {
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "deliveryTimeMax":
    object
    Readonly | The maximum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P7D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "deliveryTimeMin":
    object
    Readonly | The minimum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P3D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "description":
    string
    Readonly | The shipping method's localized description. | Example: Delivered to you 3-7 business days after we process your order.
    "digitalDelivery":
    boolean
    Readonly | Whether this shipping method is a digital delivery method (e. g. for e-mail delivery).
    "id":
    string
    Readonly | The shipping method's unique identifier. | Example: STD_GROUND
    "name":
    string
    Readonly | The name of an element. | Example: Standard Ground
    "shippingCosts":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "shortName":
    string
    Readonly | The shipping method's localized short Name. | Example: Int'l Express Delivery.
    }
  }
- "warranty":
  object
  {
  - "":
    object
    A OrderWarrantyRO_v1 object. Describes a warranty assigned to the line item.
    {
    "product":
    string
    Required | Readonly | The Product representing the gift wrap.
    "price":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    }
  }
}
"infos":
array
Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.

}

OrderLineItemListCtnrRO_v1 application/json

{

"data":
array
An array of OrderLineItemRO_v1 objects. The core data of the response object.
[
OrderLineItemRO_v1: Describes a line item that is part of an order.
{
- "attributes":
  array
  An array of AttributeRO_v1 objects.
  [
  AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
  {
  "name":
  string
  Required | The name of an element.
  "type":
  string
  Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
  "value":
  object
  }
  ]
- "description":
  string
  Readonly | The description for the product line item. | Example: 20
- "desiredDelivery":
  string
  Readonly | The desired delivery date for the Item. | Format: date | Example: 2001-07-04T00:00:00.000Z
- "discounts":
  array
  Readonly | An array of string literals. The IDs of the discounts applied to the item pricing.
- "displayName":
  string
  Readonly | The display name of the product line item. | Example: Acer C20 silver edition
- "freeGift":
  boolean
  Readonly | Flag indicating that this product line item is a free gift and has been automatically placed in the line item container. | Example: false
- "fulfillmentStatus":
  string
  Readonly | The fulfillment status of this line item. | Example: NEW
- "giftMessage":
  string
  Readonly | Additional gift message for this the line item.
- "giftWrap":
  string
  Readonly | Additional gift wrapping for this the line item.
- "hiddenGift":
  boolean
  Readonly | Flag indicating that this product line item is a free gift, that will not be displayed in line item container. | Example: false
- "id":
  string
  Readonly | The line item's unique identifier.
- "order":
  string
  Readonly | The order this line item belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
- "position":
  integer
  Readonly | The position of the item in the order. | Format: int32
- "pricing":
  object
  A OrderLineItemPricingRO_v1 object. total price values of a line item
  {
  "giftingTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "price":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "salesTaxTotal":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "shippingRebatesTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "shippingTaxTotal":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "singleBasePrice":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "undiscountedPrice":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "undiscountedShippingTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "undiscountedSingleBasePrice":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "valueRebatesTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  }
- "product":
  string
  Required | Readonly | The product represented as stock keeping unit (SKU). | Example: 5079747
- "quantity":
  object
  Required | A QuantityRO_v1 object. A quantity of a business entity.
  {
  "unit":
  string
  The quantity's unit code. | Example: kg
  "value":
  number
  Required | The quantity's value. | Example: 10
  }
- "quote":
  string
  Readonly | The quote this item was created from. | Example: Qu0T3MgoyuMAx9Es2sx0Ue1
- "shipToAddress":
  string
  Readonly | The ship-to address URN for this line item. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
- "shippingMethod":
  string
  Readonly | The shipping method id for this line item. | Example: STD_5DAY
- "surcharges":
  array
  Readonly | An array of OrderSurchargeRO_v1 objects. Details about additional surcharges applied to the item.
  [
  OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
  {
  "amount":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "name":
  string
  Readonly | The name of an element. | Example: Fridge Box
  "description":
  string
  Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
  "taxes":
  array
  Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
  }
  ]
- "thumbnail":
  string
  Readonly | The thumbnail uri of the Product. | Example: /INTERSHOP/static/WFS/inSPIRED-inTRONICS-Site/-/inSPIRED/en_US/M/3957288-5427.jpg
- "warranty":
  string
  Readonly | A warranty assigned to the line item.
}
]
"errors":
array
Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Readonly | Optionally included related data objects. Included via "include" query parameter.
{
- "discounts":
  object
  {
  - "":
    object
    A OrderDiscountRO_v1 object. Describes a discount arising from an applied promotion.
    {
    "id":
    string
    Required | Readonly | The ID of the promotion that triggered the discount. | Example: 92YKAM6dZtIAAAFb_KwtfPFU
    "amount":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "code":
    string
    Readonly | The used promotion code. | Example: Intershop
    "promotion":
    string
    Readonly | The promotion id. | Example: FreeShippingOnLEDTVs
    }
  }
- "product":
  object
  {
  - "":
    object
    A OrderProductRO_v1 object. A sellable entity that is offered to a customer.
    {
    "available":
    boolean
    Readonly | Checks if the product is available to be ordered. | Example: true
    "inStock":
    boolean
    Readonly | Gets the product inventory status. | Example: true
    "longDescription":
    string
    Readonly | The product's long description. | Example: Looking for an easy-to-use camera that's easy on your budget? You'll love the KODAK EASYSHARE C142 Digital Camera. With Kodak�s Smart Capture feature, brilliant pictures happen automatically. No worries. No hassles. Just beautiful pictures. And because it�s from Kodak, your memories will be as vivid as the moment they happened. If you want an affordable camera you'll feel good about, look to the name you know and trust. Whether it�s for you, or a gift for someone else, the C142 Camera is the perfect fit for sharing your memories. One-button upload�turn moments into memories - Snap your picture. - Press the Share button and tag it to YouTube, FACEBOOK, FLICKR and KODAK Gallery sites, plus e-mail too. - Connect your camera to your computer, and with Kodak's Share button app, your pictures are automatically uploaded. - Your pictures and videos are automatically transferred to your computer. KODAK EASYSHARE Software The complete solution for transferring, online sharing, e-mailing, organizing, editing, and creative printing of your pictures. - Organize your pictures with your own tags, star ratings, and date and time stamps, then use the search feature to quickly find any picture in your collection. - Edit your pictures with ease'select from a variety of simple tools that reduce red-eye, improve lighting, remove wrinkles and blemishes, and add text. - Create photo projects online or at home'choose from hundreds of templates and designs to create album pages, cards, invitations and much more. - Manually upload to YouTube, FACEBOOK, FLICKR and KODAK Gallery sites, plus e-mail too. Exceptional quality prints with 10 MP - 10 MP means you can make stunning prints up to 76 x 102 cm (30 ' 40 in.). - More megapixels means you can crop and enlarge and still have great picture quality. - However you choose to print'at home, at retail, or online'trust Kodak for picture quality that's truly exceptional and for memories that will last. 3X digital zoom lens - 3X optical zoom (35 mm equivalent: 35'102 mm) gets you closer to your subjects without reducing image quality. - The KODAK AF Optical Zoom Lens captures crisp details. - Zoom in close and capture all the details.
    "name":
    string
    Readonly | The name of an element. | Example: InTRONICS IS-25Y Portable
    "productBundle":
    boolean
    Readonly | Checks if the product is a product bundle. | Example: false
    "shortDescription":
    string
    Readonly | The product's short description. | Example: EasyShare C142, 10.3Mp, 1/ 6.35 cm (2.5 \") CCD, 3x opt, SD/SDHC, USB 2.0
    "sku":
    string
    Readonly | The stock keeping unit (SKU) of the product. | Example: 5079747
    "variationProduct":
    boolean
    Readonly | Checks if the product is a variation product. | Example: true
    }
  }
- "shipToAddress":
  object
  {
  - "":
    object
    A AddressRO_v1 object. The address
    {
    "addressLine1":
    string
    The first address line, that usual contains street and house number. | Example: Berliner Str. 20
    "addressLine2":
    string
    The second address line.
    "addressLine3":
    string
    The third address line.
    "aristocraticTitle":
    string
    The aristocratic title of the contact person, like 'Lord' or 'Lady'.
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "city":
    string
    The name of the city. | Example: Potsdam
    "companyName1":
    string
    The company name in case it is a business address. | Example: Intershop Communications AG
    "companyName2":
    string
    The second company name
    "country":
    string
    Readonly | The localized display name of the country | Example: Germany
    "countryCode":
    string
    The ISO 3166-1 country code | Example: DE
    "customer":
    string
    "eligibleInstallToAddress":
    boolean
    Flag indicating that the address can be used as install-to address. | Example: false
    "eligibleInvoiceToAddress":
    boolean
    Flag indicating that the address can be used as invoice-to address. | Example: true
    "eligibleServiceToAddress":
    boolean
    Flag indicating that the address can be used as service-to address. | Example: false
    "eligibleShipFromAddress":
    boolean
    Flag indicating that the address can be used as ship-from address. | Example: false
    "eligibleShipToAddress":
    boolean
    Flag indicating that the address can be used as ship-to address. | Example: true
    "email":
    string
    The e-mail address of the contact person. | Example: patricia@test.intershop.de
    "externalId":
    string
    The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
    "externalUrn":
    string
    The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
    "fax":
    string
    The fax number.
    "firstName":
    string
    The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
    "honorific":
    string
    The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
    "id":
    string
    The ID that identifies the address. | Example: 0987654321
    "jobTitle":
    string
    The job title of the contact person.
    "lastName":
    string
    The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
    "mainDivision":
    string
    Readonly | The localized display name of the main division | Example: Alabama
    "mainDivisionCode":
    string
    The main division code of the country, e. g. a state or province. | Example: Al
    "phoneBusiness":
    string
    The phone number of the contact person's company.
    "phoneBusinessDirect":
    string
    The business phone number of the contact person that allows an outside caller to connect directly to the
    contact person without any help of an attendant or operator.
    "phoneHome":
    string
    The phone number of the house or apartment where the contact person lives. | Example: 049364112677
    "phoneMobile":
    string
    The number of the contact person's cell phone.
    "postBox":
    string
    The post-office box.
    "postalCode":
    string
    The postal code of the city. | Example: 14482
    "secondLastName":
    string
    The second last name of the contact person.
    "secondName":
    string
    The second given name of the contact person.
    "subDivision":
    string
    Readonly | The localized display name of the sub division. | Example: City of Westminster
    "subDivisionCode":
    string
    The sub division code. | Example: 020
    "title":
    string
    The (personal) title of the contact person. | Example: Ms.
    "urn":
    string
    The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
    "usage":
    object
    The usage information for the address. Every bit in the returned set marks a specific usage type: [invoice-to, ship-to, ship-from, service-to, install-to]. If a bit is set, the address may be used for the specific purpose mapped to this bit. By default, all values are set to true.
    {
    "empty":
    boolean
    }
    }
  }
- "shippingMethod":
  object
  {
  - "":
    object
    A OrderShippingMethodRO_v1 object. Describes a shipping method that has been selected as delivery option.
    {
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "deliveryTimeMax":
    object
    Readonly | The maximum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P7D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "deliveryTimeMin":
    object
    Readonly | The minimum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P3D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "description":
    string
    Readonly | The shipping method's localized description. | Example: Delivered to you 3-7 business days after we process your order.
    "digitalDelivery":
    boolean
    Readonly | Whether this shipping method is a digital delivery method (e. g. for e-mail delivery).
    "id":
    string
    Readonly | The shipping method's unique identifier. | Example: STD_GROUND
    "name":
    string
    Readonly | The name of an element. | Example: Standard Ground
    "shippingCosts":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "shortName":
    string
    Readonly | The shipping method's localized short Name. | Example: Int'l Express Delivery.
    }
  }
- "warranty":
  object
  {
  - "":
    object
    A OrderWarrantyRO_v1 object. Describes a warranty assigned to the line item.
    {
    "product":
    string
    Required | Readonly | The Product representing the gift wrap.
    "price":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    }
  }
}
"infos":
array
Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.

}

OrderListCtnrRO_v1 application/json

{

"data":
array
An array of OrderRO_v1 objects. The core data of the response object.
[
OrderRO_v1: A representation of an order
{
- "affiliatePartner":
  string
  Readonly | The affiliate partner id of the order. | Example: 4bcKAB2Ykg4AAAFbjvEYRPJ7
- "affiliateProgram":
  string
  Readonly | The affiliate program id of the order. | Example: uzMKAB2YvKAAAAFb7DUYRPJ8
- "attributes":
  array
  An array of AttributeRO_v1 objects.
  [
  AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
  {
  "name":
  string
  Required | The name of an element.
  "type":
  string
  Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
  "value":
  object
  }
  ]
- "basket":
  string
  Required | The basket (ID) which this order is created from. | Example: b45KeTsBizQBBBFjXFAA6S15
- "buckets":
  array
  Readonly | An array of string literals. The bucket ids of all shipping buckets of an order.
- "buyingContext":
  string
  Readonly | The buying context group identifier of the order. | Example: OilCorp_Germany
- "commonShipToAddress":
  string
  Readonly | The common ship-to address URN of the order. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
- "commonShippingMethod":
  string
  Readonly | The common shipping method id of the order. | Example: STD_5DAY
- "costCenter":
  string
  Readonly | The cost center id of the order. | Example: 511288
- "creationDate":
  string
  Readonly | The creation date of the order. | Format: date-time | Example: 2019-06-30T11:23:45.000Z
- "customer":
  string
  Readonly | The order owner customer number.
- "department":
  string
  Readonly | The department name of the order. | Example: SALES
- "discounts":
  object
  A OrderDiscountsRO_v1 object. Provides details about the applied discounts.
  {
  "freeGiftDiscounts":
  array
  Readonly | An array of string literals. The IDs of all free gift discounts granted on the order.
  "shippingBasedDiscounts":
  array
  Readonly | An array of string literals. The IDs of all discounts granted on shipping and handling costs.
  "valueBasedDiscounts":
  array
  Readonly | An array of string literals. The IDs of all discounts granted on the order total.
  }
- "documentNumber":
  string
  Readonly | The document number of the order.
- "externalOrderReference":
  string
  Readonly | The external order reference id of the order. | Example: 30000008899
- "id":
  string
  Readonly | The ID of the order. | Example: q2QKAEsBiyQAAAFjXFBB6G14
- "invoiceToAddress":
  string
  Readonly | The invoice-to address URN of the order. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
- "lineItems":
  array
  Readonly | An array of string literals. The IDs of all line items of an order.
- "messageToMerchant":
  string
  Readonly | Something what the buyer would like to tell the merchant. | Example: Is it possible to send the ordered articles before Christmas?
- "orderCreation":
  object
  A OrderCreationRO_v1 object. A resource object containing data about an ongoing order creation process. Includes information about the status of the order creation and whether additional actions need to be performed before the order creation is finished (e. g. redirects to payment providers).
  {
  "redirect":
  object
  A PaymentRedirectRO_v1 object. Describes a payment redirect. Note: Beta version - This class can still be subject of change!
  {
  "cancelUrl":
  string
  Required | The URL to be called when the user cancelled payment and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/cancel?paymentID=*paymentID*
  "failureUrl":
  string
  Required | The URL to be called when the payment failed and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/failure
  "parameters":
  array
  An array of ParameterRO_v1 objects. List of parameters returned in the redirect response from the PSP.
  [
  ParameterRO_v1: A representation of a parameter value.
  {
  "name":
  string
  The name of an element. | Example: expiryDate
  "value":
  object
  The value of the parameter. | Example: 12/30
  }
  ]
  "redirectUrl":
  string
  Readonly | The URL to be called when redirecting the user to the payment providers page. | Format: uri | Example: https://psp-server/pay
  "status":
  string
  The final status of the redirect returned to the shop. | Example: SUCCESS | Possible Values: SUCCESSCANCELFAILURE
  "successUrl":
  string
  Required | The URL to be called on successful payment redirect back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/success?orderID=*orderID*
  }
  "status":
  string
  Represents the status of the order creation process. If this returns "COMPLETED", then the order creation is finished. If this returns "ROLLED_BACK", then the order creation was unsuccessful (e. g. because of a failed or cancelled payment) and the order is rolled back and becomes inaccessible. If this returns "STOPPED", then the client needs to perform the action from the "stopAction" field first. Once done, the order creation can be continued by setting this to "CONTINUE". Passing other values than "CONTINUE" will result in an error. | Possible Values: COMPLETEDSTOPPEDROLLED_BACKCONTINUE
  "stopAction":
  object
  A StopActionRO_v1 object. A representation of a stop action. A stop action is an action that needs to be performed before a certain process (e. g. creation of an order) can be continued.
  {
  "type":
  string
  Required | Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  }
  }
- "payments":
  array
  Readonly | An array of string literals. The payments used to pay the order.
- "promotionCodes":
  array
  Readonly | An array of string literals. The promotion codes of the order.
- "purchaseCurrency":
  string
  Readonly | The purchase currency of the order. | Example: USD
- "recurringOrderDocumentNo":
  string
  Readonly | The recurring order number.
- "requisitionDocumentNo":
  string
  Readonly | The requisition documentnumber. | Example: 00001052
- "status":
  string
  Readonly | The localized display name of the order status. | Example: in progress
- "statusCode":
  string
  Readonly | The status code of the order. | Example: INPROGRESS
- "surcharges":
  object
  A OrderSurchargesRO_v1 object. Surcharges that are applied to an order.
  {
  "bucketSurcharges":
  array
  Readonly | An array of OrderSurchargeRO_v1 objects. All bucket based extra charges arising from surcharges with action type 'bucket'.
  [
  OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
  {
  "amount":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "name":
  string
  Readonly | The name of an element. | Example: Fridge Box
  "description":
  string
  Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
  "taxes":
  array
  Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
  }
  ]
  "itemSurcharges":
  array
  Readonly | An array of OrderSurchargeRO_v1 objects. All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item'.
  [
  OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
  {
  "amount":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "name":
  string
  Readonly | The name of an element. | Example: Fridge Box
  "description":
  string
  Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
  "taxes":
  array
  Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
  }
  ]
  }
- "taxIdentificationNumber":
  string
  Readonly | The tax identification number of the buyer/company. | Example: 11111111
- "termsAndConditionsAccepted":
  boolean
  Required | Flag for specifying whether the terms and conditions have been accepted. A value of 'false' will cause the order creation to fail.
- "totalProductQuantity":
  number
  Readonly | The sum of all quantities of products in the order. | Example: 23
- "totals":
  object
  A OrderTotalsRO_v1 object. Total price values for an order.
  {
  "grandTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "paymentCostsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "undiscountedItemTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "undiscountedShippingTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "bucketShippingDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "discountTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "giftingTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "itemShippingDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "itemTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "itemValueDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "orderShippingDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "orderValueDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "salesTaxTotalsByTaxRate":
  array
  Readonly | An array of TaxItemRO_v1 objects. All sales taxes applied to the order, accumulated by their tax rates.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
  "shippingDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "shippingTaxTotalsByTaxRate":
  array
  Readonly | An array of TaxItemRO_v1 objects. All shipping taxes applied to the order, accumulated by their tax rates.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
  "shippingTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "surchargeTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "taxTotalsByTaxRate":
  array
  Readonly | An array of TaxItemRO_v1 objects. All taxes applied to the order, accumulated by their tax rates (includes taxes levied to sales, prices, shipping and surcharges.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
  "valueDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  }
- "user":
  string
  Readonly | The order owner user login.
}
]
"errors":
array
Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Readonly | Optionally included related data objects. Included via "include" query parameter.
{
- "lineItems":
  object
  {
  - "":
    object
    A OrderLineItemRO_v1 object. Describes a line item that is part of an order.
    {
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "description":
    string
    Readonly | The description for the product line item. | Example: 20
    "desiredDelivery":
    string
    Readonly | The desired delivery date for the Item. | Format: date | Example: 2001-07-04T00:00:00.000Z
    "discounts":
    array
    Readonly | An array of string literals. The IDs of the discounts applied to the item pricing.
    "displayName":
    string
    Readonly | The display name of the product line item. | Example: Acer C20 silver edition
    "freeGift":
    boolean
    Readonly | Flag indicating that this product line item is a free gift and has been automatically placed in the line item container. | Example: false
    "fulfillmentStatus":
    string
    Readonly | The fulfillment status of this line item. | Example: NEW
    "giftMessage":
    string
    Readonly | Additional gift message for this the line item.
    "giftWrap":
    string
    Readonly | Additional gift wrapping for this the line item.
    "hiddenGift":
    boolean
    Readonly | Flag indicating that this product line item is a free gift, that will not be displayed in line item container. | Example: false
    "id":
    string
    Readonly | The line item's unique identifier.
    "order":
    string
    Readonly | The order this line item belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
    "position":
    integer
    Readonly | The position of the item in the order. | Format: int32
    "pricing":
    object
    A OrderLineItemPricingRO_v1 object. total price values of a line item
    {
    "giftingTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "price":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "salesTaxTotal":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "shippingRebatesTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "shippingTaxTotal":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "singleBasePrice":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "undiscountedPrice":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "undiscountedShippingTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "undiscountedSingleBasePrice":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "valueRebatesTotal":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    }
    "product":
    string
    Required | Readonly | The product represented as stock keeping unit (SKU). | Example: 5079747
    "quantity":
    object
    Required | A QuantityRO_v1 object. A quantity of a business entity.
    {
    "unit":
    string
    The quantity's unit code. | Example: kg
    "value":
    number
    Required | The quantity's value. | Example: 10
    }
    "quote":
    string
    Readonly | The quote this item was created from. | Example: Qu0T3MgoyuMAx9Es2sx0Ue1
    "shipToAddress":
    string
    Readonly | The ship-to address URN for this line item. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
    "shippingMethod":
    string
    Readonly | The shipping method id for this line item. | Example: STD_5DAY
    "surcharges":
    array
    Readonly | An array of OrderSurchargeRO_v1 objects. Details about additional surcharges applied to the item.
    [
    OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
    {
    "amount":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "name":
    string
    Readonly | The name of an element. | Example: Fridge Box
    "description":
    string
    Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
    "taxes":
    array
    Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
    [
    TaxItemRO_v1: Represents a single tax item.
    {
    "calculatedTax":
    object
    Required | A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "effectiveTaxRate":
    number
    Required | The effective rate used to calculate the tax.
    "jurisdiction":
    object
    A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
    {
    "id":
    string
    The jurisdiction ID. | Example: CANADA
    "level":
    string
    The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
    }
    "nonTaxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "situs":
    string
    Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
    "taxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    ]
    }
    ]
    "thumbnail":
    string
    Readonly | The thumbnail uri of the Product. | Example: /INTERSHOP/static/WFS/inSPIRED-inTRONICS-Site/-/inSPIRED/en_US/M/3957288-5427.jpg
    "warranty":
    string
    Readonly | A warranty assigned to the line item.
    }
  }
- "buckets":
  object
  {
  - "":
    object
    A OrderShippingBucketRO_v1 object. Describes a shipping bucket.
    {
    "deliveryTimeMax":
    object
    Readonly | The maximum time the delivery will take based on the chosen shipping method (in ISO-8601 period format). | Example: P7D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "deliveryTimeMin":
    object
    Readonly | The minimum time the delivery will take based on the chosen shipping method (in ISO-8601 period format). | Example: P3D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "discounts":
    array
    Readonly | An array of string literals. The IDs of the discounts applied to the bucket totals.
    "id":
    string
    Readonly | The ID of the bucket. | Example: 54489489212
    "lineItems":
    array
    Readonly | An array of string literals. The ids of all line items which are associated with this bucket.
    "order":
    string
    Readonly | The order this shipping bucket belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
    "shipToAddress":
    string
    Readonly | The ship-to address URN for this bucket. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
    "shippingCosts":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "shippingMethod":
    string
    Readonly | The shipping method id for this bucket. | Example: STD_5DAY
    "surcharges":
    array
    Readonly | An array of OrderSurchargeRO_v1 objects. All extra charges arising from surcharges directly specified on product or by shipping rules with action type 'bucket'.
    [
    OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
    {
    "amount":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "name":
    string
    Readonly | The name of an element. | Example: Fridge Box
    "description":
    string
    Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
    "taxes":
    array
    Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
    [
    TaxItemRO_v1: Represents a single tax item.
    {
    "calculatedTax":
    object
    Required | A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "effectiveTaxRate":
    number
    Required | The effective rate used to calculate the tax.
    "jurisdiction":
    object
    A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
    {
    "id":
    string
    The jurisdiction ID. | Example: CANADA
    "level":
    string
    The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
    }
    "nonTaxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "situs":
    string
    Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
    "taxableAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    ]
    }
    ]
    }
  }
- "discounts":
  object
  {
  - "":
    object
    A OrderDiscountRO_v1 object. Describes a discount arising from an applied promotion.
    {
    "id":
    string
    Required | Readonly | The ID of the promotion that triggered the discount. | Example: 92YKAM6dZtIAAAFb_KwtfPFU
    "amount":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "code":
    string
    Readonly | The used promotion code. | Example: Intershop
    "promotion":
    string
    Readonly | The promotion id. | Example: FreeShippingOnLEDTVs
    }
  }
- "invoiceToAddress":
  object
  {
  - "":
    object
    A AddressRO_v1 object. The address
    {
    "addressLine1":
    string
    The first address line, that usual contains street and house number. | Example: Berliner Str. 20
    "addressLine2":
    string
    The second address line.
    "addressLine3":
    string
    The third address line.
    "aristocraticTitle":
    string
    The aristocratic title of the contact person, like 'Lord' or 'Lady'.
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "city":
    string
    The name of the city. | Example: Potsdam
    "companyName1":
    string
    The company name in case it is a business address. | Example: Intershop Communications AG
    "companyName2":
    string
    The second company name
    "country":
    string
    Readonly | The localized display name of the country | Example: Germany
    "countryCode":
    string
    The ISO 3166-1 country code | Example: DE
    "customer":
    string
    "eligibleInstallToAddress":
    boolean
    Flag indicating that the address can be used as install-to address. | Example: false
    "eligibleInvoiceToAddress":
    boolean
    Flag indicating that the address can be used as invoice-to address. | Example: true
    "eligibleServiceToAddress":
    boolean
    Flag indicating that the address can be used as service-to address. | Example: false
    "eligibleShipFromAddress":
    boolean
    Flag indicating that the address can be used as ship-from address. | Example: false
    "eligibleShipToAddress":
    boolean
    Flag indicating that the address can be used as ship-to address. | Example: true
    "email":
    string
    The e-mail address of the contact person. | Example: patricia@test.intershop.de
    "externalId":
    string
    The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
    "externalUrn":
    string
    The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
    "fax":
    string
    The fax number.
    "firstName":
    string
    The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
    "honorific":
    string
    The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
    "id":
    string
    The ID that identifies the address. | Example: 0987654321
    "jobTitle":
    string
    The job title of the contact person.
    "lastName":
    string
    The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
    "mainDivision":
    string
    Readonly | The localized display name of the main division | Example: Alabama
    "mainDivisionCode":
    string
    The main division code of the country, e. g. a state or province. | Example: Al
    "phoneBusiness":
    string
    The phone number of the contact person's company.
    "phoneBusinessDirect":
    string
    The business phone number of the contact person that allows an outside caller to connect directly to the
    contact person without any help of an attendant or operator.
    "phoneHome":
    string
    The phone number of the house or apartment where the contact person lives. | Example: 049364112677
    "phoneMobile":
    string
    The number of the contact person's cell phone.
    "postBox":
    string
    The post-office box.
    "postalCode":
    string
    The postal code of the city. | Example: 14482
    "secondLastName":
    string
    The second last name of the contact person.
    "secondName":
    string
    The second given name of the contact person.
    "subDivision":
    string
    Readonly | The localized display name of the sub division. | Example: City of Westminster
    "subDivisionCode":
    string
    The sub division code. | Example: 020
    "title":
    string
    The (personal) title of the contact person. | Example: Ms.
    "urn":
    string
    The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
    "usage":
    object
    The usage information for the address. Every bit in the returned set marks a specific usage type: [invoice-to, ship-to, ship-from, service-to, install-to]. If a bit is set, the address may be used for the specific purpose mapped to this bit. By default, all values are set to true.
    {
    "empty":
    boolean
    }
    }
  }
- "commonShipToAddress":
  object
  {
  - "":
    object
    A AddressRO_v1 object. The address
    {
    "addressLine1":
    string
    The first address line, that usual contains street and house number. | Example: Berliner Str. 20
    "addressLine2":
    string
    The second address line.
    "addressLine3":
    string
    The third address line.
    "aristocraticTitle":
    string
    The aristocratic title of the contact person, like 'Lord' or 'Lady'.
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "city":
    string
    The name of the city. | Example: Potsdam
    "companyName1":
    string
    The company name in case it is a business address. | Example: Intershop Communications AG
    "companyName2":
    string
    The second company name
    "country":
    string
    Readonly | The localized display name of the country | Example: Germany
    "countryCode":
    string
    The ISO 3166-1 country code | Example: DE
    "customer":
    string
    "eligibleInstallToAddress":
    boolean
    Flag indicating that the address can be used as install-to address. | Example: false
    "eligibleInvoiceToAddress":
    boolean
    Flag indicating that the address can be used as invoice-to address. | Example: true
    "eligibleServiceToAddress":
    boolean
    Flag indicating that the address can be used as service-to address. | Example: false
    "eligibleShipFromAddress":
    boolean
    Flag indicating that the address can be used as ship-from address. | Example: false
    "eligibleShipToAddress":
    boolean
    Flag indicating that the address can be used as ship-to address. | Example: true
    "email":
    string
    The e-mail address of the contact person. | Example: patricia@test.intershop.de
    "externalId":
    string
    The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
    "externalUrn":
    string
    The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
    "fax":
    string
    The fax number.
    "firstName":
    string
    The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
    "honorific":
    string
    The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
    "id":
    string
    The ID that identifies the address. | Example: 0987654321
    "jobTitle":
    string
    The job title of the contact person.
    "lastName":
    string
    The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
    "mainDivision":
    string
    Readonly | The localized display name of the main division | Example: Alabama
    "mainDivisionCode":
    string
    The main division code of the country, e. g. a state or province. | Example: Al
    "phoneBusiness":
    string
    The phone number of the contact person's company.
    "phoneBusinessDirect":
    string
    The business phone number of the contact person that allows an outside caller to connect directly to the
    contact person without any help of an attendant or operator.
    "phoneHome":
    string
    The phone number of the house or apartment where the contact person lives. | Example: 049364112677
    "phoneMobile":
    string
    The number of the contact person's cell phone.
    "postBox":
    string
    The post-office box.
    "postalCode":
    string
    The postal code of the city. | Example: 14482
    "secondLastName":
    string
    The second last name of the contact person.
    "secondName":
    string
    The second given name of the contact person.
    "subDivision":
    string
    Readonly | The localized display name of the sub division. | Example: City of Westminster
    "subDivisionCode":
    string
    The sub division code. | Example: 020
    "title":
    string
    The (personal) title of the contact person. | Example: Ms.
    "urn":
    string
    The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
    "usage":
    object
    The usage information for the address. Every bit in the returned set marks a specific usage type: [invoice-to, ship-to, ship-from, service-to, install-to]. If a bit is set, the address may be used for the specific purpose mapped to this bit. By default, all values are set to true.
    {
    "empty":
    boolean
    }
    }
  }
- "commonShippingMethod":
  object
  {
  - "":
    object
    A OrderShippingMethodRO_v1 object. Describes a shipping method that has been selected as delivery option.
    {
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "deliveryTimeMax":
    object
    Readonly | The maximum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P7D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "deliveryTimeMin":
    object
    Readonly | The minimum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P3D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "description":
    string
    Readonly | The shipping method's localized description. | Example: Delivered to you 3-7 business days after we process your order.
    "digitalDelivery":
    boolean
    Readonly | Whether this shipping method is a digital delivery method (e. g. for e-mail delivery).
    "id":
    string
    Readonly | The shipping method's unique identifier. | Example: STD_GROUND
    "name":
    string
    Readonly | The name of an element. | Example: Standard Ground
    "shippingCosts":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "shortName":
    string
    Readonly | The shipping method's localized short Name. | Example: Int'l Express Delivery.
    }
  }
- "payments":
  object
  {
  - "":
    object
    A PaymentRO_v1 object. A payment assigned to the basket/order to pay the bill with.
    {
    "baseAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "id":
    string
    Readonly | The ID of the payment. | Example: AAFjXFq2QKAEsBiyQABB6G14
    "openTender":
    boolean
    Readonly | Whether or not the payment is an 'open-tender' payment.
    "paymentCosts":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "paymentInstrument":
    string
    Required | The reference to the payment instrument that was selected for this payment. | Example: c2UKAEsBar8AAAFmxYVBTOiI
    "paymentMethod":
    string
    Readonly | The reference to the payment method that was used for this payment. | Example: ISH_INVOICE
    "redirect":
    object
    A PaymentRedirectRO_v1 object. Describes a payment redirect. Note: Beta version - This class can still be subject of change!
    {
    "cancelUrl":
    string
    Required | The URL to be called when the user cancelled payment and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/cancel?paymentID=*paymentID*
    "failureUrl":
    string
    Required | The URL to be called when the payment failed and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/failure
    "parameters":
    array
    An array of ParameterRO_v1 objects. List of parameters returned in the redirect response from the PSP.
    [
    ParameterRO_v1: A representation of a parameter value.
    {
    "name":
    string
    The name of an element. | Example: expiryDate
    "value":
    object
    The value of the parameter. | Example: 12/30
    }
    ]
    "redirectUrl":
    string
    Readonly | The URL to be called when redirecting the user to the payment providers page. | Format: uri | Example: https://psp-server/pay
    "status":
    string
    The final status of the redirect returned to the shop. | Example: SUCCESS | Possible Values: SUCCESSCANCELFAILURE
    "successUrl":
    string
    Required | The URL to be called on successful payment redirect back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/success?orderID=*orderID*
    }
    "redirectRequired":
    boolean
    Readonly | Whether or not a redirect is required to finish the payment. The type of redirect (before or after the checkout process) can be determined via the capabilities of the payment method.
    "status":
    string
    Readonly | The localized display name of the payment status. | Example: Partially captured
    "totalAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
  }
- "buyingContext":
  object
  {
  - "":
    object
    A BuyingContextRO_v1 object. Provides details about the buying context.
    {
    "groupPath":
    array
    Readonly | An array of string literals. The hierarchy path from the root to the selected group. | Example: [OilCorp, OilCorp_EMEA, OilCorp_Germany]
    "id":
    string
    Readonly | The group identifier of the buying context. | Example: OilCorp_Germany
    }
  }
}
"infos":
array
Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.

}

OrderRO_v1 application/json

{

"affiliatePartner":
string
Readonly | The affiliate partner id of the order. | Example: 4bcKAB2Ykg4AAAFbjvEYRPJ7
"affiliateProgram":
string
Readonly | The affiliate program id of the order. | Example: uzMKAB2YvKAAAAFb7DUYRPJ8
"attributes":
array
An array of AttributeRO_v1 objects.
[
AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
{
- "name":
  string
  Required | The name of an element.
- "type":
  string
  Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
- "value":
  object
}
]
"basket":
string
Required | The basket (ID) which this order is created from. | Example: b45KeTsBizQBBBFjXFAA6S15
"buckets":
array
Readonly | An array of string literals. The bucket ids of all shipping buckets of an order.
"buyingContext":
string
Readonly | The buying context group identifier of the order. | Example: OilCorp_Germany
"commonShipToAddress":
string
Readonly | The common ship-to address URN of the order. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
"commonShippingMethod":
string
Readonly | The common shipping method id of the order. | Example: STD_5DAY
"costCenter":
string
Readonly | The cost center id of the order. | Example: 511288
"creationDate":
string
Readonly | The creation date of the order. | Format: date-time | Example: 2019-06-30T11:23:45.000Z
"customer":
string
Readonly | The order owner customer number.
"department":
string
Readonly | The department name of the order. | Example: SALES
"discounts":
object
A OrderDiscountsRO_v1 object. Provides details about the applied discounts.
{
- "freeGiftDiscounts":
  array
  Readonly | An array of string literals. The IDs of all free gift discounts granted on the order.
- "shippingBasedDiscounts":
  array
  Readonly | An array of string literals. The IDs of all discounts granted on shipping and handling costs.
- "valueBasedDiscounts":
  array
  Readonly | An array of string literals. The IDs of all discounts granted on the order total.
}
"documentNumber":
string
Readonly | The document number of the order.
"externalOrderReference":
string
Readonly | The external order reference id of the order. | Example: 30000008899
"id":
string
Readonly | The ID of the order. | Example: q2QKAEsBiyQAAAFjXFBB6G14
"invoiceToAddress":
string
Readonly | The invoice-to address URN of the order. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
"lineItems":
array
Readonly | An array of string literals. The IDs of all line items of an order.
"messageToMerchant":
string
Readonly | Something what the buyer would like to tell the merchant. | Example: Is it possible to send the ordered articles before Christmas?
"orderCreation":
object
A OrderCreationRO_v1 object. A resource object containing data about an ongoing order creation process. Includes information about the status of the order creation and whether additional actions need to be performed before the order creation is finished (e. g. redirects to payment providers).
{
- "redirect":
  object
  A PaymentRedirectRO_v1 object. Describes a payment redirect. Note: Beta version - This class can still be subject of change!
  {
  - "cancelUrl":
    string
    Required | The URL to be called when the user cancelled payment and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/cancel?paymentID=*paymentID*
  - "failureUrl":
    string
    Required | The URL to be called when the payment failed and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/failure
  - "parameters":
    array
    An array of ParameterRO_v1 objects. List of parameters returned in the redirect response from the PSP.
    [
    ParameterRO_v1: A representation of a parameter value.
    {
    "name":
    string
    The name of an element. | Example: expiryDate
    "value":
    object
    The value of the parameter. | Example: 12/30
    }
    ]
  - "redirectUrl":
    string
    Readonly | The URL to be called when redirecting the user to the payment providers page. | Format: uri | Example: https://psp-server/pay
  - "status":
    string
    The final status of the redirect returned to the shop. | Example: SUCCESS | Possible Values: SUCCESSCANCELFAILURE
  - "successUrl":
    string
    Required | The URL to be called on successful payment redirect back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/success?orderID=*orderID*
  }
- "status":
  string
  Represents the status of the order creation process. If this returns "COMPLETED", then the order creation is finished. If this returns "ROLLED_BACK", then the order creation was unsuccessful (e. g. because of a failed or cancelled payment) and the order is rolled back and becomes inaccessible. If this returns "STOPPED", then the client needs to perform the action from the "stopAction" field first. Once done, the order creation can be continued by setting this to "CONTINUE". Passing other values than "CONTINUE" will result in an error. | Possible Values: COMPLETEDSTOPPEDROLLED_BACKCONTINUE
- "stopAction":
  object
  A StopActionRO_v1 object. A representation of a stop action. A stop action is an action that needs to be performed before a certain process (e. g. creation of an order) can be continued.
  {
  - "type":
    string
    Required | Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  }
}
"payments":
array
Readonly | An array of string literals. The payments used to pay the order.
"promotionCodes":
array
Readonly | An array of string literals. The promotion codes of the order.
"purchaseCurrency":
string
Readonly | The purchase currency of the order. | Example: USD
"recurringOrderDocumentNo":
string
Readonly | The recurring order number.
"requisitionDocumentNo":
string
Readonly | The requisition documentnumber. | Example: 00001052
"status":
string
Readonly | The localized display name of the order status. | Example: in progress
"statusCode":
string
Readonly | The status code of the order. | Example: INPROGRESS
"surcharges":
object
A OrderSurchargesRO_v1 object. Surcharges that are applied to an order.
{
- "bucketSurcharges":
  array
  Readonly | An array of OrderSurchargeRO_v1 objects. All bucket based extra charges arising from surcharges with action type 'bucket'.
  [
  OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
  {
  "amount":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "name":
  string
  Readonly | The name of an element. | Example: Fridge Box
  "description":
  string
  Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
  "taxes":
  array
  Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
  }
  ]
- "itemSurcharges":
  array
  Readonly | An array of OrderSurchargeRO_v1 objects. All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item'.
  [
  OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
  {
  "amount":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "name":
  string
  Readonly | The name of an element. | Example: Fridge Box
  "description":
  string
  Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
  "taxes":
  array
  Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
  }
  ]
}
"taxIdentificationNumber":
string
Readonly | The tax identification number of the buyer/company. | Example: 11111111
"termsAndConditionsAccepted":
boolean
Required | Flag for specifying whether the terms and conditions have been accepted. A value of 'false' will cause the order creation to fail.
"totalProductQuantity":
number
Readonly | The sum of all quantities of products in the order. | Example: 23
"totals":
object
A OrderTotalsRO_v1 object. Total price values for an order.
{
- "grandTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "paymentCostsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "undiscountedItemTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "undiscountedShippingTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "bucketShippingDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "discountTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "giftingTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "itemShippingDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "itemTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "itemValueDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "orderShippingDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "orderValueDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "salesTaxTotalsByTaxRate":
  array
  Readonly | An array of TaxItemRO_v1 objects. All sales taxes applied to the order, accumulated by their tax rates.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
- "shippingDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "shippingTaxTotalsByTaxRate":
  array
  Readonly | An array of TaxItemRO_v1 objects. All shipping taxes applied to the order, accumulated by their tax rates.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
- "shippingTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "surchargeTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "taxTotalsByTaxRate":
  array
  Readonly | An array of TaxItemRO_v1 objects. All taxes applied to the order, accumulated by their tax rates (includes taxes levied to sales, prices, shipping and surcharges.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
- "valueDiscountsTotal":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
}
"user":
string
Readonly | The order owner user login.

}

OrderShippingBucketCtnrRO_v1 application/json

{

"data":
object
A OrderShippingBucketRO_v1 object. Describes a shipping bucket.
{
- "deliveryTimeMax":
  object
  Readonly | The maximum time the delivery will take based on the chosen shipping method (in ISO-8601 period format). | Example: P7D
  {
  - "years":
    integer
    Format: int32
  - "months":
    integer
    Format: int32
  - "days":
    integer
    Format: int32
  - "zero":
    boolean
  - "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
  - "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
  - "negative":
    boolean
  }
- "deliveryTimeMin":
  object
  Readonly | The minimum time the delivery will take based on the chosen shipping method (in ISO-8601 period format). | Example: P3D
  {
  - "years":
    integer
    Format: int32
  - "months":
    integer
    Format: int32
  - "days":
    integer
    Format: int32
  - "zero":
    boolean
  - "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
  - "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
  - "negative":
    boolean
  }
- "discounts":
  array
  Readonly | An array of string literals. The IDs of the discounts applied to the bucket totals.
- "id":
  string
  Readonly | The ID of the bucket. | Example: 54489489212
- "lineItems":
  array
  Readonly | An array of string literals. The ids of all line items which are associated with this bucket.
- "order":
  string
  Readonly | The order this shipping bucket belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
- "shipToAddress":
  string
  Readonly | The ship-to address URN for this bucket. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
- "shippingCosts":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "shippingMethod":
  string
  Readonly | The shipping method id for this bucket. | Example: STD_5DAY
- "surcharges":
  array
  Readonly | An array of OrderSurchargeRO_v1 objects. All extra charges arising from surcharges directly specified on product or by shipping rules with action type 'bucket'.
  [
  OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
  {
  "amount":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "name":
  string
  Readonly | The name of an element. | Example: Fridge Box
  "description":
  string
  Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
  "taxes":
  array
  Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
  }
  ]
}
"errors":
array
Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Readonly | Optionally included related data objects. Included via "include" query parameter.
{
- "discounts":
  object
  {
  - "":
    object
    A OrderDiscountRO_v1 object. Describes a discount arising from an applied promotion.
    {
    "id":
    string
    Required | Readonly | The ID of the promotion that triggered the discount. | Example: 92YKAM6dZtIAAAFb_KwtfPFU
    "amount":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "code":
    string
    Readonly | The used promotion code. | Example: Intershop
    "promotion":
    string
    Readonly | The promotion id. | Example: FreeShippingOnLEDTVs
    }
  }
- "shipToAddress":
  object
  {
  - "":
    object
    A AddressRO_v1 object. The address
    {
    "addressLine1":
    string
    The first address line, that usual contains street and house number. | Example: Berliner Str. 20
    "addressLine2":
    string
    The second address line.
    "addressLine3":
    string
    The third address line.
    "aristocraticTitle":
    string
    The aristocratic title of the contact person, like 'Lord' or 'Lady'.
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "city":
    string
    The name of the city. | Example: Potsdam
    "companyName1":
    string
    The company name in case it is a business address. | Example: Intershop Communications AG
    "companyName2":
    string
    The second company name
    "country":
    string
    Readonly | The localized display name of the country | Example: Germany
    "countryCode":
    string
    The ISO 3166-1 country code | Example: DE
    "customer":
    string
    "eligibleInstallToAddress":
    boolean
    Flag indicating that the address can be used as install-to address. | Example: false
    "eligibleInvoiceToAddress":
    boolean
    Flag indicating that the address can be used as invoice-to address. | Example: true
    "eligibleServiceToAddress":
    boolean
    Flag indicating that the address can be used as service-to address. | Example: false
    "eligibleShipFromAddress":
    boolean
    Flag indicating that the address can be used as ship-from address. | Example: false
    "eligibleShipToAddress":
    boolean
    Flag indicating that the address can be used as ship-to address. | Example: true
    "email":
    string
    The e-mail address of the contact person. | Example: patricia@test.intershop.de
    "externalId":
    string
    The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
    "externalUrn":
    string
    The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
    "fax":
    string
    The fax number.
    "firstName":
    string
    The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
    "honorific":
    string
    The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
    "id":
    string
    The ID that identifies the address. | Example: 0987654321
    "jobTitle":
    string
    The job title of the contact person.
    "lastName":
    string
    The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
    "mainDivision":
    string
    Readonly | The localized display name of the main division | Example: Alabama
    "mainDivisionCode":
    string
    The main division code of the country, e. g. a state or province. | Example: Al
    "phoneBusiness":
    string
    The phone number of the contact person's company.
    "phoneBusinessDirect":
    string
    The business phone number of the contact person that allows an outside caller to connect directly to the
    contact person without any help of an attendant or operator.
    "phoneHome":
    string
    The phone number of the house or apartment where the contact person lives. | Example: 049364112677
    "phoneMobile":
    string
    The number of the contact person's cell phone.
    "postBox":
    string
    The post-office box.
    "postalCode":
    string
    The postal code of the city. | Example: 14482
    "secondLastName":
    string
    The second last name of the contact person.
    "secondName":
    string
    The second given name of the contact person.
    "subDivision":
    string
    Readonly | The localized display name of the sub division. | Example: City of Westminster
    "subDivisionCode":
    string
    The sub division code. | Example: 020
    "title":
    string
    The (personal) title of the contact person. | Example: Ms.
    "urn":
    string
    The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
    "usage":
    object
    The usage information for the address. Every bit in the returned set marks a specific usage type: [invoice-to, ship-to, ship-from, service-to, install-to]. If a bit is set, the address may be used for the specific purpose mapped to this bit. By default, all values are set to true.
    {
    "empty":
    boolean
    }
    }
  }
- "shippingMethod":
  object
  {
  - "":
    object
    A OrderShippingMethodRO_v1 object. Describes a shipping method that has been selected as delivery option.
    {
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "deliveryTimeMax":
    object
    Readonly | The maximum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P7D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "deliveryTimeMin":
    object
    Readonly | The minimum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P3D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "description":
    string
    Readonly | The shipping method's localized description. | Example: Delivered to you 3-7 business days after we process your order.
    "digitalDelivery":
    boolean
    Readonly | Whether this shipping method is a digital delivery method (e. g. for e-mail delivery).
    "id":
    string
    Readonly | The shipping method's unique identifier. | Example: STD_GROUND
    "name":
    string
    Readonly | The name of an element. | Example: Standard Ground
    "shippingCosts":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "shortName":
    string
    Readonly | The shipping method's localized short Name. | Example: Int'l Express Delivery.
    }
  }
}
"infos":
array
Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.

}

Object application/json

{

"data":
array
An array of OrderShippingBucketRO_v1 objects. The core data of the response object.
[
OrderShippingBucketRO_v1: Describes a shipping bucket.
{
- "deliveryTimeMax":
  object
  Readonly | The maximum time the delivery will take based on the chosen shipping method (in ISO-8601 period format). | Example: P7D
  {
  "years":
  integer
  Format: int32
  "months":
  integer
  Format: int32
  "days":
  integer
  Format: int32
  "zero":
  boolean
  "chronology":
  object
  {
  "calendarType":
  string
  "id":
  string
  }
  "units":
  array
  An array of object literals.
  [
  {
  "duration":
  object
  {
  "seconds":
  integer
  Format: int64
  "zero":
  boolean
  "nano":
  integer
  Format: int32
  "negative":
  boolean
  }
  "dateBased":
  boolean
  "timeBased":
  boolean
  "durationEstimated":
  boolean
  }
  ]
  "negative":
  boolean
  }
- "deliveryTimeMin":
  object
  Readonly | The minimum time the delivery will take based on the chosen shipping method (in ISO-8601 period format). | Example: P3D
  {
  "years":
  integer
  Format: int32
  "months":
  integer
  Format: int32
  "days":
  integer
  Format: int32
  "zero":
  boolean
  "chronology":
  object
  {
  "calendarType":
  string
  "id":
  string
  }
  "units":
  array
  An array of object literals.
  [
  {
  "duration":
  object
  {
  "seconds":
  integer
  Format: int64
  "zero":
  boolean
  "nano":
  integer
  Format: int32
  "negative":
  boolean
  }
  "dateBased":
  boolean
  "timeBased":
  boolean
  "durationEstimated":
  boolean
  }
  ]
  "negative":
  boolean
  }
- "discounts":
  array
  Readonly | An array of string literals. The IDs of the discounts applied to the bucket totals.
- "id":
  string
  Readonly | The ID of the bucket. | Example: 54489489212
- "lineItems":
  array
  Readonly | An array of string literals. The ids of all line items which are associated with this bucket.
- "order":
  string
  Readonly | The order this shipping bucket belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
- "shipToAddress":
  string
  Readonly | The ship-to address URN for this bucket. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
- "shippingCosts":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
- "shippingMethod":
  string
  Readonly | The shipping method id for this bucket. | Example: STD_5DAY
- "surcharges":
  array
  Readonly | An array of OrderSurchargeRO_v1 objects. All extra charges arising from surcharges directly specified on product or by shipping rules with action type 'bucket'.
  [
  OrderSurchargeRO_v1: Describes a single surcharge incurred to a shipping bucket.
  {
  "amount":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  "name":
  string
  Readonly | The name of an element. | Example: Fridge Box
  "description":
  string
  Readonly | The surcharge's localized description. | Example: Needs a fridge box for shipping.
  "taxes":
  array
  Readonly | An array of TaxItemRO_v1 objects. The taxes applied to the surcharge.
  [
  TaxItemRO_v1: Represents a single tax item.
  {
  "calculatedTax":
  object
  Required | A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  Required | The effective rate used to calculate the tax.
  "jurisdiction":
  object
  A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
  {
  "id":
  string
  The jurisdiction ID. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  }
  "nonTaxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  "situs":
  string
  Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "taxableAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  The monetary value. | Example: 10.99
  }
  }
  ]
  }
  ]
}
]
"errors":
array
Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Readonly | Optionally included related data objects. Included via "include" query parameter.
{
- "discounts":
  object
  {
  - "":
    object
    A OrderDiscountRO_v1 object. Describes a discount arising from an applied promotion.
    {
    "id":
    string
    Required | Readonly | The ID of the promotion that triggered the discount. | Example: 92YKAM6dZtIAAAFb_KwtfPFU
    "amount":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "code":
    string
    Readonly | The used promotion code. | Example: Intershop
    "promotion":
    string
    Readonly | The promotion id. | Example: FreeShippingOnLEDTVs
    }
  }
- "shipToAddress":
  object
  {
  - "":
    object
    A AddressRO_v1 object. The address
    {
    "addressLine1":
    string
    The first address line, that usual contains street and house number. | Example: Berliner Str. 20
    "addressLine2":
    string
    The second address line.
    "addressLine3":
    string
    The third address line.
    "aristocraticTitle":
    string
    The aristocratic title of the contact person, like 'Lord' or 'Lady'.
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "city":
    string
    The name of the city. | Example: Potsdam
    "companyName1":
    string
    The company name in case it is a business address. | Example: Intershop Communications AG
    "companyName2":
    string
    The second company name
    "country":
    string
    Readonly | The localized display name of the country | Example: Germany
    "countryCode":
    string
    The ISO 3166-1 country code | Example: DE
    "customer":
    string
    "eligibleInstallToAddress":
    boolean
    Flag indicating that the address can be used as install-to address. | Example: false
    "eligibleInvoiceToAddress":
    boolean
    Flag indicating that the address can be used as invoice-to address. | Example: true
    "eligibleServiceToAddress":
    boolean
    Flag indicating that the address can be used as service-to address. | Example: false
    "eligibleShipFromAddress":
    boolean
    Flag indicating that the address can be used as ship-from address. | Example: false
    "eligibleShipToAddress":
    boolean
    Flag indicating that the address can be used as ship-to address. | Example: true
    "email":
    string
    The e-mail address of the contact person. | Example: patricia@test.intershop.de
    "externalId":
    string
    The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
    "externalUrn":
    string
    The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
    "fax":
    string
    The fax number.
    "firstName":
    string
    The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
    "honorific":
    string
    The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
    "id":
    string
    The ID that identifies the address. | Example: 0987654321
    "jobTitle":
    string
    The job title of the contact person.
    "lastName":
    string
    The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
    "mainDivision":
    string
    Readonly | The localized display name of the main division | Example: Alabama
    "mainDivisionCode":
    string
    The main division code of the country, e. g. a state or province. | Example: Al
    "phoneBusiness":
    string
    The phone number of the contact person's company.
    "phoneBusinessDirect":
    string
    The business phone number of the contact person that allows an outside caller to connect directly to the
    contact person without any help of an attendant or operator.
    "phoneHome":
    string
    The phone number of the house or apartment where the contact person lives. | Example: 049364112677
    "phoneMobile":
    string
    The number of the contact person's cell phone.
    "postBox":
    string
    The post-office box.
    "postalCode":
    string
    The postal code of the city. | Example: 14482
    "secondLastName":
    string
    The second last name of the contact person.
    "secondName":
    string
    The second given name of the contact person.
    "subDivision":
    string
    Readonly | The localized display name of the sub division. | Example: City of Westminster
    "subDivisionCode":
    string
    The sub division code. | Example: 020
    "title":
    string
    The (personal) title of the contact person. | Example: Ms.
    "urn":
    string
    The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
    "usage":
    object
    The usage information for the address. Every bit in the returned set marks a specific usage type: [invoice-to, ship-to, ship-from, service-to, install-to]. If a bit is set, the address may be used for the specific purpose mapped to this bit. By default, all values are set to true.
    {
    "empty":
    boolean
    }
    }
  }
- "shippingMethod":
  object
  {
  - "":
    object
    A OrderShippingMethodRO_v1 object. Describes a shipping method that has been selected as delivery option.
    {
    "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    "name":
    string
    Required | The name of an element.
    "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    "value":
    object
    }
    ]
    "deliveryTimeMax":
    object
    Readonly | The maximum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P7D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "deliveryTimeMin":
    object
    Readonly | The minimum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P3D
    {
    "years":
    integer
    Format: int32
    "months":
    integer
    Format: int32
    "days":
    integer
    Format: int32
    "zero":
    boolean
    "chronology":
    object
    {
    "calendarType":
    string
    "id":
    string
    }
    "units":
    array
    An array of object literals.
    [
    {
    "duration":
    object
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    }
    "dateBased":
    boolean
    "timeBased":
    boolean
    "durationEstimated":
    boolean
    }
    ]
    "negative":
    boolean
    }
    "description":
    string
    Readonly | The shipping method's localized description. | Example: Delivered to you 3-7 business days after we process your order.
    "digitalDelivery":
    boolean
    Readonly | Whether this shipping method is a digital delivery method (e. g. for e-mail delivery).
    "id":
    string
    Readonly | The shipping method's unique identifier. | Example: STD_GROUND
    "name":
    string
    Readonly | The name of an element. | Example: Standard Ground
    "shippingCosts":
    object
    A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
    {
    "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
    }
    "shortName":
    string
    Readonly | The shipping method's localized short Name. | Example: Int'l Express Delivery.
    }
  }
}
"infos":
array
Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.

}

PaymentCtnrRO_v1 application/json

{

"data":
object
A PaymentRO_v1 object. A payment assigned to the basket/order to pay the bill with.
{
- "baseAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  - "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  - "value":
    number
    The monetary value. | Example: 10.99
  }
- "id":
  string
  Readonly | The ID of the payment. | Example: AAFjXFq2QKAEsBiyQABB6G14
- "openTender":
  boolean
  Readonly | Whether or not the payment is an 'open-tender' payment.
- "paymentCosts":
  object
  A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
  {
  - "gross":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "net":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    The monetary value. | Example: 10.99
    }
  }
- "paymentInstrument":
  string
  Required | The reference to the payment instrument that was selected for this payment. | Example: c2UKAEsBar8AAAFmxYVBTOiI
- "paymentMethod":
  string
  Readonly | The reference to the payment method that was used for this payment. | Example: ISH_INVOICE
- "redirect":
  object
  A PaymentRedirectRO_v1 object. Describes a payment redirect. Note: Beta version - This class can still be subject of change!
  {
  - "cancelUrl":
    string
    Required | The URL to be called when the user cancelled payment and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/cancel?paymentID=*paymentID*
  - "failureUrl":
    string
    Required | The URL to be called when the payment failed and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/failure
  - "parameters":
    array
    An array of ParameterRO_v1 objects. List of parameters returned in the redirect response from the PSP.
    [
    ParameterRO_v1: A representation of a parameter value.
    {
    "name":
    string
    The name of an element. | Example: expiryDate
    "value":
    object
    The value of the parameter. | Example: 12/30
    }
    ]
  - "redirectUrl":
    string
    Readonly | The URL to be called when redirecting the user to the payment providers page. | Format: uri | Example: https://psp-server/pay
  - "status":
    string
    The final status of the redirect returned to the shop. | Example: SUCCESS | Possible Values: SUCCESSCANCELFAILURE
  - "successUrl":
    string
    Required | The URL to be called on successful payment redirect back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/success?orderID=*orderID*
  }
- "redirectRequired":
  boolean
  Readonly | Whether or not a redirect is required to finish the payment. The type of redirect (before or after the checkout process) can be determined via the capabilities of the payment method.
- "status":
  string
  Readonly | The localized display name of the payment status. | Example: Partially captured
- "totalAmount":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  - "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  - "value":
    number
    The monetary value. | Example: 10.99
  }
}
"errors":
array
Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Optionally included related data objects.
"infos":
array
Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.

}

PaymentRO_v1 application/json

{

"baseAmount":
object
A MoneyRO_v1 object. Describes a money object.
{
- "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
- "value":
  number
  The monetary value. | Example: 10.99
}
"id":
string
Readonly | The ID of the payment. | Example: AAFjXFq2QKAEsBiyQABB6G14
"openTender":
boolean
Readonly | Whether or not the payment is an 'open-tender' payment.
"paymentCosts":
object
A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
{
- "gross":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  - "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  - "value":
    number
    The monetary value. | Example: 10.99
  }
- "net":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  - "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  - "value":
    number
    The monetary value. | Example: 10.99
  }
- "tax":
  object
  A MoneyRO_v1 object. Describes a money object.
  {
  - "currency":
    string
    Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  - "value":
    number
    The monetary value. | Example: 10.99
  }
}
"paymentInstrument":
string
Required | The reference to the payment instrument that was selected for this payment. | Example: c2UKAEsBar8AAAFmxYVBTOiI
"paymentMethod":
string
Readonly | The reference to the payment method that was used for this payment. | Example: ISH_INVOICE
"redirect":
object
A PaymentRedirectRO_v1 object. Describes a payment redirect. Note: Beta version - This class can still be subject of change!
{
- "cancelUrl":
  string
  Required | The URL to be called when the user cancelled payment and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/cancel?paymentID=*paymentID*
- "failureUrl":
  string
  Required | The URL to be called when the payment failed and the PSP redirects the user back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/failure
- "parameters":
  array
  An array of ParameterRO_v1 objects. List of parameters returned in the redirect response from the PSP.
  [
  ParameterRO_v1: A representation of a parameter value.
  {
  "name":
  string
  The name of an element. | Example: expiryDate
  "value":
  object
  The value of the parameter. | Example: 12/30
  }
  ]
- "redirectUrl":
  string
  Readonly | The URL to be called when redirecting the user to the payment providers page. | Format: uri | Example: https://psp-server/pay
- "status":
  string
  The final status of the redirect returned to the shop. | Example: SUCCESS | Possible Values: SUCCESSCANCELFAILURE
- "successUrl":
  string
  Required | The URL to be called on successful payment redirect back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/success?orderID=*orderID*
}
"redirectRequired":
boolean
Readonly | Whether or not a redirect is required to finish the payment. The type of redirect (before or after the checkout process) can be determined via the capabilities of the payment method.
"status":
string
Readonly | The localized display name of the payment status. | Example: Partially captured
"totalAmount":
object
A MoneyRO_v1 object. Describes a money object.
{
- "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
- "value":
  number
  The monetary value. | Example: 10.99
}

}

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.