This API specification is available for download as an Open API 3.0 YAML file:
References
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
API Specification
/orders
GET: [BETA] 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 | Default | Example | Description |
---|
in query | include | array | | | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all buckets commonShipToAddress commonShippingMethod discounts invoiceToAddress lineItems payments |
in query | filter[statusCode] | string |
| filter[statusCode]=NEW,PENDING | Filters orders by their (case-sensitive) order status. |
in query | page[limit] | integer int32 | | page[limit]=10 | Limits the number of orders returned in th response. |
Response
200 - OK The list of orders.
OrderListCtnrRO_v1 application/vnd.intershop.order.v1+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/vnd.intershop.order.v1+json
POST: [BETA] 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 */*
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in query | include | array | | | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all buckets commonShipToAddress commonShippingMethod discounts invoiceToAddress lineItems payments |
Response
201 - Created The created order if the process finished successfully.
202 - Accepted If the order was created, but additional steps need to be performed before the order creation is finished (e. g. a redirect to the payment service provider). A "PATCH" request on the order item resource needs to be invoked afterwards to continue the order creation process.
401 - Unauthorized If the user couldn't be authenticated.
422 - Unprocessable Entity If the order could not be created because of semantical errors.
/orders/{orderKey}
GET: [BETA] 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 | Default | Example | Description |
---|
in path | orderKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in query | include | array | | | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all buckets commonShipToAddress commonShippingMethod discounts invoiceToAddress lineItems payments |
Response
200 - OK The order with the given ID.
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.
410 - Gone If order is abort with payment canceled.
PATCH: [BETA] 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 */*
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | orderKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in query | include | array | | | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all buckets commonShipToAddress commonShippingMethod discounts invoiceToAddress lineItems payments |
Response
200 - OK The updated order if the order process is completed.
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).
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.
422 - Unprocessable Entity If the order could not be updated because of semantical errors.
/orders/{orderKey}/attributes
GET: [BETA] 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 | Default | Example | Description |
---|
in path | orderKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
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.
POST: [BETA] 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
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | orderKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
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.
422 - Unprocessable Entity If the attribute could not be created because of semantic errors in the passed data.
/orders/{orderKey}/items
GET: [BETA] 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 | Default | Example | Description |
---|
in path | orderKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in query | include | array | | | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all discounts product shipToAddress shippingMethod warranty |
Response
200 - OK The list of line items.
OrderLineItemListCtnrRO_v1 application/vnd.intershop.order.v1+json
401 - Unauthorized If the user couldn't be authenticated.
/orders/{orderKey}/items/{LineItemKey}
GET: [BETA] 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 | Default | Example | Description |
---|
in path | orderKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | LineItemKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in query | include | array | | | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all discounts product shipToAddress shippingMethod warranty |
Response
200 - OK Information message describing success status.
OrderLineItemCtnrRO_v1 application/vnd.intershop.order.v1+json
404 - Not Found If a line item with the given ID is not found in the order.
OrderLineItemCtnrRO_v1 application/vnd.intershop.order.v1+json
/orders/{orderKey}/items/{LineItemKey}/attributes
GET: [BETA] 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 | Default | Example | Description |
---|
in path | orderKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | LineItemKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
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.
POST: [BETA] 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
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | orderKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | LineItemKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
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.
422 - Unprocessable Entity If the attribute could not be created because of semantic errors in the passed data.
/orders/{orderKey}/payments
GET: [BETA] 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 | Default | Example | Description |
---|
in path | orderKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in query | include | array | | | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all paymentInstrument paymentMethod |
Response
200 - OK The list of payments.
PaymentCtnrRO_v1 application/vnd.intershop.order.v1+json
401 - Unauthorized If the user couldn't be authenticated.
/orders/{orderKey}/payments/{PaymentKey}
PATCH: [BETA] 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 */*
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in path | orderKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | PaymentKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in query | include | array | | | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all paymentInstrument paymentMethod |
Response
200 - OK Information message describing success status.
PaymentCtnrRO_v1 application/vnd.intershop.order.v1+json
422 - Unprocessable Entity If the payment could not be updated.
PaymentCtnrRO_v1 application/vnd.intershop.order.v1+json
/orders/{orderKey}/buckets
GET: [BETA] 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 | Default | Example | Description |
---|
in path | orderKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in query | include | array | | | Related objects which are to be included with the response. | Possible Values: all discounts shipToAddress shippingMethod |
Response
200 - OK The list of shipping buckets.
Object application/vnd.intershop.order.v1+json
401 - Unauthorized If the user couldn't be authenticated.
/orders/{orderKey}/buckets/{ShippingBucketKey}
GET: [BETA] 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 | Default | Example | Description |
---|
in path | orderKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in path | ShippingBucketKey | string | | ExampleKey | Required | The key or UUID to resolve a single item |
in query | include | array | | | Related objects (as a comma separated list) which are to be included with the response. | Possible Values: all discounts shipToAddress shippingMethod |
Response
200 - OK The shipping bucket.
OrderShippingBucketCtnrRO_v1 application/vnd.intershop.order.v1+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/vnd.intershop.order.v1+json
AttributeCtnrRO_v1 application/vnd.intershop.order.v1+json
AttributeListCtnrRO_v1 application/vnd.intershop.order.v1+json
AttributeRO_v1 */*
OrderCtnrRO_v1 application/vnd.intershop.order.v1+json
OrderLineItemCtnrRO_v1 application/vnd.intershop.order.v1+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.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"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: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_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_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"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.
"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/vnd.intershop.order.v1+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.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"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: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_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_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"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.
"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/vnd.intershop.order.v1+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.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"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.
"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/20
}
]
"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: SUCCESS
CANCEL
FAILURE
"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: COMPLETED
STOPPED
ROLLED_BACK
CONTINUE
"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: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_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_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"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: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_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_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"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: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_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_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"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: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_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_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"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: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_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_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"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.
"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 */*
{"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.
[
Either BooleanAttributeRO_v1
: A representation of a boolean attribute.
{}
Or DateAttributeRO_v1
: A representation of a date/time attribute.
{}
Or DecimalAttributeRO_v1
: A representation of a decimal attribute.
{}
Or DoubleAttributeRO_v1
: A representation of a double attribute.
{}
Or IntegerAttributeRO_v1
: A representation of an integer attribute.
{}
Or LongAttributeRO_v1
: A representation of a long attribute.
{}
Or MoneyAttributeRO_v1
: A representation of a money attribute.
{}
Or QuantityAttributeRO_v1
: A representation of a quantity attribute.
{}
Or StringAttributeRO_v1
: A representation of a string attribute.
{}
Or TextAttributeRO_v1
: A representation of a text attribute.
{}
Or MultipleBooleanAttributeRO_v1
: A representation of a multiple boolean attribute.
{}
Or MultipleDateAttributeRO_v1
: A representation of a multiple date/time attribute.
{}
Or MultipleDecimalAttributeRO_v1
: A representation of a multiple decimal attribute.
{}
Or MultipleDoubleAttributeRO_v1
: A representation of a multiple double attribute.
{}
Or MultipleIntegerAttributeRO_v1
: A representation of a multiple integer attribute.
{}
Or MultipleLongAttributeRO_v1
: A representation of a multiple long attribute.
{}
Or MultipleStringAttributeRO_v1
: A representation of a multiple string attribute.
{}
]
"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.
"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/20
}
]
"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: SUCCESS
CANCEL
FAILURE
"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: COMPLETED
STOPPED
ROLLED_BACK
CONTINUE
"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: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_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_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"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: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_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_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"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: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_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_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"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.
"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.
"nonTaxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
"situs":
string
Readonly | The situs/place of taxation. | Example: DESTINATION
| Possible Values:
ADMINISTRATIVE_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"taxableAmount":
object
A MoneyRO_v1
object. Describes a money object.
}
]
"shippingTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
"surchargeTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
"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.
"valueDiscountsTotal":
object
A PriceRO_v1
object. Describes a price. A price has a monetary net, gross and tax value.
}
"user":
string
Readonly | The order owner user login.
}OrderShippingBucketCtnrRO_v1 application/vnd.intershop.order.v1+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
"units":
array
An array of object
literals.
[
{
{
"seconds":
integer
Format: int64
"nano":
integer
Format: int32
}
"durationEstimated":
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
"units":
array
An array of object
literals.
[
{
{
"seconds":
integer
Format: int64
"nano":
integer
Format: int32
}
"durationEstimated":
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: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_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_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"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.
"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/vnd.intershop.order.v1+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
"units":
array
An array of object
literals.
[
{
{
"seconds":
integer
Format: int64
"nano":
integer
Format: int32
}
"durationEstimated":
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
"units":
array
An array of object
literals.
[
{
{
"seconds":
integer
Format: int64
"nano":
integer
Format: int32
}
"durationEstimated":
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: APO
BOROUGH
CITY
COUNTRY
COUNTY
DISTRICT
FPO
LOCAL_IMPROVEMENT_DISTRICT
PARISH
PROVINCE
SPECIAL_PURPOSE_DISTRICT
STATE
TERRITORY
TOWNSHIP
TRADE_BLOCK
TRANSIT_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_DESTINATION
ADMINISTRATIVE_ORIGIN
DESTINATION
ORIGIN
"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.
"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/vnd.intershop.order.v1+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/20
}
]
"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: SUCCESS
CANCEL
FAILURE
"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 */*
{"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/20
}
]
"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: SUCCESS
CANCEL
FAILURE
"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
}
}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.