Reference - ICM REST API - B2C Front End - Basket 1.0.0


Product Version

7.10

Product To Version


Status

final

Download Specification 

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

API Specification

Introduction

OpenAPI Version: 3.0.1
Basket Version: 1.0.0

This is Intershop ICM REST API documentation.

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

Introduction

This API is documented in OpenAPI format.

Address (beta) API

/baskets/{BasketResourceKey}/addresses
GET: [BETA] Returns the list of addresses that have been created at the selected basket.

Description

--

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressListResource.getAddresses_V1(java.lang.String,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects (as a comma separated list) which are to be included with the response.
in queryeligibleInvoiceToAddressbooleanWhether invoice-to addresses should be included in the response or not.
in queryeligibleShipToAddressbooleanWhether ship-to addresses should be included in the response or not.
in queryeligibleShipFromAddressbooleanWhether ship-from addresses should be included in the response or not.
in queryeligibleServiceToAddressbooleanWhether service-to addresses should be included in the response or not.
in queryeligibleInstallToAddressbooleanWhether install-to addresses should be included in the response or not.

Response

200 - OK

The list of addresses.
AddressListCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.
POST: [BETA] Adds a new address to the basket.

Description

If a address with initial data is passed, these data will be set at the newly created address.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressListResource.createAddress_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO,java.lang.String)

Request Body

AddressRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects which are to be included with the response.

Response

201 - Created

The newly created address, if it was created successfully.
AddressListCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.

422 - Unprocessable Entity

A list of (semantical) error messages, if the address could not be added.
FeedbackCtnrRO_v1 application/json
/baskets/{BasketResourceKey}/addresses/{AddressKey}
GET: [BETA] Returns the address for the given ID.

Description

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

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressItemResource.getAddress_V1(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathAddressKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects (as a comma separated list) which are to be included with the response.

Response

200 - OK

The address with the given ID.
AddressCtnrRO_v1 application/json

404 - Not Found

If an address with the given ID is not found in the basket.
FeedbackCtnrRO_v1 application/json
DELETE: [BETA] Deletes the address with the given ID from the basket.

Description

Deletes the address with the given ID from the basket. If no address with this ID is found, a 404 error will be returned. If for some reason the address could not be removed, a 422 error will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressItemResource.deleteAddress_V1()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathAddressKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

Information message describing success status.
AddressCtnrRO_v1 application/json

404 - Not Found

If an address with the given ID is not found in the basket.
FeedbackCtnrRO_v1 application/json

422 - Unprocessable Entity

If the address could not be deleted.
AddressCtnrRO_v1 application/json
PATCH: [BETA] Partially updates the address with the given ID.

Description

--

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.AddressItemResource.updateAddress_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.address.AddressRO,java.lang.String)

Request Body

AddressRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathAddressKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects which are to be included with the response.

Response

200 - OK

The updated address.
AddressCtnrRO_v1 application/json

404 - Not Found

If a address with the given ID is not found in the basket.
FeedbackCtnrRO_v1 application/json

422 - Unprocessable Entity

If the address could not be updated.
AddressCtnrRO_v1 application/json
/baskets/{BasketResourceKey}/eligible-addresses
GET: [BETA] Returns the list of eligible addresses that can be set at the selected basket.

Description

Returns the list of eligible addresses that can be set as invoice-to or ship-to addresses at the selected basket. This may include addresses created at the basket or at the customer.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.address.EligibleAddressListResource.getAddresses_V1(java.lang.String,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean,java.lang.Boolean)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects (as a comma separated list) which are to be included with the response.
in queryeligibleInvoiceToAddressbooleanWhether invoice-to addresses should be included in the response or not.
in queryeligibleShipToAddressbooleanWhether ship-to addresses should be included in the response or not.
in queryeligibleShipFromAddressbooleanWhether ship-from addresses should be included in the response or not.
in queryeligibleServiceToAddressbooleanWhether service-to addresses should be included in the response or not.
in queryeligibleInstallToAddressbooleanWhether install-to addresses should be included in the response or not.

Response

200 - OK

The list of eligible addresses.
AddressListCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.

Cost Object API

/baskets/{BasketResourceKey}/costobjects
GET: Get the cost objects assigned to the selected basket

Description

ResourceCollectionRO contains elements of type LinkRO

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentListResource.getBasketCostObjectAssignments()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

ResourceCollectionROLinkRO application/json
ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {BasketCostObjectAssignmentKey} in subsequent requests. Links to item of type CostObjectAssignmentRO.

401 - Unauthorized

403 - Forbidden

Requires authentication with user having assigned the following permissions:
- View Cost Object (APP_B2B_VIEW_COSTOBJECT)
POST: Assigns a cost object to the basket

Description

--

Java Method

public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentListResource.createCostObjectAssignment(com.intershop.application.storefront.rest.b2b.capi.costobject.resourceobject.CostObjectAssignmentRO)

Request Body

CostObjectAssignmentRO application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

201 - Created

400 - Bad Request

possible values for header error-key:
- basket.cost_object.missing_body.error
- basket.cost_object.missing_attributes.error
- basket.cost_object.invalid_attributes.error
- basket.cost_object.already_set.error

401 - Unauthorized

403 - Forbidden

Requires authentication with user having assigned the following permissions:
- Assign Cost Object To Basket (APP_B2B_ASSIGN_COSTOBJECT_TO_BASKET)

404 - Not Found

/baskets/{BasketResourceKey}/costobjects/{BasketCostObjectAssignmentKey}
GET: Get a specific cost object assigned to the selected basket

Description

--

Java Method

public com.intershop.application.storefront.rest.b2b.capi.costobject.resourceobject.CostObjectAssignmentRO com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentItemResource.getBasketCostObjectAssignment()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketCostObjectAssignmentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

CostObjectAssignmentRO application/json

401 - Unauthorized

403 - Forbidden

Requires authentication with user having assigned the following permissions:
- View Cost Object (APP_B2B_VIEW_COSTOBJECT)

404 - Not Found

DELETE: Removes a cost object from the basket

Description

--

Java Method

public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.order.costobject.resource.BasketCostObjectAssignmentItemResource.deleteCostObjectAssignment()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketCostObjectAssignmentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

401 - Unauthorized

403 - Forbidden

Requires authentication with user having assigned the following permissions:
- Delete Cost Object (APP_B2B_DELETE_COSTOBJECT)

404 - Not Found

General (beta) API

/baskets
GET: [BETA] Returns the list of active baskets for the user.

Description

Returns the list of active baskets for the user. A basket is active if it is in status 'OPEN'. The last modified basket is the most recent and therefore the first in the result list. 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.basket.v1.capi.resource.basket.BasketListResource.getBaskets_V1(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in queryincludearrayRelated objects (as a comma separated list) which are to be included with the response. | Possible Values: allbucketscommonShipToAddresscommonShippingMethodcustomdiscountsinvoiceToAddresslineItemspayments

Response

200 - OK

The list of active baskets.
BasketListCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.
POST: [BETA] Creates a new basket for the user.

Description

Creates a new basket for the user. If a basket with initial data is passed, these data will be set at the newly created basket. In case this leads to validation errors, no basket is created and error 422 together with a cause desciption 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.basket.v1.capi.resource.basket.BasketListResource.createBasket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.basket.BasketRO,java.lang.String)

Request Body

BasketRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in queryincludearrayRelated objects (as a comma separated list) which are to be included with the response. | Possible Values: allbucketscommonShipToAddresscommonShippingMethodcustomdiscountsinvoiceToAddresslineItemspayments

Response

201 - Created

The created basket.
BasketCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.

422 - Unprocessable Entity

If the basket could not be created because of semantical errors in the initial data.
BasketCtnrRO_v1 application/json
/baskets/{BasketResourceKey}
GET: [BETA] Returns the basket with the given ID.

Description

Returns the basket with the given ID for the user. If no active basket 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. Instead of an ID "current" may be specified to retrieve the current active basket, if there is one.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketItemResource.getBasket_V1(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects (as a comma separated list) which are to be included with the response. | Possible Values: allbucketscommonShipToAddresscommonShippingMethodcustomdiscountsinvoiceToAddresslineItemspayments

Response

200 - OK

The basket with the given ID.
BasketCtnrRO_v1 application/json

401 - Unauthorized

If the user could not be authenticated.

403 - Forbidden

If the user does not have the required access privileges.

404 - Not Found

If no active basket is found.
BasketCtnrRO_v1 application/json
DELETE: [BETA] Deletes the basket with the given ID.

Description

Deletes the basket with the given ID. Note that the basket may not be deleted immediately, but rather later on by a scheduled job. However, after calling this method, it will no longer be accessible. If no active basket 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. Error 403 is returned, if the user does not have the required access privileges. Instead of an ID "current" may be specified to delete the current active basket, if there is one.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketItemResource.deleteBasket_V1()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

Information message describing success status.
BasketCtnrRO_v1 application/json

401 - Unauthorized

If the user could not be authenticated.

403 - Forbidden

If the user does not have the required access privileges.

404 - Not Found

If a basket with the given ID is not found in the list of user baskets.
BasketCtnrRO_v1 application/json
PATCH: [BETA] Partially updates the basket with the given ID.

Description

Partially updates the basket with the given ID. If no active basket 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. Error 403 is returned, if the user does not have the required access privileges. Instead of an ID "current" may be specified to update the current active basket, if there is one.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.basket.BasketItemResource.updateBasket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.basket.BasketRO,java.lang.String)

Request Body

BasketRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects (as a comma separated list) which are to be included with the response. | Possible Values: allbucketscommonShipToAddresscommonShippingMethodcustomdiscountsinvoiceToAddresslineItemspayments

Response

200 - OK

The updated basket
BasketCtnrRO_v1 application/json

401 - Unauthorized

If the user could not be authenticated.

403 - Forbidden

If the user does not have the required access privileges.

404 - Not Found

If a basket with the given ID is not found in the list of user baskets.
BasketCtnrRO_v1 application/json
/baskets/{BasketResourceKey}/attributes
GET: [BETA] Returns (custom) attributes for the basket.

Description

--

Java Method

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

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects (as a comma separated list) which are to be included with the response.

Response

200 - OK

The list of attributes.
AttributeListCtnrRO_v1 application/json
POST: [BETA] Creates a new (custom) attribute at the basket.

Description

Creates a new (custom) attribute at the basket. 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.basket.v1.capi.resource.attribute.BasketAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)

Request Body

AttributeRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects (as a comma separated list) which are to be included with the response.

Response

201 - Created

The created attribute.
AttributeCtnrRO_v1 application/json

422 - Unprocessable Entity

If the attribute could not be created because of semantic errors in the passed data.
AttributeCtnrRO_v1 application/json
/baskets/{BasketResourceKey}/attributes/{BasketAttributeKey}
DELETE: [BETA] Deletes the attribute from the basket.

Description

Deletes the attribute from the basket. If no attribute with this name is found, a 404 error will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.BasketAttributeItemResource.deleteAttribute_V1()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketAttributeKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

Information message describing success status.
AttributeCtnrRO_v1 application/json

404 - Not Found

If an attribute with the given name is not found in the basket.
AttributeCtnrRO_v1 application/json
PATCH: [BETA] Updates the basket attribute.

Description

Updates the basket attribute. Note that only the value may be changed; name and type of the attribute are immutable. An error with status code 422 will be returned in case the attribute could not be updated.

Java Method

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

Request Body

AttributeRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketAttributeKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects (as a comma separated list) which are to be included with the response.

Response

200 - OK

The updated attribute.
AttributeCtnrRO_v1 application/json

422 - Unprocessable Entity

If the attribute could not be updated because of semantic errors in the passed data.
AttributeCtnrRO_v1 application/json
/baskets/{BasketResourceKey}/merges
POST: [BETA] Merge the basket with an other basket.

Description

Merge the basket (target basket) with an other basket (source basket). In that case, the source basket owner is not registered and the corresponding authentication token is not part of the payload, the source basket will be anonymized. Merge objects are the line items, recurrence information, and the affiliate informations. If the corresponding authentication token is part of the payload, the source basket will not be anonymized. In that case, the source basket owner is registered and is equals to the target basket owner, line items, addresses, recurrence information, promotion codes and affiliate informations will be merged. Generally not included in scope are the payments of the source basket. The source basket will removed after merge unless the payload of the request contains information to suppress this behavior.If no active basket with this ID is found for the user, a 404 error will be returned. If during the processing of the request a failure occurred, a 422 error with specific error cause is returned. Possible error keys are "basket.not_found.error", "basket.merge.invalid_token.error", "basket.merge.token_is_expired.error","basket.merge.source_basket_user_is_registered.error".Instead of an ID "current" may be specified to update the current active basket, if there is one.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.merge.BasketMergeListResource.mergeBasket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.merge.BasketMergeRO,java.lang.String)

Request Body

BasketMergeRO.v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects which are to be included with the response. | Possible Values: alltargetBasket

Response

201 - Created

The merge data
BasketMergeCtnrRO.v1 application/json

401 - Unauthorized

If the user could not be authenticated.

404 - Not Found

If a basket with the given ID is not found in the list of user baskets.
BasketMergeCtnrRO.v1 application/json

422 - Unprocessable Entity

If during the processing of the request a failure occurred, a 422 error with specific error cause is returned.
BasketMergeCtnrRO.v1 application/json
/baskets/{BasketResourceKey}/validations
POST: [BETA] Validates the basket.

Description

Triggers a validation of the basket and returns the validation errors. Optionally, the basket is adjusted automatically (e. g. to remove unavailable line items).

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.validation.BasketValidationListResource.validateBasket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.validation.BasketValidationRO,java.lang.String)

Request Body

BasketValidationRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects which are to be included with the response. | Possible Values: allbasket

Response

201 - Created

Returns the result of the validation.
BasketValidationCtnrRO_v1 application/json

401 - Unauthorized

Returns an error, if the user couldn't be authenticated.

422 - Unprocessable Entity

Returns a list of (semantical) error messages, if the validation could not be executed.
FeedbackCtnrRO_v1 application/json

Line Item (beta) API

/baskets/{BasketResourceKey}/items
GET: [BETA] Returns the list of line items for the selected basket.

Description

--

Java Method

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

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects (as a comma separated list) which are to be included with the response. | Possible Values: alldiscountsproductshipToAddressshippingMethodwarranty

Response

200 - OK

- The list of line items.
BasketLineItemListCtnrRO_v1 application/json

401 - Unauthorized

- The user could not be authenticated.
POST: [BETA] Adds one or more products to the basket

Description

Adds one or more products to the basket. This creates new line items in the basket or, if a product already exists in the basket and merging is configured, increases the quantity of an existing line item. Note that this request may succeed partially, i. e. if three products are to be added and one fails because of semantical errors, the other two will still be added to the basket.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemListResource.createLineItems_V1(java.util.List,java.lang.String)

Request Body

Array of BasketLineItemRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects which are to be included with the response | Possible Values: alldiscountsproductshipToAddressshippingMethodwarranty

Response

200 - OK

- The line items were successfully merged.
BasketLineItemListCtnrRO_v1 application/json

201 - Created

- All line items were created successfully.
BasketLineItemListCtnrRO_v1 application/json

207 - Multi-Status

Some items could not be added.This response will be returned if there are different response codes for individual items.
BasketLineItemListCtnrRO_v1 application/json

401 - Unauthorized

- The user could not be authenticated.

422 - Unprocessable Entity

- No product could be added.
BasketLineItemListCtnrRO_v1 application/json
DELETE: Deletes all line items for the selected basket

Description

Deletes all line items from a basket with a given basket ID.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemListResource.deleteLineItems_V1()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

- The basket line items were deleted.
BasketLineItemCtnrRO_v1 application/json

404 - Not Found

- A basket with the given ID could not be found.
BasketLineItemCtnrRO_v1 application/json

422 - Unprocessable Entity

- The line item(s) could not be deleted.
BasketLineItemCtnrRO_v1 application/json
/baskets/{BasketResourceKey}/items/{BasketLineKey}
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.basket.v1.capi.resource.lineitem.LineItemItemResource.getLineItem_V1(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketLineKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects (as a comma separated list) which are to be included with the response. | Possible Values: alldiscountsproductshipToAddressshippingMethodwarranty

Response

200 - OK

Information message describing success status.
BasketLineItemCtnrRO_v1 application/json

404 - Not Found

If a line item with the given ID is not found in the basket.
BasketLineItemCtnrRO_v1 application/json
DELETE: [BETA] Deletes the line item with the given ID from the basket.

Description

Deletes the line item with the given ID from the basket. If no line item with this ID is found, a 404 error will be returned. If for some reason the line item could not be removed, a 422 error will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemItemResource.deleteLineItem_V1()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketLineKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

Information message describing success status.
BasketLineItemCtnrRO_v1 application/json

404 - Not Found

If a line item with the given ID is not found in the basket.
BasketLineItemCtnrRO_v1 application/json

422 - Unprocessable Entity

If the line item could not be deleted.
BasketLineItemCtnrRO_v1 application/json
PATCH: [BETA] Partially updates the lineitem with the given ID.

Description

Partially updates the lineitem with the given ID. If no line item with this ID is found, a 404 error will be returned. If for some reason the line item could not be updated, a 422 error will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.lineitem.LineItemItemResource.updateLineItem_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.lineitem.LineItemRO,java.lang.String)

Request Body

BasketLineItemRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketLineKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects which are to be included with the response. | Possible Values: alldiscountsproductshipToAddressshippingMethodwarranty

Response

200 - OK

Information message describing success status.
BasketLineItemCtnrRO_v1 application/json

404 - Not Found

If a line item with the given ID is not found in the basket.
BasketLineItemCtnrRO_v1 application/json

422 - Unprocessable Entity

If the line item could not be updated.
BasketLineItemCtnrRO_v1 application/json
/baskets/{BasketResourceKey}/items/{BasketLineKey}/attributes
GET: [BETA] Returns (custom) attributes for the line item.

Description

--

Java Method

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

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketLineKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects (as a comma separated list) which are to be included with the response.

Response

200 - OK

The list of attributes.
AttributeListCtnrRO_v1 application/json
POST: [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.basket.v1.capi.resource.attribute.LineItemAttributeListResource.createAttribute_V1(com.intershop.sellside.rest.common.v1.capi.resourceobject.attribute.AttributeRO,java.lang.String)

Request Body

AttributeRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketLineKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects (as a comma separated list) which are to be included with the response.

Response

201 - Created

The created attribute.
AttributeCtnrRO_v1 application/json

422 - Unprocessable Entity

If the attribute could not be created because of semantic errors in the passed data.
AttributeCtnrRO_v1 application/json
/baskets/{BasketResourceKey}/items/{BasketLineKey}/attributes/{LineItemAttributeKey}
DELETE: [BETA] Deletes the attribute from the line item.

Description

Deletes the attribute from the line item. If no attribute with this name is found, a 404 error will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.attribute.LineItemAttributeItemResource.deleteAttribute_V1()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketLineKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathLineItemAttributeKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

Information message describing success status.
AttributeCtnrRO_v1 application/json

404 - Not Found

If an attribute with the given name is not found in the line item.
AttributeCtnrRO_v1 application/json
PATCH: [BETA] Updates the line item attribute.

Description

Updates the line item attribute. Note that only the value may be changed; name and type of the attribute are immutable. An error with status code 422 will be returned in case the attribute could not be updated.

Java Method

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

Request Body

AttributeRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketLineKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathLineItemAttributeKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects (as a comma separated list) which are to be included with the response.

Response

200 - OK

The updated attribute.
AttributeCtnrRO_v1 application/json

422 - Unprocessable Entity

If the attribute could not be updated because of semantic errors in the passed data.
AttributeCtnrRO_v1 application/json

Payment API

/baskets/{BasketResourceKey}/payments/{BasketPaymentKey}/redirect
PUT: REST client delivers the return URLs to the system

Description

The REST client sends the return URLs to the system, so that the redirect URL for the payment service provider can be created. This redirect URL will be send as response to the REST client so that the client can process the redirect action. After that, the user will be redirected back to his REST client based on the return URLs.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentRedirectResource.createRedirectURL(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectRO)

Request Body

PaymentRedirectRO application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketPaymentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

201 - Created

400 - Bad Request

401 - Unauthorized

403 - Forbidden

Requires authentication with user having assigned the following permissions:
- Purchase (APP_B2B_PURCHASE, only in B2B applications)

404 - Not Found

POST: Transfer payment transaction information from the payment service provider, via the REST client to the shop system to activate there the payment transaction

Description

If the user has processed his payment transaction successfully at the payment providers system, he will be redirected back to his REST client. This return redirect contains various payment transaction attributes which must be transferred from the REST client back to the shop system to process the payment transaction. The redirect POST requests transfers this data from the REST client into the shop system so that the payment transaction can be activated there. For instance:

  • transaction ID
  • transaction status
  • and so on

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentRedirectResource.addRedirectResponseData(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectResponseRO)

Request Body

PaymentRedirectResponseRO application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketPaymentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

PaymentRO application/json

400 - Bad Request

401 - Unauthorized

403 - Forbidden

Requires authentication with user having assigned the following permissions:
- Purchase (APP_B2B_PURCHASE, only in B2B applications)

404 - Not Found

Payment (beta) API

/baskets/{BasketResourceKey}/eligible-payment-methods
GET: [BETA] Returns the list of payment methods that are eligible for the selected basket.

Description

Returns the list of payment methods that are eligible for the selected basket. If there are no eligible payment methods available, an empty list will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.BasketEligiblePaymentMethodListResource.getEligiblePaymentMethods_V1(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects (as a comma separated list) which are to be included with the response. | Possible Values: allpaymentInstruments

Response

200 - OK

The list of eligible payment methods.
PaymentMethodListCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.
/baskets/{BasketResourceKey}/payment-instruments
POST: [BETA] Adds a payment instrument to the basket.

Description

Adds a payment instrument to the basket. This creates new payment instrument in the basket.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentInstrumentListResource.createPaymentInstrument_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentInstrumentRO,java.lang.String)

Request Body

PaymentInstrumentRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects which are to be included with the response. | Possible Values: allpaymentMethod

Response

201 - Created

The newly created payment instrument with the data provided.
PaymentInstrumentCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.

422 - Unprocessable Entity

A list of (semantical) error messages, if the payment instrument could not be created.
FeedbackCtnrRO_v1 application/json
/baskets/{BasketResourceKey}/payment-instruments/{PaymentInstrumentKey}
DELETE: [BETA] Deletes the payment instrument with the given ID

Description

This operation deletes the payment instrument with the given ID. If no payment instrument with this ID is found, a 404 error will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentInstrumentItemResource.deletePaymentInstrument_V1()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathPaymentInstrumentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

Information message describing success status.
PaymentInstrumentCtnrRO_v1 application/json

404 - Not Found

A payment instrument with the given ID was not found.
PaymentInstrumentCtnrRO_v1 application/json
PATCH: [BETA] Partially updates the payment instrument with the given ID

Description

This operation updates the payment instrument with the given ID partially. If no payment instrument with this ID is found, a 404 error will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentInstrumentItemResource.updatePaymentInstrument_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentInstrumentRO,java.lang.String)

Request Body

PaymentInstrumentRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathPaymentInstrumentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects which are to be retrieved with the response. | Possible Values: allpaymentMethod

Response

200 - OK

Information message describing success status.
PaymentInstrumentCtnrRO_v1 application/json

404 - Not Found

A payment instrument with the given ID was not found.
PaymentInstrumentCtnrRO_v1 application/json
/baskets/{BasketResourceKey}/payments
GET: [BETA] Returns the list of payments assigned to the current basket.

Description

--

Java Method

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

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects (as a comma separated list) which are to be included with the response. | Possible Values: allpaymentInstrumentpaymentMethod

Response

200 - OK

The list of payments.
PaymentCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.
POST: [BETA] Creates a new payment from a given payment instrument.

Description

Creates a new payment in the given basket using the payment instrument from the request payload. This can be used to create payments for limited tender payment instruments (e. g. gift cards) as well as for open tender payment instruments (e. g. credit cards). However, the request will still fail with an "422 Unprocessable Entity" error when trying to create an open tender payment when there already is an open tender payment in the basket. If an open tender payment is to be replaced, use the "PUT" method on the item resource with ID "open-tender". An open tender payment can also not be created if the basket is already fully covered by limited tender payments. If a limited tender payment is to be created and an open tender payment is already present, then the latter may be removed if the limited tender fully covers the basket; in that case no further limited tender payments can be created afterwards. In general, limited tender payments always have a higher priority than open tenders. If the payment could not be created for other reasons, a "422 Unprocessable Entity" error with a specific error message will also be returned. In case that the applied payment instrument supports redirect, it is possible to append success, cancel and failure redirect URL. Otherwise it is ignored.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentListResource.createPayment_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO,java.lang.String)

Request Body

PaymentRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects (as a comma separated list) which are to be included with the response. | Possible Values: allpaymentInstrumentpaymentMethod

Response

201 - Created

Information message describing success status.
PaymentCtnrRO_v1 application/json

422 - Unprocessable Entity

If the payment could not be created.
PaymentCtnrRO_v1 application/json
/baskets/{BasketResourceKey}/payments/{BasketPaymentKey}
PUT: [BETA] Creates (or replaces) the payment with the given ID.

Description

Creates (or replaces) the payment with the given ID. If the payment could not be created, a 422 error will be returned. Note that this will only work for open tender payments, i. e. where the ID is 'open-tender'. Other payments are not supported via this method and a 405 error will be returned for those. An open tender payment can only be created, if the basket is not already fully covered by limited tenders. For creating a new limited tender payment, use the POST method on the list resource. Updating or replacing an existing limited tender payment is never supported, it needs to be deleted and re-created.In case that the applied payment instrument supports redirect, it is possible to append success, cancel and failure redirect URL. Otherwise it is ignored.

Java Method

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

Request Body

PaymentRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketPaymentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects (as a comma separated list) which are to be included with the response. | Possible Values: allpaymentInstrumentpaymentMethod

Response

201 - Created

Information message describing success status.
PaymentCtnrRO_v1 application/json

422 - Unprocessable Entity

If the payment could not be created.
PaymentCtnrRO_v1 application/json
DELETE: [BETA] Deletes the payment with the given ID.

Description

Deletes the payment with the given ID. If no payment with this ID is found, a 404 error will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.payment.PaymentItemResource.deletePayment_V1()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketPaymentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

Information message describing success status.
PaymentCtnrRO_v1 application/json

404 - Not Found

If a payment with the given ID is not found.
PaymentCtnrRO_v1 application/json
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.basket.v1.capi.resource.payment.PaymentItemResource.updatePayment_V1(com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO,java.lang.String)

Request Body

PaymentRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketPaymentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects (as a comma separated list) which are to be included with the response. | Possible Values: allpaymentInstrumentpaymentMethod

Response

200 - OK

Information message describing success status.
PaymentCtnrRO_v1 application/json

422 - Unprocessable Entity

If the payment could not be updated.
PaymentCtnrRO_v1 application/json

Promotion Code (beta) API

/baskets/{BasketResourceKey}/promotioncodes
GET: [BETA] Returns the list of promotion codes that have been applied at the selected basket.

Description

--

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeListResource.getPromotionCodes_V1()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

The list of promotion codes.
ContainerRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.
POST: [BETA] Adds a promotion code to the basket.

Description

--

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeListResource.addPromotionCode_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.promotion.PromotionCodeRO)

Request Body

BasketPromotionCodeRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

201 - Created

The newly added promotion code, if it was added successfully.
ContainerRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.

422 - Unprocessable Entity

A list of (semantical) error messages, if the promotion code could not be added.
FeedbackCtnrRO_v1 application/json
/baskets/{BasketResourceKey}/promotioncodes/{BasketPromotionCodeKey}
GET: [BETA] Returns the promotion code data for the given promotion code string.

Description

Returns the promotion code data for the given promotion code string. If no promotion code with this string is found, a 404 error will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeItemResource.getPromotionCode_V1()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketPromotionCodeKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

The promotion code data for the given promotion code string.
ContainerRO_v1 application/json

404 - Not Found

If a promotion code with the given string is not found in the basket.
FeedbackCtnrRO_v1 application/json
DELETE: [BETA] Removes the promotion code with the given string from the basket.

Description

Removes the promotion code with the given string from the basket. If no address with this string is found, a 404 error will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.promotion.BasketPromotionCodeItemResource.removePromotionCode_V1()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketPromotionCodeKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

Information message describing success status.
ContainerRO_v1 application/json

404 - Not Found

If an promotion code with the given ID is not found in the basket.
FeedbackCtnrRO_v1 application/json

Shipping Bucket (beta) API

/baskets/{BasketResourceKey}/buckets
GET: [BETA] Returns the list of shipping buckets for the selected basket.

Description

Returns the list of shipping buckets for the selected basket. 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.basket.v1.capi.resource.shipping.ShippingBucketListResource.getShippingBuckets_V1(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects which are to be included with the response. | Possible Values: alldiscountsshipToAddressshippingMethod

Response

200 - OK

The list of shipping buckets.
BasketShippingBucketListCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.
/baskets/{BasketResourceKey}/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.basket.v1.capi.resource.shipping.ShippingBucketItemResource.getShippingBucket_V1(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathShippingBucketKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects (as a comma separated list) which are to be included with the response. | Possible Values: alldiscountsshipToAddressshippingMethod

Response

200 - OK

The shipping bucket.
BasketShippingBucketCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.

404 - Not Found

If a shipping bucket with the given ID is not found in the basket.
BasketShippingBucketCtnrRO_v1 application/json
PATCH: [BETA] Updates the shipping bucket with the given ID.

Description

Updates the shipping bucket with the given ID. If no shipping bucket with this ID is found, a 404 error will be returned. If for some reason the shipping bucket could not be updated, a 422 error will be returned. Note that manipulating the shipping bucket may cause a change in the shipping bucket ID, as IDs are determined dynamically through a hash over all items in the bucket. This means a bucket with a different ID may be returned in the response (e. g. when multiple shipping buckets are merged by changing the ship-to address or shipping method). When this happens, the whole shipping bucket list should be retrieved again before displaying it the next time (as other buckets may havebeen changed or removed as well).

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketItemResource.updateShippingBucket_V1(com.intershop.sellside.rest.basket.v1.capi.resourceobject.shipping.ShippingBucketRO,java.lang.String)

Request Body

BasketShippingBucketRO_v1 application/json

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathShippingBucketKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludearrayRelated objects which are to be included with the response. | Possible Values: alldiscountsshipToAddressshippingMethod

Response

200 - OK

Information message describing success status.
BasketShippingBucketCtnrRO_v1 application/json

404 - Not Found

If a shipping bucket with the given ID is not found in the basket.
FeedbackCtnrRO_v1 application/json

422 - Unprocessable Entity

If the shipping bucket could not be updated.
BasketShippingBucketCtnrRO_v1 application/json

Shipping Method (beta) API

/baskets/{BasketResourceKey}/buckets/{ShippingBucketKey}/eligible-shipping-methods
GET: [BETA] Returns the list of shipping methods that are eligible for the selected shipping bucket.

Description

Returns the list of shipping methods that are eligible for the selected shipping bucket. This will only return common shipping methods that are valid for all line items in the shipping bucket.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.ShippingBucketEligibleShippingMethodListResource.getEligibleShippingMethods_V1(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathShippingBucketKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects (as a comma separated list) which are to be included with the response.

Response

200 - OK

The list of eligible shipping methods.
BasketShippingMethodListCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.
/baskets/{BasketResourceKey}/eligible-shipping-methods
GET: [BETA] Returns the list of shipping methods that are eligible for the selected basket.

Description

Returns the list of shipping methods that are eligible for the selected basket. This will only return common shipping methods that are valid for all line items. If there are no common shipping methods, an empty list will be returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.BasketEligibleShippingMethodListResource.getEligibleShippingMethods_V1(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects (as a comma separated list) which are to be included with the response.

Response

200 - OK

The list of eligible shipping methods.
BasketShippingMethodListCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.
/baskets/{BasketResourceKey}/items/{BasketLineKey}/eligible-shipping-methods
GET: [BETA] Returns the list of shipping methods that are eligible for the selected line item.

Description

Returns the list of shipping methods that are eligible for the selected line item.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.basket.v1.capi.resource.shipping.LineItemEligibleShippingMethodListResource.getEligibleShippingMethods_V1(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathBasketResourceKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathBasketLineKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryincludestringRelated objects (as a comma separated list) which are to be included with the response.

Response

200 - OK

The list of eligible shipping methods.
BasketShippingMethodListCtnrRO_v1 application/json

401 - Unauthorized

If the user couldn't be authenticated.

Request and Response Object Schemata

AddressCtnrRO_v1 application/json{
  • "data":
    object
    A AddressRO_v1 object. The address
    {
    • "addressLine1":
      string
      The first address line, that usual contains street and house number. | Example: Berliner Str. 20
    • "addressLine2":
      string
      The second address line.
    • "addressLine3":
      string
      The third address line.
    • "aristocraticTitle":
      string
      The aristocratic title of the contact person, like 'Lord' or 'Lady'.
    • "attributes":
      array
      An array of AttributeRO_v1 objects.
      [
      AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
      {
      • "name":
        string
        Required | The name of an element.
      • "type":
        string
        Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
      • "value":
        object
      }
      ]
    • "city":
      string
      The name of the city. | Example: Potsdam
    • "companyName1":
      string
      The company name in case it is a business address. | Example: Intershop Communications AG
    • "companyName2":
      string
      The second company name
    • "country":
      string
      Readonly | The localized display name of the country | Example: Germany
    • "countryCode":
      string
      The ISO 3166-1 country code | Example: DE
    • "customer":
      string
    • "eligibleInstallToAddress":
      boolean
      Flag indicating that the address can be used as install-to address. | Example: false
    • "eligibleInvoiceToAddress":
      boolean
      Flag indicating that the address can be used as invoice-to address. | Example: true
    • "eligibleServiceToAddress":
      boolean
      Flag indicating that the address can be used as service-to address. | Example: false
    • "eligibleShipFromAddress":
      boolean
      Flag indicating that the address can be used as ship-from address. | Example: false
    • "eligibleShipToAddress":
      boolean
      Flag indicating that the address can be used as ship-to address. | Example: true
    • "email":
      string
      The e-mail address of the contact person. | Example: patricia@test.intershop.de
    • "externalId":
      string
      The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
    • "externalUrn":
      string
      The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
    • "fax":
      string
      The fax number.
    • "firstName":
      string
      The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
    • "honorific":
      string
      The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
    • "id":
      string
      The ID that identifies the address. | Example: 0987654321
    • "jobTitle":
      string
      The job title of the contact person.
    • "lastName":
      string
      The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
    • "mainDivision":
      string
      Readonly | The localized display name of the main division | Example: Alabama
    • "mainDivisionCode":
      string
      The main division code of the country, e. g. a state or province. | Example: Al
    • "phoneBusiness":
      string
      The phone number of the contact person's company.
    • "phoneBusinessDirect":
      string
      The business phone number of the contact person that allows an outside caller to connect directly to the
      contact person without any help of an attendant or operator.
    • "phoneHome":
      string
      The phone number of the house or apartment where the contact person lives. | Example: 049364112677
    • "phoneMobile":
      string
      The number of the contact person's cell phone.
    • "postBox":
      string
      The post-office box.
    • "postalCode":
      string
      The postal code of the city. | Example: 14482
    • "secondLastName":
      string
      The second last name of the contact person.
    • "secondName":
      string
      The second given name of the contact person.
    • "subDivision":
      string
      Readonly | The localized display name of the sub division. | Example: City of Westminster
    • "subDivisionCode":
      string
      The sub division code. | Example: 020
    • "title":
      string
      The (personal) title of the contact person. | Example: Ms.
    • "urn":
      string
      The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
    • "usage":
      object
      The usage information for the address. Every bit in the returned set marks a specific usage type: [invoice-to, ship-to, ship-from, service-to, install-to]. If a bit is set, the address may be used for the specific purpose mapped to this bit. By default, all values are set to true.
      {
      • "empty":
        boolean
      }
    }
  • "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.
}
AddressListCtnrRO_v1 application/json{
  • "data":
    array
    An array of AddressRO_v1 objects. The core data of the response object.
    [
    AddressRO_v1: The address
    {
    • "addressLine1":
      string
      The first address line, that usual contains street and house number. | Example: Berliner Str. 20
    • "addressLine2":
      string
      The second address line.
    • "addressLine3":
      string
      The third address line.
    • "aristocraticTitle":
      string
      The aristocratic title of the contact person, like 'Lord' or 'Lady'.
    • "attributes":
      array
      An array of AttributeRO_v1 objects.
      [
      AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
      {
      • "name":
        string
        Required | The name of an element.
      • "type":
        string
        Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
      • "value":
        object
      }
      ]
    • "city":
      string
      The name of the city. | Example: Potsdam
    • "companyName1":
      string
      The company name in case it is a business address. | Example: Intershop Communications AG
    • "companyName2":
      string
      The second company name
    • "country":
      string
      Readonly | The localized display name of the country | Example: Germany
    • "countryCode":
      string
      The ISO 3166-1 country code | Example: DE
    • "customer":
      string
    • "eligibleInstallToAddress":
      boolean
      Flag indicating that the address can be used as install-to address. | Example: false
    • "eligibleInvoiceToAddress":
      boolean
      Flag indicating that the address can be used as invoice-to address. | Example: true
    • "eligibleServiceToAddress":
      boolean
      Flag indicating that the address can be used as service-to address. | Example: false
    • "eligibleShipFromAddress":
      boolean
      Flag indicating that the address can be used as ship-from address. | Example: false
    • "eligibleShipToAddress":
      boolean
      Flag indicating that the address can be used as ship-to address. | Example: true
    • "email":
      string
      The e-mail address of the contact person. | Example: patricia@test.intershop.de
    • "externalId":
      string
      The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
    • "externalUrn":
      string
      The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
    • "fax":
      string
      The fax number.
    • "firstName":
      string
      The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
    • "honorific":
      string
      The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
    • "id":
      string
      The ID that identifies the address. | Example: 0987654321
    • "jobTitle":
      string
      The job title of the contact person.
    • "lastName":
      string
      The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
    • "mainDivision":
      string
      Readonly | The localized display name of the main division | Example: Alabama
    • "mainDivisionCode":
      string
      The main division code of the country, e. g. a state or province. | Example: Al
    • "phoneBusiness":
      string
      The phone number of the contact person's company.
    • "phoneBusinessDirect":
      string
      The business phone number of the contact person that allows an outside caller to connect directly to the
      contact person without any help of an attendant or operator.
    • "phoneHome":
      string
      The phone number of the house or apartment where the contact person lives. | Example: 049364112677
    • "phoneMobile":
      string
      The number of the contact person's cell phone.
    • "postBox":
      string
      The post-office box.
    • "postalCode":
      string
      The postal code of the city. | Example: 14482
    • "secondLastName":
      string
      The second last name of the contact person.
    • "secondName":
      string
      The second given name of the contact person.
    • "subDivision":
      string
      Readonly | The localized display name of the sub division. | Example: City of Westminster
    • "subDivisionCode":
      string
      The sub division code. | Example: 020
    • "title":
      string
      The (personal) title of the contact person. | Example: Ms.
    • "urn":
      string
      The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
    • "usage":
      object
      The usage information for the address. Every bit in the returned set marks a specific usage type: [invoice-to, ship-to, ship-from, service-to, install-to]. If a bit is set, the address may be used for the specific purpose mapped to this bit. By default, all values are set to true.
      {
      • "empty":
        boolean
      }
    }
    ]
  • "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.
}
AddressRO_v1 application/json{
  • "addressLine1":
    string
    The first address line, that usual contains street and house number. | Example: Berliner Str. 20
  • "addressLine2":
    string
    The second address line.
  • "addressLine3":
    string
    The third address line.
  • "aristocraticTitle":
    string
    The aristocratic title of the contact person, like 'Lord' or 'Lady'.
  • "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    • "name":
      string
      Required | The name of an element.
    • "type":
      string
      Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    • "value":
      object
    }
    ]
  • "city":
    string
    The name of the city. | Example: Potsdam
  • "companyName1":
    string
    The company name in case it is a business address. | Example: Intershop Communications AG
  • "companyName2":
    string
    The second company name
  • "country":
    string
    Readonly | The localized display name of the country | Example: Germany
  • "countryCode":
    string
    The ISO 3166-1 country code | Example: DE
  • "customer":
    string
  • "eligibleInstallToAddress":
    boolean
    Flag indicating that the address can be used as install-to address. | Example: false
  • "eligibleInvoiceToAddress":
    boolean
    Flag indicating that the address can be used as invoice-to address. | Example: true
  • "eligibleServiceToAddress":
    boolean
    Flag indicating that the address can be used as service-to address. | Example: false
  • "eligibleShipFromAddress":
    boolean
    Flag indicating that the address can be used as ship-from address. | Example: false
  • "eligibleShipToAddress":
    boolean
    Flag indicating that the address can be used as ship-to address. | Example: true
  • "email":
    string
    The e-mail address of the contact person. | Example: patricia@test.intershop.de
  • "externalId":
    string
    The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
  • "externalUrn":
    string
    The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
  • "fax":
    string
    The fax number.
  • "firstName":
    string
    The given name (also known as a personal name, first name, forename, or Christian name) of the contact person | Example: Patricia
  • "honorific":
    string
    The honorific title of the contact person that denotes the honored person's occupation, like 'Captain', 'Reverend' or the academic title, like 'PhD'.
  • "id":
    string
    The ID that identifies the address. | Example: 0987654321
  • "jobTitle":
    string
    The job title of the contact person.
  • "lastName":
    string
    The last name (also known as a family name, surname, or gentile name) of the contact person. | Example: Miller
  • "mainDivision":
    string
    Readonly | The localized display name of the main division | Example: Alabama
  • "mainDivisionCode":
    string
    The main division code of the country, e. g. a state or province. | Example: Al
  • "phoneBusiness":
    string
    The phone number of the contact person's company.
  • "phoneBusinessDirect":
    string
    The business phone number of the contact person that allows an outside caller to connect directly to the
    contact person without any help of an attendant or operator.
  • "phoneHome":
    string
    The phone number of the house or apartment where the contact person lives. | Example: 049364112677
  • "phoneMobile":
    string
    The number of the contact person's cell phone.
  • "postBox":
    string
    The post-office box.
  • "postalCode":
    string
    The postal code of the city. | Example: 14482
  • "secondLastName":
    string
    The second last name of the contact person.
  • "secondName":
    string
    The second given name of the contact person.
  • "subDivision":
    string
    Readonly | The localized display name of the sub division. | Example: City of Westminster
  • "subDivisionCode":
    string
    The sub division code. | Example: 020
  • "title":
    string
    The (personal) title of the contact person. | Example: Ms.
  • "urn":
    string
    The URN representation of this address. | Example: urn:address:customer:1234567890:0987654321
  • "usage":
    object
    The usage information for the address. Every bit in the returned set marks a specific usage type: [invoice-to, ship-to, ship-from, service-to, install-to]. If a bit is set, the address may be used for the specific purpose mapped to this bit. By default, all values are set to true.
    {
    • "empty":
      boolean
    }
}
AttributeCtnrRO_v1 application/json{
  • "data":
    object
    A AttributeRO_v1Object object. A representation of an attribute.
    {
    • "name":
      string
      Required | The name of an element.
    • "type":
      string
      Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    • "value":
      object
    }
  • "errors":
    array
    Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
    [
    FeedbackRO_v1: An error or information representation regarding the current request.
    {
    • "causes":
      array
      An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
      [
      FeedbackCauseRO_v1: A representation for the common feedback informations.
      {
      • "code":
        string
        Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
      • "message":
        string
        Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
      • "parameters":
        object
        A map of several parameters that are used to assemble the message.
      • "paths":
        array
        An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
      }
      ]
    • "code":
      string
      An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
    • "message":
      string
      A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
    • "parameters":
      object
      A map of several parameters that are used to assemble the message.
    • "paths":
      array
      An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
    • "status":
      string
      The HTTP status code, that is applicable to this problem. | Example: 400
    }
    ]
  • "included":
    object
    Optionally included related data objects.
  • "infos":
    array
    Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
    [
    FeedbackRO_v1: An error or information representation regarding the current request.
    {
    • "causes":
      array
      An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
      [
      FeedbackCauseRO_v1: A representation for the common feedback informations.
      {
      • "code":
        string
        Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
      • "message":
        string
        Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
      • "parameters":
        object
        A map of several parameters that are used to assemble the message.
      • "paths":
        array
        An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
      }
      ]
    • "code":
      string
      An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
    • "message":
      string
      A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
    • "parameters":
      object
      A map of several parameters that are used to assemble the message.
    • "paths":
      array
      An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
    • "status":
      string
      The HTTP status code, that is applicable to this problem. | Example: 400
    }
    ]
  • "links":
    object
    Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}
AttributeListCtnrRO_v1 application/json{
  • "data":
    array
    An array of AttributeRO_v1Object objects. The core data of the response object.
    [
    AttributeRO_v1Object: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    • "name":
      string
      Required | The name of an element.
    • "type":
      string
      Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    • "value":
      object
    }
    ]
  • "errors":
    array
    Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
    [
    FeedbackRO_v1: An error or information representation regarding the current request.
    {
    • "causes":
      array
      An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
      [
      FeedbackCauseRO_v1: A representation for the common feedback informations.
      {
      • "code":
        string
        Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
      • "message":
        string
        Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
      • "parameters":
        object
        A map of several parameters that are used to assemble the message.
      • "paths":
        array
        An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
      }
      ]
    • "code":
      string
      An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
    • "message":
      string
      A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
    • "parameters":
      object
      A map of several parameters that are used to assemble the message.
    • "paths":
      array
      An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
    • "status":
      string
      The HTTP status code, that is applicable to this problem. | Example: 400
    }
    ]
  • "included":
    object
    Optionally included related data objects.
  • "infos":
    array
    Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
    [
    FeedbackRO_v1: An error or information representation regarding the current request.
    {
    • "causes":
      array
      An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
      [
      FeedbackCauseRO_v1: A representation for the common feedback informations.
      {
      • "code":
        string
        Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
      • "message":
        string
        Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
      • "parameters":
        object
        A map of several parameters that are used to assemble the message.
      • "paths":
        array
        An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
      }
      ]
    • "code":
      string
      An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
    • "message":
      string
      A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
    • "parameters":
      object
      A map of several parameters that are used to assemble the message.
    • "paths":
      array
      An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
    • "status":
      string
      The HTTP status code, that is applicable to this problem. | Example: 400
    }
    ]
  • "links":
    object
    Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}
AttributeRO_v1 application/json{
  • "name":
    string
    Required | The name of an element.
  • "type":
    string
    Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
  • "value":
    object
}
BasketCtnrRO_v1 application/json{
  • "data":
    object
    A BasketRO_v1 object. A representation of a basket
    {
    • "affiliatePartner":
      string
      The affiliate partner id of the basket. | Example: 4bcKAB2Ykg4AAAFbjvEYRPJ7
    • "affiliateProgram":
      string
      The affiliate program id of the basket. | Example: uzMKAB2YvKAAAAFb7DUYRPJ8
    • "approval":
      object
      A ApprovalRO_v1 object. A representation of a basket approval
      {
      • "approvalRequired":
        boolean
        Flag indicating that this basket needs an approval. | Example: true
      • "costCenterApproval":
        object
        A ApprovalCostCenterRO_v1 object. A representation of a cost center approval
        {
        • "approvers":
          array
          An array of ApprovalUserRO_v1 objects. The cost center approvers.
          [
          ApprovalUserRO_v1: Represents an approval user item.
          {
          • "email":
            string
            The email address of the person represented by this user. | Example: Merkel@test.intershop.de
          • "firstName":
            string
            The given name (also known as a personal name, first name, forename) of the person represented by this user. | Example: Peter
          • "lastName":
            string
            The surname (also known as a family name, last name) of the person represented by this user. | Example: Merkel
          • "title":
            string
            The personal title, like Ms., Mr. | Example: Mr.
          }
          ]
        • "costCenterID":
          string
          The cost center ID.
        • "costCenterName":
          string
          The cost center name.
        }
      • "customerApproval":
        object
        A ApprovalCustomerRO_v1 object. A representation of a customer approval
        {
        • "approvers":
          array
          An array of ApprovalUserRO_v1 objects. The customer approvers.
          [
          ApprovalUserRO_v1: Represents an approval user item.
          {
          • "email":
            string
            The email address of the person represented by this user. | Example: Merkel@test.intershop.de
          • "firstName":
            string
            The given name (also known as a personal name, first name, forename) of the person represented by this user. | Example: Peter
          • "lastName":
            string
            The surname (also known as a family name, last name) of the person represented by this user. | Example: Merkel
          • "title":
            string
            The personal title, like Ms., Mr. | Example: Mr.
          }
          ]
        }
      }
    • "attributes":
      array
      An array of AttributeRO_v1 objects.
      [
      AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
      {
      • "name":
        string
        Required | The name of an element.
      • "type":
        string
        Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
      • "value":
        object
      }
      ]
    • "buckets":
      array
      An array of string literals. The bucket ids of all shipping buckets of a basket.
    • "calculated":
      boolean
      The calculation state of the basket. By default the basket will always be calculated after an update. By settings this to 'false', the basket will not be calculated. Note that the calculation results of a previous calculation will still be present in this case.
    • "commonShipToAddress":
      string
      The common ship-to address URN of the basket. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
    • "commonShippingMethod":
      string
      The common shipping method id of the basket. | Example: STD_5DAY
    • "costCenter":
      string
      The cost center id of the basket. | Example: 511288
    • "coveredByLimitedTenders":
      boolean
      Readonly | The flag specifying whether the basket total amount is covered by limited tender payments. If this is the case, then no further limited tender payments can be created. Note that this information depends on the basket calculation (see "calculated" property). It may not be accurate if the basket is not calculated.
    • "customer":
      string
      Readonly | The basket owner customer number.
    • "department":
      string
      The department name of the basket. | Example: SALES
    • "discounts":
      object
      A BasketDiscountsRO_v1 object. Provides details about the applied discounts.
      {
      • "dynamicMessages":
        array
        Readonly | An array of string literals. The dynamic messages for a basket.
      • "freeGiftDiscounts":
        array
        Readonly | An array of string literals. The IDs of all free gift discounts granted on the basket.
      • "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 basket total.
      }
    • "documentNumber":
      string
      Readonly | The document number of a basket. It is currently only set if basket is in status waiting for approval after submitting.
    • "externalOrderReference":
      string
      The external order reference id of the basket. | Example: 30000008899
    • "id":
      string
      The ID of the basket. | Example: q2QKAEsBiyQAAAFjXFBB6G14
    • "invoiceToAddress":
      string
      The invoice-to address URN of the basket. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
    • "lineItems":
      array
      An array of string literals. The ids of all line items of a basket.
    • "messageToMerchant":
      string
      Something what the buyer would like to tell the merchant. | Example: Is it possible to send the ordered articles before Christmas?
    • "payments":
      array
      An array of string literals. The payments used to pay the basket.
    • "promotionCodes":
      array
      An array of string literals. The promotion codes of the basket.
    • "purchaseCurrency":
      string
      Readonly | The purchase currency of the basket. | Example: USD
    • "recurrence":
      object
      A BasketRecurrenceRO_v1 object. Recurrence data which are associated with a basket.
      {
      • "endDate":
        string
        Required | The end date of a recurrence. | Format: date-time | Example: 2020-05-23T11:23:45.000Z
      • "executeMissedOrders":
        boolean
        The execute missed orders flag. | Example: false
      • "interval":
        object
        Required | The interval of a recurrence. | Example: P6Y11M27D
        {
        • "years":
          integer
          Format: int32
        • "months":
          integer
          Format: int32
        • "days":
          integer
          Format: int32
        • "negative":
          boolean
        • "zero":
          boolean
        • "units":
          array
          An array of object literals.
          [
          {
          • "duration":
            object
            {
            • "seconds":
              integer
              Format: int64
            • "negative":
              boolean
            • "nano":
              integer
              Format: int32
            • "zero":
              boolean
            }
          • "dateBased":
            boolean
          • "timeBased":
            boolean
          • "durationEstimated":
            boolean
          }
          ]
        • "chronology":
          object
          {
          • "calendarType":
            string
          • "id":
            string
          }
        }
      • "repetitions":
        integer
        Required | The repetitions of a recurrence. | Format: int32 | Example: 24
      • "startDate":
        string
        Required | The start date of a recurrence. | Format: date-time | Example: 2020-05-23T11:23:45.000Z
      }
    • "recurringOrderDocumentNo":
      string
      Readonly | The recurring order number.
    • "surcharges":
      object
      A BasketSurchargesRO_v1 object. Surcharges that are applied to a basket.
      {
      • "bucketSurcharges":
        array
        Readonly | An array of BasketSurchargeRO_v1 objects. All bucket based extra charges arising from surcharges with action type 'bucket'.
        [
        BasketSurchargeRO_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
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "net":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "tax":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | 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
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "effectiveTaxRate":
            number
            Required | The effective rate used to calculate the tax.
          • "jurisdiction":
            object
            A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
            {
            • "id":
              string
              The jurisdiction ID. | Example: CANADA
            • "level":
              string
              The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
            }
          • "nonTaxableAmount":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "situs":
            string
            Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
          • "taxableAmount":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          }
          ]
        }
        ]
      • "itemSurcharges":
        array
        Readonly | An array of BasketSurchargeRO_v1 objects. All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item'.
        [
        BasketSurchargeRO_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
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "net":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "tax":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | 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
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "effectiveTaxRate":
            number
            Required | The effective rate used to calculate the tax.
          • "jurisdiction":
            object
            A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
            {
            • "id":
              string
              The jurisdiction ID. | Example: CANADA
            • "level":
              string
              The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
            }
          • "nonTaxableAmount":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "situs":
            string
            Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
          • "taxableAmount":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          }
          ]
        }
        ]
      }
    • "taxIdentificationNumber":
      string
      The tax identification number of the buyer/company. | Example: 11111111
    • "totalProductQuantity":
      number
      Readonly | The sum of all quantities of products in the basket. | Example: 23
    • "totals":
      object
      A BasketTotalsRO_v1 object. Total price values for a basket.
      {
      • "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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "basketShippingDiscountsTotal":
        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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "basketValueDiscountsTotal":
        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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "salesTaxTotalsByTaxRate":
        array
        Readonly | An array of TaxItemRO_v1 objects. All sales taxes applied to the basket, accumulated by their tax rates.
        [
        TaxItemRO_v1: Represents a single tax item.
        {
        • "calculatedTax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "effectiveTaxRate":
          number
          Required | The effective rate used to calculate the tax.
        • "jurisdiction":
          object
          A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
          {
          • "id":
            string
            The jurisdiction ID. | Example: CANADA
          • "level":
            string
            The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
          }
        • "nonTaxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "situs":
          string
          Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
        • "taxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "shippingTaxTotalsByTaxRate":
        array
        Readonly | An array of TaxItemRO_v1 objects. All shipping taxes applied to the basket, accumulated by their tax rates.
        [
        TaxItemRO_v1: Represents a single tax item.
        {
        • "calculatedTax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "effectiveTaxRate":
          number
          Required | The effective rate used to calculate the tax.
        • "jurisdiction":
          object
          A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
          {
          • "id":
            string
            The jurisdiction ID. | Example: CANADA
          • "level":
            string
            The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
          }
        • "nonTaxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "situs":
          string
          Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
        • "taxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "taxTotalsByTaxRate":
        array
        Readonly | An array of TaxItemRO_v1 objects. All taxes applied to the basket, accumulated by their tax rates (includes taxes levied to sales, prices, shipping and surcharges.
        [
        TaxItemRO_v1: Represents a single tax item.
        {
        • "calculatedTax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "effectiveTaxRate":
          number
          Required | The effective rate used to calculate the tax.
        • "jurisdiction":
          object
          A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
          {
          • "id":
            string
            The jurisdiction ID. | Example: CANADA
          • "level":
            string
            The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
          }
        • "nonTaxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "situs":
          string
          Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
        • "taxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      }
    • "user":
      string
      Readonly | The basket 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.
}
BasketLineItemCtnrRO_v1 application/json{
  • "data":
    object
    A BasketLineItemRO_v1 object. Describes a line item that has been added to a basket.
    {
    • "attributes":
      array
      An array of AttributeRO_v1 objects.
      [
      AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
      {
      • "name":
        string
        Required | The name of an element.
      • "type":
        string
        Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
      • "value":
        object
      }
      ]
    • "basket":
      string
      Readonly | The basket this line item belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
    • "calculated":
      boolean
      The calculation state of the line item. By default the line item will always be calculated after an update. By settings this to 'false', the line item will not be calculated. Note that the calculation results of a previous calculation will still be present in this case. Also note that by setting this to 'true', not only the line item, but the whole basket is calculated.
    • "desiredDelivery":
      string
      The desired delivery date for the Item. | Format: date
    • "discounts":
      array
      Readonly | An array of string literals. The IDs of the discounts applied to the item pricing.
    • "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
    • "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.
    • "position":
      integer
      The position of the item in the basket. | Format: int32
    • "pricing":
      object
      A BasketLineItemPricingRO_v1 object. total price values of a line item that has been added to a basket
      {
      • "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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "salesTaxTotal":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "shippingTaxTotal":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      }
    • "product":
      string
      Required | The product represented as stock keeping unit (SKU). | Example: 5079747
    • "quantity":
      object
      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
      }
    • "quantityFixed":
      boolean
      Flag indicating that this product line item quantity is not changeable. | Example: true
    • "quote":
      string
      The quote this item was created from. | Example: Qu0T3MgoyuMAx9Es2sx0Ue1
    • "shipToAddress":
      string
      The ship-to address URN for this bucket. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
    • "shippingMethod":
      string
      The shipping method id for this bucket. | Example: STD_5DAY
    • "surcharges":
      array
      Readonly | An array of BasketSurchargeRO_v1 objects. Details about additional surcharges applied to the item.
      [
      BasketSurchargeRO_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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "effectiveTaxRate":
          number
          Required | The effective rate used to calculate the tax.
        • "jurisdiction":
          object
          A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
          {
          • "id":
            string
            The jurisdiction ID. | Example: CANADA
          • "level":
            string
            The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
          }
        • "nonTaxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "situs":
          string
          Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
        • "taxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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.
}
BasketLineItemListCtnrRO_v1 application/json{
  • "data":
    array
    An array of BasketLineItemRO_v1 objects. The core data of the response object.
    [
    BasketLineItemRO_v1: Describes a line item that has been added to a basket.
    {
    • "attributes":
      array
      An array of AttributeRO_v1 objects.
      [
      AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
      {
      • "name":
        string
        Required | The name of an element.
      • "type":
        string
        Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
      • "value":
        object
      }
      ]
    • "basket":
      string
      Readonly | The basket this line item belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
    • "calculated":
      boolean
      The calculation state of the line item. By default the line item will always be calculated after an update. By settings this to 'false', the line item will not be calculated. Note that the calculation results of a previous calculation will still be present in this case. Also note that by setting this to 'true', not only the line item, but the whole basket is calculated.
    • "desiredDelivery":
      string
      The desired delivery date for the Item. | Format: date
    • "discounts":
      array
      Readonly | An array of string literals. The IDs of the discounts applied to the item pricing.
    • "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
    • "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.
    • "position":
      integer
      The position of the item in the basket. | Format: int32
    • "pricing":
      object
      A BasketLineItemPricingRO_v1 object. total price values of a line item that has been added to a basket
      {
      • "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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "salesTaxTotal":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "shippingTaxTotal":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      }
    • "product":
      string
      Required | The product represented as stock keeping unit (SKU). | Example: 5079747
    • "quantity":
      object
      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
      }
    • "quantityFixed":
      boolean
      Flag indicating that this product line item quantity is not changeable. | Example: true
    • "quote":
      string
      The quote this item was created from. | Example: Qu0T3MgoyuMAx9Es2sx0Ue1
    • "shipToAddress":
      string
      The ship-to address URN for this bucket. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
    • "shippingMethod":
      string
      The shipping method id for this bucket. | Example: STD_5DAY
    • "surcharges":
      array
      Readonly | An array of BasketSurchargeRO_v1 objects. Details about additional surcharges applied to the item.
      [
      BasketSurchargeRO_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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "effectiveTaxRate":
          number
          Required | The effective rate used to calculate the tax.
        • "jurisdiction":
          object
          A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
          {
          • "id":
            string
            The jurisdiction ID. | Example: CANADA
          • "level":
            string
            The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
          }
        • "nonTaxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "situs":
          string
          Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
        • "taxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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.
}
BasketLineItemRO_v1 application/json[
BasketLineItemRO_v1: Describes a line item that has been added to a basket.
{
  • "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    • "name":
      string
      Required | The name of an element.
    • "type":
      string
      Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    • "value":
      object
    }
    ]
  • "basket":
    string
    Readonly | The basket this line item belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
  • "calculated":
    boolean
    The calculation state of the line item. By default the line item will always be calculated after an update. By settings this to 'false', the line item will not be calculated. Note that the calculation results of a previous calculation will still be present in this case. Also note that by setting this to 'true', not only the line item, but the whole basket is calculated.
  • "desiredDelivery":
    string
    The desired delivery date for the Item. | Format: date
  • "discounts":
    array
    Readonly | An array of string literals. The IDs of the discounts applied to the item pricing.
  • "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
  • "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.
  • "position":
    integer
    The position of the item in the basket. | Format: int32
  • "pricing":
    object
    A BasketLineItemPricingRO_v1 object. total price values of a line item that has been added to a basket
    {
    • "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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "salesTaxTotal":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "shippingTaxTotal":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    }
  • "product":
    string
    Required | The product represented as stock keeping unit (SKU). | Example: 5079747
  • "quantity":
    object
    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
    }
  • "quantityFixed":
    boolean
    Flag indicating that this product line item quantity is not changeable. | Example: true
  • "quote":
    string
    The quote this item was created from. | Example: Qu0T3MgoyuMAx9Es2sx0Ue1
  • "shipToAddress":
    string
    The ship-to address URN for this bucket. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
  • "shippingMethod":
    string
    The shipping method id for this bucket. | Example: STD_5DAY
  • "surcharges":
    array
    Readonly | An array of BasketSurchargeRO_v1 objects. Details about additional surcharges applied to the item.
    [
    BasketSurchargeRO_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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "effectiveTaxRate":
        number
        Required | The effective rate used to calculate the tax.
      • "jurisdiction":
        object
        A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
        {
        • "id":
          string
          The jurisdiction ID. | Example: CANADA
        • "level":
          string
          The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
        }
      • "nonTaxableAmount":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "situs":
        string
        Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
      • "taxableAmount":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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.
}
]
BasketListCtnrRO_v1 application/json{
  • "data":
    array
    An array of BasketRO_v1 objects. The core data of the response object.
    [
    BasketRO_v1: A representation of a basket
    {
    • "affiliatePartner":
      string
      The affiliate partner id of the basket. | Example: 4bcKAB2Ykg4AAAFbjvEYRPJ7
    • "affiliateProgram":
      string
      The affiliate program id of the basket. | Example: uzMKAB2YvKAAAAFb7DUYRPJ8
    • "approval":
      object
      A ApprovalRO_v1 object. A representation of a basket approval
      {
      • "approvalRequired":
        boolean
        Flag indicating that this basket needs an approval. | Example: true
      • "costCenterApproval":
        object
        A ApprovalCostCenterRO_v1 object. A representation of a cost center approval
        {
        • "approvers":
          array
          An array of ApprovalUserRO_v1 objects. The cost center approvers.
          [
          ApprovalUserRO_v1: Represents an approval user item.
          {
          • "email":
            string
            The email address of the person represented by this user. | Example: Merkel@test.intershop.de
          • "firstName":
            string
            The given name (also known as a personal name, first name, forename) of the person represented by this user. | Example: Peter
          • "lastName":
            string
            The surname (also known as a family name, last name) of the person represented by this user. | Example: Merkel
          • "title":
            string
            The personal title, like Ms., Mr. | Example: Mr.
          }
          ]
        • "costCenterID":
          string
          The cost center ID.
        • "costCenterName":
          string
          The cost center name.
        }
      • "customerApproval":
        object
        A ApprovalCustomerRO_v1 object. A representation of a customer approval
        {
        • "approvers":
          array
          An array of ApprovalUserRO_v1 objects. The customer approvers.
          [
          ApprovalUserRO_v1: Represents an approval user item.
          {
          • "email":
            string
            The email address of the person represented by this user. | Example: Merkel@test.intershop.de
          • "firstName":
            string
            The given name (also known as a personal name, first name, forename) of the person represented by this user. | Example: Peter
          • "lastName":
            string
            The surname (also known as a family name, last name) of the person represented by this user. | Example: Merkel
          • "title":
            string
            The personal title, like Ms., Mr. | Example: Mr.
          }
          ]
        }
      }
    • "attributes":
      array
      An array of AttributeRO_v1 objects.
      [
      AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
      {
      • "name":
        string
        Required | The name of an element.
      • "type":
        string
        Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
      • "value":
        object
      }
      ]
    • "buckets":
      array
      An array of string literals. The bucket ids of all shipping buckets of a basket.
    • "calculated":
      boolean
      The calculation state of the basket. By default the basket will always be calculated after an update. By settings this to 'false', the basket will not be calculated. Note that the calculation results of a previous calculation will still be present in this case.
    • "commonShipToAddress":
      string
      The common ship-to address URN of the basket. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
    • "commonShippingMethod":
      string
      The common shipping method id of the basket. | Example: STD_5DAY
    • "costCenter":
      string
      The cost center id of the basket. | Example: 511288
    • "coveredByLimitedTenders":
      boolean
      Readonly | The flag specifying whether the basket total amount is covered by limited tender payments. If this is the case, then no further limited tender payments can be created. Note that this information depends on the basket calculation (see "calculated" property). It may not be accurate if the basket is not calculated.
    • "customer":
      string
      Readonly | The basket owner customer number.
    • "department":
      string
      The department name of the basket. | Example: SALES
    • "discounts":
      object
      A BasketDiscountsRO_v1 object. Provides details about the applied discounts.
      {
      • "dynamicMessages":
        array
        Readonly | An array of string literals. The dynamic messages for a basket.
      • "freeGiftDiscounts":
        array
        Readonly | An array of string literals. The IDs of all free gift discounts granted on the basket.
      • "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 basket total.
      }
    • "documentNumber":
      string
      Readonly | The document number of a basket. It is currently only set if basket is in status waiting for approval after submitting.
    • "externalOrderReference":
      string
      The external order reference id of the basket. | Example: 30000008899
    • "id":
      string
      The ID of the basket. | Example: q2QKAEsBiyQAAAFjXFBB6G14
    • "invoiceToAddress":
      string
      The invoice-to address URN of the basket. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
    • "lineItems":
      array
      An array of string literals. The ids of all line items of a basket.
    • "messageToMerchant":
      string
      Something what the buyer would like to tell the merchant. | Example: Is it possible to send the ordered articles before Christmas?
    • "payments":
      array
      An array of string literals. The payments used to pay the basket.
    • "promotionCodes":
      array
      An array of string literals. The promotion codes of the basket.
    • "purchaseCurrency":
      string
      Readonly | The purchase currency of the basket. | Example: USD
    • "recurrence":
      object
      A BasketRecurrenceRO_v1 object. Recurrence data which are associated with a basket.
      {
      • "endDate":
        string
        Required | The end date of a recurrence. | Format: date-time | Example: 2020-05-23T11:23:45.000Z
      • "executeMissedOrders":
        boolean
        The execute missed orders flag. | Example: false
      • "interval":
        object
        Required | The interval of a recurrence. | Example: P6Y11M27D
        {
        • "years":
          integer
          Format: int32
        • "months":
          integer
          Format: int32
        • "days":
          integer
          Format: int32
        • "negative":
          boolean
        • "zero":
          boolean
        • "units":
          array
          An array of object literals.
          [
          {
          • "duration":
            object
            {
            • "seconds":
              integer
              Format: int64
            • "negative":
              boolean
            • "nano":
              integer
              Format: int32
            • "zero":
              boolean
            }
          • "dateBased":
            boolean
          • "timeBased":
            boolean
          • "durationEstimated":
            boolean
          }
          ]
        • "chronology":
          object
          {
          • "calendarType":
            string
          • "id":
            string
          }
        }
      • "repetitions":
        integer
        Required | The repetitions of a recurrence. | Format: int32 | Example: 24
      • "startDate":
        string
        Required | The start date of a recurrence. | Format: date-time | Example: 2020-05-23T11:23:45.000Z
      }
    • "recurringOrderDocumentNo":
      string
      Readonly | The recurring order number.
    • "surcharges":
      object
      A BasketSurchargesRO_v1 object. Surcharges that are applied to a basket.
      {
      • "bucketSurcharges":
        array
        Readonly | An array of BasketSurchargeRO_v1 objects. All bucket based extra charges arising from surcharges with action type 'bucket'.
        [
        BasketSurchargeRO_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
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "net":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "tax":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | 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
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "effectiveTaxRate":
            number
            Required | The effective rate used to calculate the tax.
          • "jurisdiction":
            object
            A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
            {
            • "id":
              string
              The jurisdiction ID. | Example: CANADA
            • "level":
              string
              The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
            }
          • "nonTaxableAmount":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "situs":
            string
            Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
          • "taxableAmount":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          }
          ]
        }
        ]
      • "itemSurcharges":
        array
        Readonly | An array of BasketSurchargeRO_v1 objects. All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item'.
        [
        BasketSurchargeRO_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
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "net":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "tax":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | 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
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "effectiveTaxRate":
            number
            Required | The effective rate used to calculate the tax.
          • "jurisdiction":
            object
            A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
            {
            • "id":
              string
              The jurisdiction ID. | Example: CANADA
            • "level":
              string
              The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
            }
          • "nonTaxableAmount":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          • "situs":
            string
            Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
          • "taxableAmount":
            object
            A MoneyRO_v1 object. Describes a money object.
            {
            • "currency":
              string
              Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            • "value":
              number
              Readonly | The monetary value. | Example: 10.99
            }
          }
          ]
        }
        ]
      }
    • "taxIdentificationNumber":
      string
      The tax identification number of the buyer/company. | Example: 11111111
    • "totalProductQuantity":
      number
      Readonly | The sum of all quantities of products in the basket. | Example: 23
    • "totals":
      object
      A BasketTotalsRO_v1 object. Total price values for a basket.
      {
      • "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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "basketShippingDiscountsTotal":
        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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "basketValueDiscountsTotal":
        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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "salesTaxTotalsByTaxRate":
        array
        Readonly | An array of TaxItemRO_v1 objects. All sales taxes applied to the basket, accumulated by their tax rates.
        [
        TaxItemRO_v1: Represents a single tax item.
        {
        • "calculatedTax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "effectiveTaxRate":
          number
          Required | The effective rate used to calculate the tax.
        • "jurisdiction":
          object
          A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
          {
          • "id":
            string
            The jurisdiction ID. | Example: CANADA
          • "level":
            string
            The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
          }
        • "nonTaxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "situs":
          string
          Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
        • "taxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "shippingTaxTotalsByTaxRate":
        array
        Readonly | An array of TaxItemRO_v1 objects. All shipping taxes applied to the basket, accumulated by their tax rates.
        [
        TaxItemRO_v1: Represents a single tax item.
        {
        • "calculatedTax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "effectiveTaxRate":
          number
          Required | The effective rate used to calculate the tax.
        • "jurisdiction":
          object
          A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
          {
          • "id":
            string
            The jurisdiction ID. | Example: CANADA
          • "level":
            string
            The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
          }
        • "nonTaxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "situs":
          string
          Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
        • "taxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      • "taxTotalsByTaxRate":
        array
        Readonly | An array of TaxItemRO_v1 objects. All taxes applied to the basket, accumulated by their tax rates (includes taxes levied to sales, prices, shipping and surcharges.
        [
        TaxItemRO_v1: Represents a single tax item.
        {
        • "calculatedTax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "effectiveTaxRate":
          number
          Required | The effective rate used to calculate the tax.
        • "jurisdiction":
          object
          A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
          {
          • "id":
            string
            The jurisdiction ID. | Example: CANADA
          • "level":
            string
            The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
          }
        • "nonTaxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "situs":
          string
          Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
        • "taxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
      }
    • "user":
      string
      Readonly | The basket 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.
}
BasketMergeCtnrRO.v1 application/json{
  • "data":
    object
    A BasketMergeRO.v1 object. A representation of merge basket information
    {
    • "overrideAttributes":
      boolean
      The flag decides if the target basket custom attributes can be override. (default: The custom attributes can not override.) | Example: false
    • "removeSourceBasket":
      boolean
      The flag decides if the source basket retains. (default: The source basket will removed.) | Example: true
    • "sourceAuthenticationToken":
      string
      The authentication token to access the source basket.
    • "sourceBasket":
      string
      The id of the basket whose information are merged into the other basket. | Example: 1XQKABsm5boAAAFrzZFR4EbI
    • "targetBasket":
      string
      Readonly | The id of the basket where the line items are merged into. | Example: yiwKABsmStEAAAFrd.FhzEc5
    }
  • "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.
}
BasketMergeRO.v1 application/json{
  • "overrideAttributes":
    boolean
    The flag decides if the target basket custom attributes can be override. (default: The custom attributes can not override.) | Example: false
  • "removeSourceBasket":
    boolean
    The flag decides if the source basket retains. (default: The source basket will removed.) | Example: true
  • "sourceAuthenticationToken":
    string
    The authentication token to access the source basket.
  • "sourceBasket":
    string
    The id of the basket whose information are merged into the other basket. | Example: 1XQKABsm5boAAAFrzZFR4EbI
  • "targetBasket":
    string
    Readonly | The id of the basket where the line items are merged into. | Example: yiwKABsmStEAAAFrd.FhzEc5
}
BasketPromotionCodeRO_v1 application/json{
  • "code":
    string
    Required | The promotion code string. | Example: JSTTWVJNSIIUW
}
BasketRO_v1 application/json{
  • "affiliatePartner":
    string
    The affiliate partner id of the basket. | Example: 4bcKAB2Ykg4AAAFbjvEYRPJ7
  • "affiliateProgram":
    string
    The affiliate program id of the basket. | Example: uzMKAB2YvKAAAAFb7DUYRPJ8
  • "approval":
    object
    A ApprovalRO_v1 object. A representation of a basket approval
    {
    • "approvalRequired":
      boolean
      Flag indicating that this basket needs an approval. | Example: true
    • "costCenterApproval":
      object
      A ApprovalCostCenterRO_v1 object. A representation of a cost center approval
      {
      • "approvers":
        array
        An array of ApprovalUserRO_v1 objects. The cost center approvers.
        [
        ApprovalUserRO_v1: Represents an approval user item.
        {
        • "email":
          string
          The email address of the person represented by this user. | Example: Merkel@test.intershop.de
        • "firstName":
          string
          The given name (also known as a personal name, first name, forename) of the person represented by this user. | Example: Peter
        • "lastName":
          string
          The surname (also known as a family name, last name) of the person represented by this user. | Example: Merkel
        • "title":
          string
          The personal title, like Ms., Mr. | Example: Mr.
        }
        ]
      • "costCenterID":
        string
        The cost center ID.
      • "costCenterName":
        string
        The cost center name.
      }
    • "customerApproval":
      object
      A ApprovalCustomerRO_v1 object. A representation of a customer approval
      {
      • "approvers":
        array
        An array of ApprovalUserRO_v1 objects. The customer approvers.
        [
        ApprovalUserRO_v1: Represents an approval user item.
        {
        • "email":
          string
          The email address of the person represented by this user. | Example: Merkel@test.intershop.de
        • "firstName":
          string
          The given name (also known as a personal name, first name, forename) of the person represented by this user. | Example: Peter
        • "lastName":
          string
          The surname (also known as a family name, last name) of the person represented by this user. | Example: Merkel
        • "title":
          string
          The personal title, like Ms., Mr. | Example: Mr.
        }
        ]
      }
    }
  • "attributes":
    array
    An array of AttributeRO_v1 objects.
    [
    AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
    {
    • "name":
      string
      Required | The name of an element.
    • "type":
      string
      Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
    • "value":
      object
    }
    ]
  • "buckets":
    array
    An array of string literals. The bucket ids of all shipping buckets of a basket.
  • "calculated":
    boolean
    The calculation state of the basket. By default the basket will always be calculated after an update. By settings this to 'false', the basket will not be calculated. Note that the calculation results of a previous calculation will still be present in this case.
  • "commonShipToAddress":
    string
    The common ship-to address URN of the basket. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
  • "commonShippingMethod":
    string
    The common shipping method id of the basket. | Example: STD_5DAY
  • "costCenter":
    string
    The cost center id of the basket. | Example: 511288
  • "coveredByLimitedTenders":
    boolean
    Readonly | The flag specifying whether the basket total amount is covered by limited tender payments. If this is the case, then no further limited tender payments can be created. Note that this information depends on the basket calculation (see "calculated" property). It may not be accurate if the basket is not calculated.
  • "customer":
    string
    Readonly | The basket owner customer number.
  • "department":
    string
    The department name of the basket. | Example: SALES
  • "discounts":
    object
    A BasketDiscountsRO_v1 object. Provides details about the applied discounts.
    {
    • "dynamicMessages":
      array
      Readonly | An array of string literals. The dynamic messages for a basket.
    • "freeGiftDiscounts":
      array
      Readonly | An array of string literals. The IDs of all free gift discounts granted on the basket.
    • "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 basket total.
    }
  • "documentNumber":
    string
    Readonly | The document number of a basket. It is currently only set if basket is in status waiting for approval after submitting.
  • "externalOrderReference":
    string
    The external order reference id of the basket. | Example: 30000008899
  • "id":
    string
    The ID of the basket. | Example: q2QKAEsBiyQAAAFjXFBB6G14
  • "invoiceToAddress":
    string
    The invoice-to address URN of the basket. | Example: urn:address:customer:As8BcSwoiuFEEEAd3pp1Oye:Xf7AqMgoyuMAAAEs2sx0Uei
  • "lineItems":
    array
    An array of string literals. The ids of all line items of a basket.
  • "messageToMerchant":
    string
    Something what the buyer would like to tell the merchant. | Example: Is it possible to send the ordered articles before Christmas?
  • "payments":
    array
    An array of string literals. The payments used to pay the basket.
  • "promotionCodes":
    array
    An array of string literals. The promotion codes of the basket.
  • "purchaseCurrency":
    string
    Readonly | The purchase currency of the basket. | Example: USD
  • "recurrence":
    object
    A BasketRecurrenceRO_v1 object. Recurrence data which are associated with a basket.
    {
    • "endDate":
      string
      Required | The end date of a recurrence. | Format: date-time | Example: 2020-05-23T11:23:45.000Z
    • "executeMissedOrders":
      boolean
      The execute missed orders flag. | Example: false
    • "interval":
      object
      Required | The interval of a recurrence. | Example: P6Y11M27D
      {
      • "years":
        integer
        Format: int32
      • "months":
        integer
        Format: int32
      • "days":
        integer
        Format: int32
      • "negative":
        boolean
      • "zero":
        boolean
      • "units":
        array
        An array of object literals.
        [
        {
        • "duration":
          object
          {
          • "seconds":
            integer
            Format: int64
          • "negative":
            boolean
          • "nano":
            integer
            Format: int32
          • "zero":
            boolean
          }
        • "dateBased":
          boolean
        • "timeBased":
          boolean
        • "durationEstimated":
          boolean
        }
        ]
      • "chronology":
        object
        {
        • "calendarType":
          string
        • "id":
          string
        }
      }
    • "repetitions":
      integer
      Required | The repetitions of a recurrence. | Format: int32 | Example: 24
    • "startDate":
      string
      Required | The start date of a recurrence. | Format: date-time | Example: 2020-05-23T11:23:45.000Z
    }
  • "recurringOrderDocumentNo":
    string
    Readonly | The recurring order number.
  • "surcharges":
    object
    A BasketSurchargesRO_v1 object. Surcharges that are applied to a basket.
    {
    • "bucketSurcharges":
      array
      Readonly | An array of BasketSurchargeRO_v1 objects. All bucket based extra charges arising from surcharges with action type 'bucket'.
      [
      BasketSurchargeRO_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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "effectiveTaxRate":
          number
          Required | The effective rate used to calculate the tax.
        • "jurisdiction":
          object
          A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
          {
          • "id":
            string
            The jurisdiction ID. | Example: CANADA
          • "level":
            string
            The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
          }
        • "nonTaxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "situs":
          string
          Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
        • "taxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
        ]
      }
      ]
    • "itemSurcharges":
      array
      Readonly | An array of BasketSurchargeRO_v1 objects. All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item'.
      [
      BasketSurchargeRO_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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "effectiveTaxRate":
          number
          Required | The effective rate used to calculate the tax.
        • "jurisdiction":
          object
          A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
          {
          • "id":
            string
            The jurisdiction ID. | Example: CANADA
          • "level":
            string
            The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
          }
        • "nonTaxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "situs":
          string
          Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
        • "taxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        }
        ]
      }
      ]
    }
  • "taxIdentificationNumber":
    string
    The tax identification number of the buyer/company. | Example: 11111111
  • "totalProductQuantity":
    number
    Readonly | The sum of all quantities of products in the basket. | Example: 23
  • "totals":
    object
    A BasketTotalsRO_v1 object. Total price values for a basket.
    {
    • "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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "basketShippingDiscountsTotal":
      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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "basketValueDiscountsTotal":
      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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "salesTaxTotalsByTaxRate":
      array
      Readonly | An array of TaxItemRO_v1 objects. All sales taxes applied to the basket, accumulated by their tax rates.
      [
      TaxItemRO_v1: Represents a single tax item.
      {
      • "calculatedTax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "effectiveTaxRate":
        number
        Required | The effective rate used to calculate the tax.
      • "jurisdiction":
        object
        A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
        {
        • "id":
          string
          The jurisdiction ID. | Example: CANADA
        • "level":
          string
          The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
        }
      • "nonTaxableAmount":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "situs":
        string
        Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
      • "taxableAmount":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "shippingTaxTotalsByTaxRate":
      array
      Readonly | An array of TaxItemRO_v1 objects. All shipping taxes applied to the basket, accumulated by their tax rates.
      [
      TaxItemRO_v1: Represents a single tax item.
      {
      • "calculatedTax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "effectiveTaxRate":
        number
        Required | The effective rate used to calculate the tax.
      • "jurisdiction":
        object
        A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
        {
        • "id":
          string
          The jurisdiction ID. | Example: CANADA
        • "level":
          string
          The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
        }
      • "nonTaxableAmount":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "situs":
        string
        Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
      • "taxableAmount":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "taxTotalsByTaxRate":
      array
      Readonly | An array of TaxItemRO_v1 objects. All taxes applied to the basket, accumulated by their tax rates (includes taxes levied to sales, prices, shipping and surcharges.
      [
      TaxItemRO_v1: Represents a single tax item.
      {
      • "calculatedTax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "effectiveTaxRate":
        number
        Required | The effective rate used to calculate the tax.
      • "jurisdiction":
        object
        A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
        {
        • "id":
          string
          The jurisdiction ID. | Example: CANADA
        • "level":
          string
          The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
        }
      • "nonTaxableAmount":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "situs":
        string
        Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
      • "taxableAmount":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    }
  • "user":
    string
    Readonly | The basket owner user login.
}
BasketShippingBucketCtnrRO_v1 application/json{
  • "data":
    object
    A BasketShippingBucketRO_v1 object. Describes a shipping bucket.
    {
    • "basket":
      string
      Readonly | The basket this shipping bucket belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
    • "calculated":
      boolean
      The calculation state of the shipping bucket. By default the shipping bucket will always be calculated after an update. By settings this to 'false', the shipping bucket will not be calculated. Note that the calculation results of a previous calculation will still be present in this case. Also note that by setting this to 'true', not only the shipping bucket, but the whole basket is calculated.
    • "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
      • "negative":
        boolean
      • "zero":
        boolean
      • "units":
        array
        An array of object literals.
        [
        {
        • "duration":
          object
          {
          • "seconds":
            integer
            Format: int64
          • "negative":
            boolean
          • "nano":
            integer
            Format: int32
          • "zero":
            boolean
          }
        • "dateBased":
          boolean
        • "timeBased":
          boolean
        • "durationEstimated":
          boolean
        }
        ]
      • "chronology":
        object
        {
        • "calendarType":
          string
        • "id":
          string
        }
      }
    • "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
      • "negative":
        boolean
      • "zero":
        boolean
      • "units":
        array
        An array of object literals.
        [
        {
        • "duration":
          object
          {
          • "seconds":
            integer
            Format: int64
          • "negative":
            boolean
          • "nano":
            integer
            Format: int32
          • "zero":
            boolean
          }
        • "dateBased":
          boolean
        • "timeBased":
          boolean
        • "durationEstimated":
          boolean
        }
        ]
      • "chronology":
        object
        {
        • "calendarType":
          string
        • "id":
          string
        }
      }
    • "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.
    • "shipToAddress":
      string
      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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "shippingMethod":
      string
      The shipping method id for this bucket. | Example: STD_5DAY
    • "surcharges":
      array
      Readonly | An array of BasketSurchargeRO_v1 objects. All extra charges arising from surcharges directly specified on product or by shipping rules with action type 'bucket'.
      [
      BasketSurchargeRO_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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "effectiveTaxRate":
          number
          Required | The effective rate used to calculate the tax.
        • "jurisdiction":
          object
          A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
          {
          • "id":
            string
            The jurisdiction ID. | Example: CANADA
          • "level":
            string
            The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
          }
        • "nonTaxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "situs":
          string
          Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
        • "taxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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.
}
BasketShippingBucketListCtnrRO_v1 application/json{
  • "data":
    array
    An array of BasketShippingBucketRO_v1 objects. The core data of the response object.
    [
    BasketShippingBucketRO_v1: Describes a shipping bucket.
    {
    • "basket":
      string
      Readonly | The basket this shipping bucket belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
    • "calculated":
      boolean
      The calculation state of the shipping bucket. By default the shipping bucket will always be calculated after an update. By settings this to 'false', the shipping bucket will not be calculated. Note that the calculation results of a previous calculation will still be present in this case. Also note that by setting this to 'true', not only the shipping bucket, but the whole basket is calculated.
    • "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
      • "negative":
        boolean
      • "zero":
        boolean
      • "units":
        array
        An array of object literals.
        [
        {
        • "duration":
          object
          {
          • "seconds":
            integer
            Format: int64
          • "negative":
            boolean
          • "nano":
            integer
            Format: int32
          • "zero":
            boolean
          }
        • "dateBased":
          boolean
        • "timeBased":
          boolean
        • "durationEstimated":
          boolean
        }
        ]
      • "chronology":
        object
        {
        • "calendarType":
          string
        • "id":
          string
        }
      }
    • "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
      • "negative":
        boolean
      • "zero":
        boolean
      • "units":
        array
        An array of object literals.
        [
        {
        • "duration":
          object
          {
          • "seconds":
            integer
            Format: int64
          • "negative":
            boolean
          • "nano":
            integer
            Format: int32
          • "zero":
            boolean
          }
        • "dateBased":
          boolean
        • "timeBased":
          boolean
        • "durationEstimated":
          boolean
        }
        ]
      • "chronology":
        object
        {
        • "calendarType":
          string
        • "id":
          string
        }
      }
    • "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.
    • "shipToAddress":
      string
      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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "shippingMethod":
      string
      The shipping method id for this bucket. | Example: STD_5DAY
    • "surcharges":
      array
      Readonly | An array of BasketSurchargeRO_v1 objects. All extra charges arising from surcharges directly specified on product or by shipping rules with action type 'bucket'.
      [
      BasketSurchargeRO_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
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "net":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "tax":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "effectiveTaxRate":
          number
          Required | The effective rate used to calculate the tax.
        • "jurisdiction":
          object
          A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
          {
          • "id":
            string
            The jurisdiction ID. | Example: CANADA
          • "level":
            string
            The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
          }
        • "nonTaxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | The monetary value. | Example: 10.99
          }
        • "situs":
          string
          Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
        • "taxableAmount":
          object
          A MoneyRO_v1 object. Describes a money object.
          {
          • "currency":
            string
            Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          • "value":
            number
            Readonly | 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.
}
BasketShippingBucketRO_v1 application/json{
  • "basket":
    string
    Readonly | The basket this shipping bucket belongs to. | Example: yUQKAEsBeeoAAAFl9vhJwIZc
  • "calculated":
    boolean
    The calculation state of the shipping bucket. By default the shipping bucket will always be calculated after an update. By settings this to 'false', the shipping bucket will not be calculated. Note that the calculation results of a previous calculation will still be present in this case. Also note that by setting this to 'true', not only the shipping bucket, but the whole basket is calculated.
  • "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
    • "negative":
      boolean
    • "zero":
      boolean
    • "units":
      array
      An array of object literals.
      [
      {
      • "duration":
        object
        {
        • "seconds":
          integer
          Format: int64
        • "negative":
          boolean
        • "nano":
          integer
          Format: int32
        • "zero":
          boolean
        }
      • "dateBased":
        boolean
      • "timeBased":
        boolean
      • "durationEstimated":
        boolean
      }
      ]
    • "chronology":
      object
      {
      • "calendarType":
        string
      • "id":
        string
      }
    }
  • "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
    • "negative":
      boolean
    • "zero":
      boolean
    • "units":
      array
      An array of object literals.
      [
      {
      • "duration":
        object
        {
        • "seconds":
          integer
          Format: int64
        • "negative":
          boolean
        • "nano":
          integer
          Format: int32
        • "zero":
          boolean
        }
      • "dateBased":
        boolean
      • "timeBased":
        boolean
      • "durationEstimated":
        boolean
      }
      ]
    • "chronology":
      object
      {
      • "calendarType":
        string
      • "id":
        string
      }
    }
  • "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.
  • "shipToAddress":
    string
    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
        Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        Readonly | The monetary value. | Example: 10.99
      }
    • "net":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        Readonly | The monetary value. | Example: 10.99
      }
    • "tax":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        Readonly | The monetary value. | Example: 10.99
      }
    }
  • "shippingMethod":
    string
    The shipping method id for this bucket. | Example: STD_5DAY
  • "surcharges":
    array
    Readonly | An array of BasketSurchargeRO_v1 objects. All extra charges arising from surcharges directly specified on product or by shipping rules with action type 'bucket'.
    [
    BasketSurchargeRO_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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "effectiveTaxRate":
        number
        Required | The effective rate used to calculate the tax.
      • "jurisdiction":
        object
        A JurisdictionRO_v1 object. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country.
        {
        • "id":
          string
          The jurisdiction ID. | Example: CANADA
        • "level":
          string
          The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
        }
      • "nonTaxableAmount":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "situs":
        string
        Readonly | The situs/place of taxation. | Example: DESTINATION | Possible Values: ADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
      • "taxableAmount":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
      ]
    }
    ]
}
BasketShippingMethodListCtnrRO_v1 application/json{
  • "data":
    array
    An array of BasketShippingMethodRO_v1 objects. The core data of the response object.
    [
    BasketShippingMethodRO_v1: Describes a shipping method that can be selected as delivery option.
    {
    • "attributes":
      array
      An array of AttributeRO_v1 objects.
      [
      AttributeRO_v1: A representation of an attribute. Can be one of the following object types: BooleanAttributeRO_v1, DateAttributeRO_v1, DecimalAttributeRO_v1, DoubleAttributeRO_v1, IntegerAttributeRO_v1, LongAttributeRO_v1, MoneyAttributeRO_v1, QuantityAttributeRO_v1, StringAttributeRO_v1, TextAttributeRO_v1, MultipleBooleanAttributeRO_v1, MultipleDateAttributeRO_v1, MultipleDecimalAttributeRO_v1, MultipleDoubleAttributeRO_v1, MultipleIntegerAttributeRO_v1, MultipleLongAttributeRO_v1, MultipleStringAttributeRO_v1.
      {
      • "name":
        string
        Required | The name of an element.
      • "type":
        string
        Required | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Possible Values: BooleanDateDecimalDoubleIntegerLongMoneyQuantityStringTextMultipleBooleanMultipleDateMultipleDecimalMultipleDoubleMultipleIntegerMultipleLongMultipleString
      • "value":
        object
      }
      ]
    • "deliveryTimeMax":
      object
      Readonly | The maximum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P7D
      {
      • "years":
        integer
        Format: int32
      • "months":
        integer
        Format: int32
      • "days":
        integer
        Format: int32
      • "negative":
        boolean
      • "zero":
        boolean
      • "units":
        array
        An array of object literals.
        [
        {
        • "duration":
          object
          {
          • "seconds":
            integer
            Format: int64
          • "negative":
            boolean
          • "nano":
            integer
            Format: int32
          • "zero":
            boolean
          }
        • "dateBased":
          boolean
        • "timeBased":
          boolean
        • "durationEstimated":
          boolean
        }
        ]
      • "chronology":
        object
        {
        • "calendarType":
          string
        • "id":
          string
        }
      }
    • "deliveryTimeMin":
      object
      Readonly | The minimum time the delivery will take when selecting this shipping method (in ISO-8601 period format). Note that because the delivery time depends on the shipping bucket, it will only be returned if request from the bucket. | Example: P3D
      {
      • "years":
        integer
        Format: int32
      • "months":
        integer
        Format: int32
      • "days":
        integer
        Format: int32
      • "negative":
        boolean
      • "zero":
        boolean
      • "units":
        array
        An array of object literals.
        [
        {
        • "duration":
          object
          {
          • "seconds":
            integer
            Format: int64
          • "negative":
            boolean
          • "nano":
            integer
            Format: int32
          • "zero":
            boolean
          }
        • "dateBased":
          boolean
        • "timeBased":
          boolean
        • "durationEstimated":
          boolean
        }
        ]
      • "chronology":
        object
        {
        • "calendarType":
          string
        • "id":
          string
        }
      }
    • "description":
      string
      Readonly | The shipping method's localized description. | Example: Delivered to you 3-7 business days after we process your order.
    • "digitalDelivery":
      boolean
      Readonly | Whether this shipping method is a digital delivery method (e. g. for e-mail delivery).
    • "id":
      string
      Readonly | The shipping method's unique identifier. | Example: STD_GROUND
    • "name":
      string
      Readonly | The name of an element. | Example: Standard Ground
    • "shippingCosts":
      object
      A PriceRO_v1 object. Describes a price. A price has a monetary net, gross and tax value.
      {
      • "gross":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "shippingInstructionsSupported":
      boolean
      Readonly | Whether special shipping instructions can be added to the shipping bucket when selecting this shipping method.
    • "shortName":
      string
      Readonly | The shipping method's localized short Name. | Example: Int'l Express Delivery.
    }
    ]
  • "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.
}
BasketValidationCtnrRO_v1 application/json{
  • "data":
    object
    A BasketValidationRO_v1 object. A representation of a basket validation operation. Contains parameters for triggering the validation as well as the validation results for the given scopes.
    {
    • "adjustmentsAllowed":
      boolean
      Defines whether adjustments of the basket are allowed during the validation. For example, if this is set to 'true', then a product that is no longer available will be removed during the validation; if this is set to 'false' instead, then only an error will be returned.
    • "basket":
      string
      Readonly | The ID of the basket that is validated. | Example: MAoKAEsBSYIAAAFrkghefNsj
    • "errorBehavior":
      string
      Defines whether the validation immediately stops if an error occurs. If this is set to 'StopOnError', then the validation only continues until the first error. If this is set to 'StopOnErrorFinishScope', then the validation will finish the scope where the first error occurs and stop afterwards. If this is set to 'NeverStop', then it will continue to the end and return all validation errors at once. | Possible Values: StopOnErrorStopOnErrorFinishScopeNeverStop
    • "results":
      object
      A BasketValidationResultRO_v1 object. A representation of the results of a basket validation operation.
      {
      • "adjusted":
        boolean
        Readonly | Returns whether the basket has been adjusted during the validation.
      • "errors":
        array
        Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred while validating the basket for the given scope(s). The paths of the feedback messages refer to the basket that has been validated (with related objects being embedded).
        [
        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
        }
        ]
      • "infos":
        array
        Readonly | An array of FeedbackRO_v1 objects. List of adjustments that were made while validating the basket for the given scope(s). The paths of the feedback messages refer to the basket that has been validated (with related objects being embedded).
        [
        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
        }
        ]
      • "valid":
        boolean
        Readonly | Returns whether the basket is valid. A basket is valid if no errors occurred during the validation.
      }
    • "scopes":
      array
      An array of string literals. The list of scopes that are validated. If not specified, the basket will be validated for all scopes. Note that the list of allowable values only contains the standard scopes; if there are custom validation handlers with different scopes, those can be used too. | Possible Values: AllCostCenterInvoiceAddressOrderPaymentProductsPromotionQuoteShippingShippingAddressSubscriptionValue
    }
  • "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.
}
BasketValidationRO_v1 application/json{
  • "adjustmentsAllowed":
    boolean
    Defines whether adjustments of the basket are allowed during the validation. For example, if this is set to 'true', then a product that is no longer available will be removed during the validation; if this is set to 'false' instead, then only an error will be returned.
  • "basket":
    string
    Readonly | The ID of the basket that is validated. | Example: MAoKAEsBSYIAAAFrkghefNsj
  • "errorBehavior":
    string
    Defines whether the validation immediately stops if an error occurs. If this is set to 'StopOnError', then the validation only continues until the first error. If this is set to 'StopOnErrorFinishScope', then the validation will finish the scope where the first error occurs and stop afterwards. If this is set to 'NeverStop', then it will continue to the end and return all validation errors at once. | Possible Values: StopOnErrorStopOnErrorFinishScopeNeverStop
  • "results":
    object
    A BasketValidationResultRO_v1 object. A representation of the results of a basket validation operation.
    {
    • "adjusted":
      boolean
      Readonly | Returns whether the basket has been adjusted during the validation.
    • "errors":
      array
      Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred while validating the basket for the given scope(s). The paths of the feedback messages refer to the basket that has been validated (with related objects being embedded).
      [
      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
      }
      ]
    • "infos":
      array
      Readonly | An array of FeedbackRO_v1 objects. List of adjustments that were made while validating the basket for the given scope(s). The paths of the feedback messages refer to the basket that has been validated (with related objects being embedded).
      [
      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
      }
      ]
    • "valid":
      boolean
      Readonly | Returns whether the basket is valid. A basket is valid if no errors occurred during the validation.
    }
  • "scopes":
    array
    An array of string literals. The list of scopes that are validated. If not specified, the basket will be validated for all scopes. Note that the list of allowable values only contains the standard scopes; if there are custom validation handlers with different scopes, those can be used too. | Possible Values: AllCostCenterInvoiceAddressOrderPaymentProductsPromotionQuoteShippingShippingAddressSubscriptionValue
}
ContainerRO_v1 application/json{
  • "data":
    object
    The core data of the response object.
  • "errors":
    array
    Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
    [
    FeedbackRO_v1: An error or information representation regarding the current request.
    {
    • "causes":
      array
      An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
      [
      FeedbackCauseRO_v1: A representation for the common feedback informations.
      {
      • "code":
        string
        Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
      • "message":
        string
        Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
      • "parameters":
        object
        A map of several parameters that are used to assemble the message.
      • "paths":
        array
        An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
      }
      ]
    • "code":
      string
      An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
    • "message":
      string
      A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
    • "parameters":
      object
      A map of several parameters that are used to assemble the message.
    • "paths":
      array
      An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
    • "status":
      string
      The HTTP status code, that is applicable to this problem. | Example: 400
    }
    ]
  • "included":
    object
    Optionally included related data objects.
  • "infos":
    array
    Readonly | An array of FeedbackRO_v1 objects. List of informations regarding to the request (e.g. value adjustments).
    [
    FeedbackRO_v1: An error or information representation regarding the current request.
    {
    • "causes":
      array
      An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
      [
      FeedbackCauseRO_v1: A representation for the common feedback informations.
      {
      • "code":
        string
        Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
      • "message":
        string
        Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
      • "parameters":
        object
        A map of several parameters that are used to assemble the message.
      • "paths":
        array
        An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
      }
      ]
    • "code":
      string
      An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
    • "message":
      string
      A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
    • "parameters":
      object
      A map of several parameters that are used to assemble the message.
    • "paths":
      array
      An array of string literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath
    • "status":
      string
      The HTTP status code, that is applicable to this problem. | Example: 400
    }
    ]
  • "links":
    object
    Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.
}
CostObjectAssignmentRO application/json{
  • "name":
    string
    The name of an element. | Example: 451
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: Project
}
FeedbackCtnrRO_v1 application/json{
  • "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.
}
PaymentCtnrRO_v1 application/json{
  • "data":
    object
    A PaymentRO_v1 object. A payment assigned to the basket/order to pay the bill with.
    {
    • "baseAmount":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        Readonly | 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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | 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: SUCCESSCANCELFAILURE
      • "successUrl":
        string
        Required | The URL to be called on successful payment redirect back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/success?orderID=*orderID*
      }
    • "redirectRequired":
      boolean
      Readonly | Whether or not a redirect is required to finish the payment. The type of redirect (before or after the checkout process) can be determined via the capabilities of the payment method.
    • "status":
      string
      Readonly | The localized display name of the payment status. | Example: Partially captured
    • "totalAmount":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        Readonly | 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.
}
PaymentInstrumentCtnrRO_v1 application/json{
  • "data":
    object
    A PaymentInstrumentRO_v1 object. A payment instrument with stored bank account data.
    {
    • "accountIdentifier":
      string
      Readonly | An optional identifier for the customers bank account. | Example: DE12****7890
    • "id":
      string
      The ID of the payment instrument. | Example: AAFjXFq2QKAEsBiyQABB6G14
    • "numberOfPayments":
      integer
      Readonly | The number of payments done with this instrument. | Format: int32 | Example: 3
    • "parameters":
      array
      An array of ParameterRO_v1 objects. The parameters for the payment instrument.
      [
      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
      }
      ]
    • "paymentMethod":
      string
      Required | The reference to the payment method the instrument is created for. | Example: ISH_DIRECT_DEBIT
    • "urn":
      string
      The URN of the payment instrument. | Example: urn:payment-instrument:basket:q2QKAEsBiyQAAAFjXFBB6G14:AAFjXFq2QKAEsBiyQABB6G14
    }
  • "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.
}
PaymentInstrumentRO_v1 application/json{
  • "accountIdentifier":
    string
    Readonly | An optional identifier for the customers bank account. | Example: DE12****7890
  • "id":
    string
    The ID of the payment instrument. | Example: AAFjXFq2QKAEsBiyQABB6G14
  • "numberOfPayments":
    integer
    Readonly | The number of payments done with this instrument. | Format: int32 | Example: 3
  • "parameters":
    array
    An array of ParameterRO_v1 objects. The parameters for the payment instrument.
    [
    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
    }
    ]
  • "paymentMethod":
    string
    Required | The reference to the payment method the instrument is created for. | Example: ISH_DIRECT_DEBIT
  • "urn":
    string
    The URN of the payment instrument. | Example: urn:payment-instrument:basket:q2QKAEsBiyQAAAFjXFBB6G14:AAFjXFq2QKAEsBiyQABB6G14
}
PaymentMethodListCtnrRO_v1 application/json{
  • "data":
    array
    An array of PaymentMethodRO_v1 objects. The core data of the response object.
    [
    PaymentMethodRO_v1: A configured payment method.
    {
    • "capabilities":
      array
      Readonly | An array of string literals. List of supported payment service capabilities. | Example: RedirectAfterCheckout
    • "default":
      boolean
      Readonly | Whether the payment method is the default payment method of the channel.
    • "description":
      string
      Readonly | A more detailed description of the payment method. | Example: Simulate a payment with the Intershop demo method
    • "displayName":
      string
      Readonly | The display name of the payment method. | Example: ISH Demo Payment
    • "hostedPaymentPageParameters":
      array
      Readonly | An array of ParameterRO_v1 objects. List of content parameters for Hosted Payment Pages.
      [
      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
      }
      ]
    • "id":
      string
      Readonly | The ID of the payment method. Internally this is the ID of the payment method configuration in the backoffice. | Example: ISH_INVOICE
    • "maxOrderAmount":
      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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "minOrderAmount":
      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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "parameterDefinitions":
      array
      Readonly | An array of ParameterDefinitionRO_v1 objects. List of parameters (e.g. credit card 3DS token or IBAN) for this payment.
      [
      ParameterDefinitionRO_v1: A representation of a parameter definition.
      {
      • "constraints":
        object
        A map of parameter constraints. The key is the constraint type.
      • "description":
        string
        Readonly | The localized parameter description.
      • "displayName":
        string
        Readonly | The localized display name of the parameter. | Example: Expiration Date
      • "hidden":
        boolean
        Readonly | A flag indicating a hidden parameter that is not visible in the UI.
      • "name":
        string
        Required | Readonly | The name of an element. | Example: expiryDate
      • "options":
        array
        An array of OptionRO_v1 objects. A list of allowable values to choose from for this parameter.
        [
        OptionRO_v1: A representation of a parameter option.
        {
        • "displayName":
          string
          The localized display name of the parameter option. | Example: American Express
        • "id":
          string
          The id of the parameter option. | Example: amx
        }
        ]
      • "placeholder":
        string
        Readonly | A placeholder string for the parameter.
      • "type":
        string
        Required | Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: String
      • "updatable":
        boolean
        Readonly | A flag indicating a parameter value is updatable via REST.
      }
      ]
    • "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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "paymentCostsThreshold":
      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
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "net":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      • "tax":
        object
        A MoneyRO_v1 object. Describes a money object.
        {
        • "currency":
          string
          Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        • "value":
          number
          Readonly | The monetary value. | Example: 10.99
        }
      }
    • "paymentInstruments":
      array
      Readonly | An array of string literals. The IDs of all payment instruments stored for this payment method in the current context.
    • "restricted":
      boolean
      Readonly | Whether the payment method can be used in the current context.
    • "restrictions":
      array
      Readonly | An array of PaymentRestrictionRO_v1 objects. The restrictions which prevent the payment method from being applicable.
      [
      PaymentRestrictionRO_v1: A restriction which limits the use of a payment method.
      {
      • "code":
        string
        Required | Readonly | A unique identifier for this restriction. | Example: payment.restriction.MultipleBuckets
      • "message":
        string
        Required | Readonly | A human readable message in request's locale describing the restriction. | Example: Not available for orders being dispatched to multiple addresses or in multiple shipments.
      • "parameters":
        object
        Readonly | A map of additional parameters to be used in the description.
      }
      ]
    • "saveAllowed":
      boolean
      Readonly | Whether the entered payment data can be saved for later reuse. | Example: false
    • "serviceID":
      string
      Readonly | The ID of the payment service. | Example: SomePaymentProvider_CreditCard
    }
    ]
  • "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.
}
PaymentRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: Payment
  • "attributes":
    array
    An array of ResourceAttribute objects. the list of attributes
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "id":
    string
  • "limitedTenderBalance":
    object
    A MoneyRO object. Money combines a currency and a money amount.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | This is a constant: Money | Example: Money
    • "value":
      number
      The monetary value. | Example: 10.99
    • "currencyMnemonic":
      string
      Deprecated
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    }
  • "paymentTotalAmount":
    object
    A MoneyRO object. Money combines a currency and a money amount.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | This is a constant: Money | Example: Money
    • "value":
      number
      The monetary value. | Example: 10.99
    • "currencyMnemonic":
      string
      Deprecated
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    }
  • "accountIdentifier":
    string
    Readonly | the optional account identifier for this payment instrument | Example: DE12****7890
  • "parameters":
    array
    An array of GenericPropertyROObject objects.
    [
    GenericPropertyROObject:
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "key":
      string
    • "property":
      object
    • "displayName":
      string
    }
    ]
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
PaymentRO_v1 application/json{
  • "baseAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    • "currency":
      string
      Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    • "value":
      number
      Readonly | 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
        Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        Readonly | The monetary value. | Example: 10.99
      }
    • "net":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        Readonly | The monetary value. | Example: 10.99
      }
    • "tax":
      object
      A MoneyRO_v1 object. Describes a money object.
      {
      • "currency":
        string
        Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      • "value":
        number
        Readonly | 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: SUCCESSCANCELFAILURE
    • "successUrl":
      string
      Required | The URL to be called on successful payment redirect back to the shop. Placeholders can be used in this URL that get replaced by their real values during order creation. Per default the placeholders *orderID* and *paymentID* are available. | Format: uri | Example: https://shop.server/success?orderID=*orderID*
    }
  • "redirectRequired":
    boolean
    Readonly | Whether or not a redirect is required to finish the payment. The type of redirect (before or after the checkout process) can be determined via the capabilities of the payment method.
  • "status":
    string
    Readonly | The localized display name of the payment status. | Example: Partially captured
  • "totalAmount":
    object
    A MoneyRO_v1 object. Describes a money object.
    {
    • "currency":
      string
      Readonly | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    • "value":
      number
      Readonly | The monetary value. | Example: 10.99
    }
}
PaymentRedirectRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "successURL":
    string
  • "failURL":
    string
  • "cancelURL":
    string
}
PaymentRedirectResponseRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "attributes":
    array
    An array of ResourceAttribute objects. the list of attributes
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "id":
    string
  • "parameters":
    array
    An array of GenericPropertyROObject objects.
    [
    GenericPropertyROObject:
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "key":
      string
    • "property":
      object
    • "displayName":
      string
    }
    ]
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
ResourceCollectionROLinkRO application/json{
  • "pageable":
    string
    the pageable ID
  • "total":
    integer
    the pageable amount total | Format: int32
  • "offset":
    integer
    the pageable offset | Format: int32
  • "amount":
    integer
    the pageable amount | Format: int32
  • "elements":
    array
    An array of LinkRO objects. the list of elements
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "type":
    string
    This is a constant: ResourceCollection | Example: ResourceCollection
  • "sortKeys":
    array
    An array of string literals. the keys to sort for
  • "name":
    string
    the name of the returned element
}

Disclaimer

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

Customer Support
Knowledge Base
Product Resources
Tickets