Document Properties
Kbid29767D
Last Modified23-Feb-2021
Added to KB22-Jan-2021
Public AccessEveryone
StatusOnline
Doc TypeReferences
ProductICM 7.10

Reference - Basket API 0.1.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: 0.1.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.

Cost Object API

/baskets/{BasketResourceKey}/costobjects
GET: (Deprecated) Returns the cost objects assigned to the selected basket Deprecated.

Description

This operation is deprecated. The Cost Object feature is no longer supported.

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 a user who has been assigned the following permissions:
- View Cost Object (APP_B2B_VIEW_COSTOBJECT)
POST: (Deprecated) Assigns a cost object to the basket Deprecated.

Description

This operation is deprecated. The Cost Object feature is no longer supported.

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 a user who has been assigned the following permissions:
- Assign Cost Object To Basket (APP_B2B_ASSIGN_COSTOBJECT_TO_BASKET)

404 - Not Found

/baskets/{BasketResourceKey}/costobjects/{BasketCostObjectAssignmentKey}
GET: (Deprecated) Returns a specific cost object assigned to the selected basket Deprecated.

Description

This operation is deprecated. The Cost Object feature is no longer supported.

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 a user who has been assigned the following permissions:
- View Cost Object (APP_B2B_VIEW_COSTOBJECT)

404 - Not Found

DELETE: (Deprecated) Removes a cost object from the basket Deprecated.

Description

This operation is deprecated beacuse the Cost Object feature is no longer supported.

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 a user who has been assigned the following permissions:
- Delete Cost Object (APP_B2B_DELETE_COSTOBJECT)

404 - Not Found

General API

/baskets
GET: Gets all open baskets for the current user

Description

Gets a list of all open baskets for the user given by the authentication token.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource.getBaskets()

Request Body

--

Request Parameters

--

Response

200 - OK

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

400 - Bad Request

possible values for header error-key:
- basket.basket_user_required.error
POST: Creates a new basket.

Description

The request creates a new basket. The client gets a link to the new cart.The server will return the headers authentication-token and Location. These are required for anonymous users, who have not logged in yet, by providing their credentials. In this case the token has any subsequent request to the basket,because a basket can only be accessed by that user who created it.
Registered users, that have been logged in before basket creation are not required to sendthe token with subsequent requests.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource.createBasket()

Request Body

--

Request Parameters

--

Response

201 - Created

/baskets/{BasketResourceKey}
GET: Returns the basket's summary. Alternatively you may use the URL `/baskets/-` to get the active basket.

Description

Get baskets summary, containing

  • Customer related basket information, like taxation ID, external order reference ID
  • Shipping buckets with line item references
  • Invoice-to address
  • Promotions applied to the basket
  • Payment methods applied to the basket
  • Sales and shipping taxes
  • Surcharges
  • Promotional discounts
  • Basket totals
  • Recurrence information
  • Document number (is currently only set if basket is in status waiting for approval after submitting)
  • Recurring Order Document number (is only set when Basket is recurring)
  • Affiliate information

    In case of basket not found or other error, a status code 400 is returned as a result.

    Depending on the flag isMultipleShippmentSupported the get request returns the availableshipping methods at the basket level or at the line item level:

  • isMultipleShippmentSupported = true: the shipping methods are available at the line item level and not at the basket level
  • isMultipleShippmentSupported = false: the shipping methods are available at the basket level and not at the line item level

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketRO com.intershop.sellside.rest.common.capi.resource.basket.BasketResource.getBasketByID()

Request Body

--

Request Parameters

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

Response

200 - OK

BasketRO 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)
PUT: Sets / updates basket related data, marks the basket as recurrent and sets recurrence information

Description

Sets following basket related data:

  • commonShipToAddress

    If a complete address is specified, this address is set after validation successfully finished. Alternatively, a URN of an existing address (e.g., of an address of a registered customer or a store address) may be passed to use this address if possible. Note that an existing address may only be used if it is marked as an invoice-to address.

  • invoiceToAddress

    If a complete address is specified, this address is set after validation successfully finished. Alternatively, a URN of an existing address (e.g., of an address of a registered customer or a store address) may be passed to use this address if possible. Note that an existing address may only be used if it is marked as a ship-to address.

  • commonShippingMethod
  • promotionCode

    If the specified promotion code is valid, it is applied to the basket.If the promotion code is not valid, then a validation result is returned.

  • department

    Option to set the buyer's department at the basket in case of unregistered checkout.

  • taxationID

    Option to set buyer's taxation ID at the basket in case of unregistered checkout.

  • taxExempt
  • purchaseCurrency
  • dynamicMessages
  • externalOrderReferenceID

    Option to set a buyer specific order reference ID at the basket.

  • owningUser

    Assigns the basket to another user. It is intended to be used to transfer the basket of an anonymous user to a registered user, when the anonymous user logs-in during the checkout. In order to change the owner a valid authentication token of the new user has to be applied.After changing the owner, the current user has no access to this basket anymore!

  • multipleShippmentsSupported
  • recurrence (required fields: StartDate, Recurrence Interval; optional fields: EndDate, Number of repetitions)

    The recurrence Interval is defined as Java period Object, that supports ISO 8601. It allows numerous possibilities to set the interval.
    The string always starts with a 'P' for period. The interval can contain a number of years (Y), months (M) weeks (W) or Days (D) or any combination of them.
    The number is placed in front of the unit. Weeks are transformed to days by multiplying with 7 -> (P4W = P28D).

NOTE:
By default the subscriptions feature is disabled for the channel.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketRO com.intershop.sellside.rest.common.capi.resource.basket.BasketResource.editBasketByID(com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketRO)

Request Body

BasketRO application/json

Request Parameters

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

Response

200 - OK

BasketRO application/json

400 - Bad Request

Possible values for header 'error-key:
- basket.addreess_not_found_error
- basket.basket_id_required.error
- basket.invalid_address.error
- basket.store_addresses_not_allowed.error
- customer.address.missing_fields.error
- basket.recurring_not_allowed.error
- basket.cost_center.no_customer.error
- basket.cost_center.invalid_customer.error
- basket.cost_center.not_found.error
- basket.affiliate.invalid.error
- basket.promotioncode.invalid.error.{xxx}

Possible messages for missing attributes:
- interval
- startDate

401 - Unauthorized

404 - Not Found

possible values for header 'error-key':
- basket.basket_not_found.error

501 - Not Implemented

(if the recurring order feature is disabled),
possible values for header 'error-key':
- error.recurring_orders.disabled

503 - Service Unavailable

(if Microservice is not available and/or cannot be discovered)
OPTIONS: Returns all available options for the given basket

Description

Returns the following available options for the given basket:

  • common shipping methods

    Depending on the flag isMultipleShippmentSupported the option request returnsall available shipping methods for the whole basket or the option request returns nothing:

  • isMultipleShippmentSupported = true: There are no shipping methods for the whole basket availablebecause the shipping methods are only available at the line item level
  • isMultipleShippmentSupported = false: The option request returns all available shipping methodsfor the whole basket (shipping methods on basket level)

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketOptionsRO com.intershop.sellside.rest.common.capi.resource.basket.BasketResource.getBasketOptions()

Request Body

--

Request Parameters

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

Response

200 - OK

BasketOptionsRO application/json

401 - Unauthorized

403 - Forbidden

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

404 - Not Found

Line Item API

/baskets/{BasketResourceKey}/items
GET: Gets all line items contained in the given basket.

Description

Gets a collection of all line items contained in the basket. The line items are provided as simple list without any structuring according to shipping buckets the line items are assigned to.
If the basket is not found a status code 404 is returned, otherwise - status code 200.

Java Method

public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource.getBasketContent()

Request Body

--

Request Parameters

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

Response

200 - OK

AbstractResourceObject application/json

400 - Bad Request

possible values for header error-key:
- basket.basket_id_required.error

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: Adds a list of items or line items of a quote to an existing basket

Description

Adds a list of items to the basket.The items are either specified in the request body, or come from quote that will be specified with the quote ID. If a quote contains invalid products (delete, offline etc.) then all available products from the quote are added to the basket. If the quote contains no valid products at all an error occurs (400 - quote.no_valid_items.error).
For every item sku and quantity has to be specified. For gift certificates additional information are required. That is recipient email, recipient name, sender email, sender name and greeting message.
If basket is not found, a status code 404 is returned as a response. If any error occurs when adding products to the basket, then a status code 400 is returned.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemListResource.addItemsToBasket(com.intershop.sellside.rest.common.capi.resourceobject.basket.ExtendedLineItemCollectionRO)

Request Body

ExtendedLineItemCollectionRO 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.basket_id_required.error
- basket.gift.message.to_required.error
- basket.gift.message.from_required.error
- basket.gift.message.message_required.error
- basket.product.add_to_basket_unsuccessful.error
- basket.product.not_found.error
- basket.product.sku_required.error
- basket.product.quantity_invalid.error
- quote.no_valid_items.error

401 - Unauthorized

403 - Forbidden

possible values for header error-key:
- quote.expired.error
- quote.rejected.error

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

404 - Not Found

possible values for header error-key:
- basket.basket_not_found.error
- basket.product.not_found.error
/baskets/{BasketResourceKey}/items/{BasketLineKey}
GET: Get the specified line item from basket.

Description

Gets the line item with the specified ID.
Status code 404 is returned, if basket or basket item could not be found.

Java Method

public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.getItemFromBasketByID()

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

AbstractResourceObject application/json

400 - Bad Request

possible values for header error-key:
- basket.basket_id_required.error
- basket.lineitem.id_required.error

401 - Unauthorized

403 - Forbidden

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

404 - Not Found

possible values for header error-key:
- basket.basket_not_found.error
- basket.lineitem.not_found.error
PUT: Sets line item related data

Description

Sets following line item related data:

  • Quantity
  • Product variation option
  • Ship-to address
  • Shipping method
  • Gift certificate data

    If basket or basket line item is not found then a status code 404 is returned as a result.
    Depending on the flag MultipleShipmentsSupported the shipping methods and addresses can be set at the line item level:

  • MultipleShipmentsSupported = true: the shipping methods and addresses can be set on line item level (not at basket level)
  • MultipleShipmentsSupported = false: the shipping methods and addresses cannot be set on line item level (only at basket level)

Java Method

public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.updateItemsFromBasket(com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemRO)

Request Body

BasketLineItemRO 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

Response

200 - OK

AbstractResourceObject application/json

400 - Bad Request

possible values for header error-key:
- basket.basket_id_required.error
- basket.gift.message.to_required.error
- basket.gift.message.from_required.error
- basket.gift.message.message_required.error
- basket.lineitem.id_required.error
- basket.product.sku_required.error
- basket.product.variation.update_not_successful.error
- basket.product.update_quantity.error
- basket.invalid_address.error

401 - Unauthorized

403 - Forbidden

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

404 - Not Found

possible values for header error-key:
- basket.basket_not_found.error
- basket.lineitem.not_found.error
- basket.product.not_found.error
- basket.warranty.not_found.error
DELETE: Removes the specified line item from basket.

Description

Removes the line item with the given ID from the basket. The result basket's summary.
Status code 404 is returned if the basket or the line item could not be found.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.removeItemFromBasket()

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

303 - See Other

LinkRO application/json

400 - Bad Request

possible values for header error-key:
- basket.lineitem.id_required.error
- basket.basket_id_required.error

401 - Unauthorized

403 - Forbidden

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

404 - Not Found

possible values for header error-key:
- basket.basket_not_found.error
OPTIONS: Returns all available options for the given line item

Description

Returns the following available options for the given basket line item:

  • Eligible shipping methods
  • Warranties
  • Gift wraps
  • Gift messages
  • Product variation options

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketLineItemOptionsRO com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.getBasketLineItemOptions()

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

BasketLineItemRO application/json

403 - Forbidden

Requires authentication with user having assigned the following permissions:
- Purchase (APP_B2B_PURCHASE, only in B2B applications)
/baskets/{BasketResourceKey}/items/{BasketLineKey}/sublineitems
GET: Get basket subline items

Description

--

Java Method

public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.getSubLineItemsFromBasketByID()

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

default - Unknown

default response
AbstractResourceObject application/json
/baskets/{BasketResourceKey}/items/{BasketLineKey}/sublineitems/{subLineItemName}
GET: Get the sub-line type of a specific basket item.

Description

Get the sub-line type of a specific basket item. Valid types are warranty, gift wrap and gift message. If basket or basket item, or sub-line type is not found then a status code 404 is returned as a result.

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketDependentLineItemRO com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.getSublineItem(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathsubLineItemNamestringRequired
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

BasketDependentLineItemRO application/json

400 - Bad Request

possible values for header error-key:
- basket.basket_id_required.error
- basket.lineitem.id_required.error
- basket.item.sublinetype.missing_fields.error

401 - Unauthorized

403 - Forbidden

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

404 - Not Found

possible values for header error-key:
- basket.basket_not_found.error
- basket.item.unknown_sublinetype.error
- basket.lineitem.not_found.error
PUT: Modify the sublinetype of a specific basket item

Description

Modify the sublinetype of a specific basket item. Valid types are warranty, giftwrap and giftmessage. If basket or basket item, or subline type is not found then a status code 404 is returned as a result. If product sku is not provided a status code 400 is returned as a result.

Java Method

public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.updateSublineItem(java.lang.String,com.intershop.sellside.rest.common.capi.resourceobject.basket.BasketDependentLineItemRO)

Request Body

BasketDependentLineItemRO application/json

Request Parameters

LocationNameFormatDescription
in pathsubLineItemNamestringRequired
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

AbstractResourceObject application/json

400 - Bad Request

possible values for header error-key:
- basket.basket_sku_required.error
- basket.lineitem.id_required.error
- basket.product.sku_required.error
- basket.product.not_found.error
- basket.gift.message.from_required.error
- basket.gift.message.to_required.error
- basket.gift.message.message_required.error
- basket.lineitem.product.no_applicable.error
- basket.basket_id_required.error

401 - Unauthorized

403 - Forbidden

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

404 - Not Found

possible values for header error-key:
- basket.basket_id_required.error
- basket.lineitem.not_found.error
- basket.lineitem.subline_type_required.error
- basket.basket_not_found.error
DELETE: Delete the sublinetype of a specific basket item

Description

Delete the sublinetype of a specific basket item. Valid types are warranty, giftwrap and giftmessage.If basket or basket item, or subline type is not found then a status code 404 is returned as a result.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.basket.BasketLineItemResource.removeSublineItem(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathsubLineItemNamestringRequired
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

303 - See Other

LinkRO application/json

400 - Bad Request

possible values for header error-key:
- basket.basket_id_required.error
- basket.lineitem.id_required.error

401 - Unauthorized

403 - Forbidden

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

404 - Not Found

possible values for header error-key:
- basket.basket_not_found.error
- basket.lineitem.id_required.error
- basket.lineitem.subline_type_required.error
- basket.lineitem.id_required.error
- basket.lineitem.not_found.error

Payment API

/baskets/{BasketResourceKey}/payments
GET: Returns a list with all selected payments for the basket

Description

Returns a list of links of all selected payment methods for the basket

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource.getBasketPayments()

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 {BasketPaymentKey} in subsequent requests. Links to item of type PaymentRO.

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: Adds a payment method to the basket

Description

Adds a payment method to the basket. If the user is logged in a registered payment method can be referenced via ID (for payments that have been created with POST /customers/-/payments)

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource.addPaymentToBasket(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO)

Request Body

PaymentRO 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:
- shopping_cart.payment.paymentdata.error (e.g., wrong giftcard number)
- shopping_cart.payment.missing_fields.error
- shopping_cart.payment.invalid_fields.error
- shopping_cart.payment.name.error (Payment method not found)
- shopping_cart.payment.dublicate.error
- shopping_cart.payment.available.error (also thrown if basket contains NO items)

401 - Unauthorized

403 - Forbidden

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

404 - Not Found

possible values for header error-key:
- basket.basket_not_found.error
OPTIONS: Returns all available payment methods and their parameters available for this basket

Description

Returns all available payment methods and their parameters, which are available for this basket

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource.getBasketPaymentOptions()

Request Body

--

Request Parameters

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

Response

200 - OK

PaymentOptionsRO application/json

401 - Unauthorized

403 - Forbidden

Requires authentication with user having assigned the following permissions:
- Purchase (APP_B2B_PURCHASE, only in B2B applications)
/baskets/{BasketResourceKey}/payments/{BasketPaymentKey}
GET: Returns details of the payment method

Description

Returns detailed information of the payment method

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentItemResource.getBasketPayment()

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

PaymentRO application/json

401 - Unauthorized

403 - Forbidden

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

404 - Not Found

DELETE: Removes selected payment method from basket payments.

Description

Removes selected payment method from basket payments.

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentItemResource.removePaymentFromBasket()

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

303 - See Other

(link to basket)
LinkRO application/json

401 - Unauthorized

403 - Forbidden

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

404 - Not Found

/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

Request and Response Object Schemata

AbstractResourceObject 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.
}
BasketDependentLineItemRO 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.
  • "sku":
    string
  • "price":
    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
    }
  • "displayName":
    string
  • "id":
    string
  • "subType":
    string
    Possible Values: WARRANTYGIFTWRAPGIFTMESSAGE
  • "image":
    string
  • "to":
    string
  • "from":
    string
  • "message":
    string
}
BasketLineItemRO 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.
  • "sku":
    string
  • "quantity":
    object
    A QuantityRO object. Quantity combines a quantity value and the ISO unit code the value is defined in.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | This is a constant: Quantity | Example: Quantity
    • "value":
      number
      The quantity's value | Example: 10.99
    • "unit":
      string
      The quantity's ISO unit code. | Example: PIEC
    }
  • "shipToAddress":
    object
    A AddressRO object. This resource holds the details of an address.
    {
    • "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: Address
    • "urn":
      string
      the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
    • "id":
      string
      The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
    • "addressName":
      string
      The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
    • "title":
      string
      The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
    • "aristocraticTitle":
      string
      the aristocratic title of the contact person, like Lord or Lady
    • "jobTitle":
      string
      the job title of the contact person | Example: CEO
    • "honorific":
      string
      the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
    • "firstName":
      string
      The (first) given name of the contact person | Example: Patricia
    • "secondName":
      string
      the second given name of the contact person | Example: Luise
    • "lastName":
      string
      The last name of the contact person | Example: Miller
    • "secondLastName":
      string
      the second last name of the contact person
    • "companyName1":
      string
      the company name | Example: PMiller ltd.
    • "companyName2":
      string
      The second company name
    • "addressLine1":
      string
      the first address line | Example: Berliner Str. 20
    • "addressLine2":
      string
      the second address line | Example: 1st Floor
    • "addressLine3":
      string
      The third address line | Example: Second door on the right
    • "postBox":
      string
      the post-office box | Example: PO Box 42
    • "mainDivision":
      string
      the main division of the country, e. g. a state or province | Example: AL
    • "mainDivisionName":
      string
      The localized display name of the main division | Example: Alabama
    • "subDivision":
      string
      The sub division code of the country. | Example: GB-PKN
    • "subDivisionName":
      string
      The localized display name of the sub division | Example: Perth and Kinross
    • "postalCode":
      string
      The postal code | Example: 14482
    • "email":
      string
      the e-mail address of the contact person | Example: pmiller@intershop.de
    • "phoneMobile":
      string
      The number of the contact person's cell phone | Example: 49364112677
    • "phoneHome":
      string
      The phone number of the house or apartment where the contact person lives | Example: 049364112677
    • "phoneBusiness":
      string
      The phone number of the contact person's company | Example: 049364112699
    • "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 | Example: 049364112659
    • "country":
      string
      The display name of the country in the current locale | Example: Germany
    • "countryCode":
      string
      The country code | Example: DE
    • "city":
      string
      The name of the city | Example: Potsdam
    • "fax":
      string
      the fax number | Example: 049364112643
    • "usage":
      object
      Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
      {
      • "empty":
        boolean
      }
    }
  • "shippingMethod":
    object
    A ShippingMethodRO object. This resource describes a shipping method that can be selected as delivery option.
    {
    • "name":
      string
      The name of an element. | Example: Standard Ground
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "id":
      string
      the id of the returned element | Example: STD_GROUND
    • "description":
      string
      The description of the Shipping Method | Example: 3-7 Day Ground - Delivered to you 3-7 business days after we process your order
    • "shippingTimeMin":
      integer
      The minimum shipping time in days | Format: int32 | Example: 3
    • "shippingTimeMax":
      integer
      The maximum shipping time in days | Format: int32 | Example: 7
    }
  • "totals":
    object
    A BasketLineItemTotalsRO object.
    {
    • "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.
    • "total":
      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
      }
    • "valueRebatesTotal":
      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
      }
    • "shippingTotal":
      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
      }
    • "shippingRebatesTotal":
      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
      }
    • "giftingTotal":
      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
      }
    • "salesTaxTotal":
      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
      }
    • "shippingTaxTotal":
      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
      }
    }
  • "salesTaxes":
    array
    An array of AppliedTaxRO objects.
    [
    AppliedTaxRO: the taxes applied to the surcharge amount as collection of AppliedTaxRO
    {
    • "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: AppliedTax
    • "amount":
      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
      }
    • "rate":
      number
      the tax rate, 100 = 100% | Example: 19
    }
    ]
  • "shippingTaxes":
    array
    An array of AppliedTaxRO objects.
    [
    AppliedTaxRO: the taxes applied to the surcharge amount as collection of AppliedTaxRO
    {
    • "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: AppliedTax
    • "amount":
      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
      }
    • "rate":
      number
      the tax rate, 100 = 100% | Example: 19
    }
    ]
  • "itemSurcharges":
    array
    An array of SurchargeRO objects.
    [
    SurchargeRO: This resource describes a single surcharge incurred to a shipping bucket.
    {
    • "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: Surcharge
    • "amount":
      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
      }
    • "description":
      string
      the description of the surcharge
    • "displayName":
      string
      the display name of the surcharge
    • "taxes":
      array
      An array of AppliedTaxRO objects. the taxes applied to the surcharge amount as collection of AppliedTaxRO
      [
      AppliedTaxRO: the taxes applied to the surcharge amount as collection of AppliedTaxRO
      {
      • "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: AppliedTax
      • "amount":
        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
        }
      • "rate":
        number
        the tax rate, 100 = 100% | Example: 19
      }
      ]
    }
    ]
  • "itemImportSurcharges":
    array
    An array of SurchargeRO objects.
    [
    SurchargeRO: This resource describes a single surcharge incurred to a shipping bucket.
    {
    • "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: Surcharge
    • "amount":
      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
      }
    • "description":
      string
      the description of the surcharge
    • "displayName":
      string
      the display name of the surcharge
    • "taxes":
      array
      An array of AppliedTaxRO objects. the taxes applied to the surcharge amount as collection of AppliedTaxRO
      [
      AppliedTaxRO: the taxes applied to the surcharge amount as collection of AppliedTaxRO
      {
      • "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: AppliedTax
      • "amount":
        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
        }
      • "rate":
        number
        the tax rate, 100 = 100% | Example: 19
      }
      ]
    }
    ]
  • "valueRebates":
    array
    An array of AppliedRebateRO objects.
    [
    AppliedRebateRO:
    {
    • "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: AppliedRebate
    • "rebateType":
      string
      the type of the applied rebate | Example: OrderValueOffDiscount
    • "amount":
      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
      }
    • "code":
      string
      the code of the applied rebate | Example: INTERSHOP
    • "description":
      string
      The description of the applied rebate | Example: For orders over 200 USD, a 10 USD Order discount is guaranteed for the Promo Code 'INTERSHOP'.
    }
    ]
  • "shippingRebates":
    array
    An array of AppliedRebateRO objects.
    [
    AppliedRebateRO:
    {
    • "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: AppliedRebate
    • "rebateType":
      string
      the type of the applied rebate | Example: OrderValueOffDiscount
    • "amount":
      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
      }
    • "code":
      string
      the code of the applied rebate | Example: INTERSHOP
    • "description":
      string
      The description of the applied rebate | Example: For orders over 200 USD, a 10 USD Order discount is guaranteed for the Promo Code 'INTERSHOP'.
    }
    ]
  • "product":
    object
    A LinkRO object. 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.
      }
    }
  • "warranty":
    object
    A LinkRO object. 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.
      }
    }
  • "giftMessage":
    object
    A LinkRO object. 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.
      }
    }
  • "thumbnail":
    object
    A LinkRO object. 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.
      }
    }
  • "price":
    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
    }
  • "singleBasePrice":
    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
    }
  • "id":
    string
  • "position":
    integer
    Format: int32
  • "isHiddenGift":
    boolean
  • "isFreeGift":
    boolean
  • "inStock":
    boolean
  • "senderName":
    string
  • "senderEmail":
    string
  • "recipientName":
    string
  • "recipientEmail":
    string
  • "greetingMessage":
    string
  • "variationProduct":
    boolean
  • "bundleProduct":
    boolean
  • "availability":
    boolean
  • "giftwrap":
    object
    A LinkRO object. 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.
      }
    }
}
BasketOptionsRO 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.
  • "availableShippingMethods":
    object
    A AvailableShippingMethodsRO object.
    {
    • "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.
    • "shippingMethods":
      array
      An array of ShippingMethodRO objects.
      [
      ShippingMethodRO: This resource describes a shipping method that can be selected as delivery option.
      {
      • "name":
        string
        The name of an element. | Example: Standard Ground
      • "type":
        string
        Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
      • "id":
        string
        the id of the returned element | Example: STD_GROUND
      • "description":
        string
        The description of the Shipping Method | Example: 3-7 Day Ground - Delivered to you 3-7 business days after we process your order
      • "shippingTimeMin":
        integer
        The minimum shipping time in days | Format: int32 | Example: 3
      • "shippingTimeMax":
        integer
        The maximum shipping time in days | Format: int32 | Example: 7
      }
      ]
    • "description":
      string
    }
}
BasketRO 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: Basket
  • "id":
    string
    The id of the basket | Example: zP8KAB17ceUAAAFGntJqQASH
  • "purchaseCurrency":
    string
    The purchase currency of the basket | Example: USD
  • "externalOrderReferenceID":
    string
  • "taxationID":
    string
    the taxation ID associated with the basket | Example: 99999999999
  • "taxExempt":
    boolean
    is the basket tax exempt? | Example: false
  • "department":
    string
    the buyers department in case of unregistered checkout | Example: Sales
  • "costCenterID":
    string
    The cost Center ID of the basket | Example: 511288
  • "newOwnerAuthenticationToken":
    string
  • "documentNumber":
    string
    the document number of the basket | Example: 0000042
  • "recurringOrderDocumentNo":
    string
    the recurring order document number, if basket is configured as recurring | Example: 0000009
  • "dynamicMessages":
    array
    An array of string literals.
  • "invoiceToAddress":
    object
    A AddressRO object. This resource holds the details of an address.
    {
    • "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: Address
    • "urn":
      string
      the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
    • "id":
      string
      The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
    • "addressName":
      string
      The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
    • "title":
      string
      The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
    • "aristocraticTitle":
      string
      the aristocratic title of the contact person, like Lord or Lady
    • "jobTitle":
      string
      the job title of the contact person | Example: CEO
    • "honorific":
      string
      the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
    • "firstName":
      string
      The (first) given name of the contact person | Example: Patricia
    • "secondName":
      string
      the second given name of the contact person | Example: Luise
    • "lastName":
      string
      The last name of the contact person | Example: Miller
    • "secondLastName":
      string
      the second last name of the contact person
    • "companyName1":
      string
      the company name | Example: PMiller ltd.
    • "companyName2":
      string
      The second company name
    • "addressLine1":
      string
      the first address line | Example: Berliner Str. 20
    • "addressLine2":
      string
      the second address line | Example: 1st Floor
    • "addressLine3":
      string
      The third address line | Example: Second door on the right
    • "postBox":
      string
      the post-office box | Example: PO Box 42
    • "mainDivision":
      string
      the main division of the country, e. g. a state or province | Example: AL
    • "mainDivisionName":
      string
      The localized display name of the main division | Example: Alabama
    • "subDivision":
      string
      The sub division code of the country. | Example: GB-PKN
    • "subDivisionName":
      string
      The localized display name of the sub division | Example: Perth and Kinross
    • "postalCode":
      string
      The postal code | Example: 14482
    • "email":
      string
      the e-mail address of the contact person | Example: pmiller@intershop.de
    • "phoneMobile":
      string
      The number of the contact person's cell phone | Example: 49364112677
    • "phoneHome":
      string
      The phone number of the house or apartment where the contact person lives | Example: 049364112677
    • "phoneBusiness":
      string
      The phone number of the contact person's company | Example: 049364112699
    • "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 | Example: 049364112659
    • "country":
      string
      The display name of the country in the current locale | Example: Germany
    • "countryCode":
      string
      The country code | Example: DE
    • "city":
      string
      The name of the city | Example: Potsdam
    • "fax":
      string
      the fax number | Example: 049364112643
    • "usage":
      object
      Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
      {
      • "empty":
        boolean
      }
    }
  • "commonShipToAddress":
    object
    A AddressRO object. This resource holds the details of an address.
    {
    • "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: Address
    • "urn":
      string
      the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
    • "id":
      string
      The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
    • "addressName":
      string
      The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
    • "title":
      string
      The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
    • "aristocraticTitle":
      string
      the aristocratic title of the contact person, like Lord or Lady
    • "jobTitle":
      string
      the job title of the contact person | Example: CEO
    • "honorific":
      string
      the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
    • "firstName":
      string
      The (first) given name of the contact person | Example: Patricia
    • "secondName":
      string
      the second given name of the contact person | Example: Luise
    • "lastName":
      string
      The last name of the contact person | Example: Miller
    • "secondLastName":
      string
      the second last name of the contact person
    • "companyName1":
      string
      the company name | Example: PMiller ltd.
    • "companyName2":
      string
      The second company name
    • "addressLine1":
      string
      the first address line | Example: Berliner Str. 20
    • "addressLine2":
      string
      the second address line | Example: 1st Floor
    • "addressLine3":
      string
      The third address line | Example: Second door on the right
    • "postBox":
      string
      the post-office box | Example: PO Box 42
    • "mainDivision":
      string
      the main division of the country, e. g. a state or province | Example: AL
    • "mainDivisionName":
      string
      The localized display name of the main division | Example: Alabama
    • "subDivision":
      string
      The sub division code of the country. | Example: GB-PKN
    • "subDivisionName":
      string
      The localized display name of the sub division | Example: Perth and Kinross
    • "postalCode":
      string
      The postal code | Example: 14482
    • "email":
      string
      the e-mail address of the contact person | Example: pmiller@intershop.de
    • "phoneMobile":
      string
      The number of the contact person's cell phone | Example: 49364112677
    • "phoneHome":
      string
      The phone number of the house or apartment where the contact person lives | Example: 049364112677
    • "phoneBusiness":
      string
      The phone number of the contact person's company | Example: 049364112699
    • "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 | Example: 049364112659
    • "country":
      string
      The display name of the country in the current locale | Example: Germany
    • "countryCode":
      string
      The country code | Example: DE
    • "city":
      string
      The name of the city | Example: Potsdam
    • "fax":
      string
      the fax number | Example: 049364112643
    • "usage":
      object
      Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
      {
      • "empty":
        boolean
      }
    }
  • "commonShippingMethod":
    object
    A ShippingMethodRO object. This resource describes a shipping method that can be selected as delivery option.
    {
    • "name":
      string
      The name of an element. | Example: Standard Ground
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "id":
      string
      the id of the returned element | Example: STD_GROUND
    • "description":
      string
      The description of the Shipping Method | Example: 3-7 Day Ground - Delivered to you 3-7 business days after we process your order
    • "shippingTimeMin":
      integer
      The minimum shipping time in days | Format: int32 | Example: 3
    • "shippingTimeMax":
      integer
      The maximum shipping time in days | Format: int32 | Example: 7
    }
  • "paymentMethods":
    array
    An array of PaymentMethodRO objects. The Payment methods for this basket
    [
    PaymentMethodRO: The Payment methods for this basket
    {
    • "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: PaymentMethod
    • "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.
      }
      ]
    • "displayName":
      string
      the display name of the payment method | Example: Intershop Credit Card
    • "costs":
      array
      An array of PaymentCostRO objects. the costs of this PaymentMethod as list of PaymentCostRO objects
      [
      PaymentCostRO: the costs of this PaymentMethod as list of PaymentCostRO objects
      {
      • "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.
      • "minOrderAmount":
        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
        }
      • "maxOrderAmount":
        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
        }
      • "cost":
        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
        }
      • "threshold":
        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
        }
      }
      ]
    • "uri":
      string
    • "openTender":
      boolean
    • "default":
      boolean
      is this payment method the default one? | Example: true
    • "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.
      }
    }
    ]
  • "promotions":
    array
    An array of PromotionLinkRO objects. The Promotions for this basket
    [
    PromotionLinkRO: The Promotions for this basket
    {
    • "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: PromotionLink
    • "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
    • "relation":
      string
      Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
    • "description":
      string
    • "itemId":
      string
    • "code":
      string
      the code of the promotion | Example: INTERSHOP
    • "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.
      }
    }
    ]
  • "valueRebates":
    array
    An array of AppliedRebateRO objects. The Applied Rebates for this basket
    [
    AppliedRebateRO:
    {
    • "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: AppliedRebate
    • "rebateType":
      string
      the type of the applied rebate | Example: OrderValueOffDiscount
    • "amount":
      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
      }
    • "code":
      string
      the code of the applied rebate | Example: INTERSHOP
    • "description":
      string
      The description of the applied rebate | Example: For orders over 200 USD, a 10 USD Order discount is guaranteed for the Promo Code 'INTERSHOP'.
    }
    ]
  • "shippingRebates":
    array
    An array of AppliedRebateRO objects. The Applied Shipping Rebates for this basket
    [
    AppliedRebateRO:
    {
    • "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: AppliedRebate
    • "rebateType":
      string
      the type of the applied rebate | Example: OrderValueOffDiscount
    • "amount":
      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
      }
    • "code":
      string
      the code of the applied rebate | Example: INTERSHOP
    • "description":
      string
      The description of the applied rebate | Example: For orders over 200 USD, a 10 USD Order discount is guaranteed for the Promo Code 'INTERSHOP'.
    }
    ]
  • "itemSurchargeTotalsByType":
    array
    An array of SurchargeRO objects. The Item Surcharge Totals by type for this basket
    [
    SurchargeRO: This resource describes a single surcharge incurred to a shipping bucket.
    {
    • "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: Surcharge
    • "amount":
      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
      }
    • "description":
      string
      the description of the surcharge
    • "displayName":
      string
      the display name of the surcharge
    • "taxes":
      array
      An array of AppliedTaxRO objects. the taxes applied to the surcharge amount as collection of AppliedTaxRO
      [
      AppliedTaxRO: the taxes applied to the surcharge amount as collection of AppliedTaxRO
      {
      • "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: AppliedTax
      • "amount":
        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
        }
      • "rate":
        number
        the tax rate, 100 = 100% | Example: 19
      }
      ]
    }
    ]
  • "bucketSurchargeTotalsByType":
    array
    An array of SurchargeRO objects. The Bucket Surcharge Totals by type for this basket
    [
    SurchargeRO: This resource describes a single surcharge incurred to a shipping bucket.
    {
    • "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: Surcharge
    • "amount":
      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
      }
    • "description":
      string
      the description of the surcharge
    • "displayName":
      string
      the display name of the surcharge
    • "taxes":
      array
      An array of AppliedTaxRO objects. the taxes applied to the surcharge amount as collection of AppliedTaxRO
      [
      AppliedTaxRO: the taxes applied to the surcharge amount as collection of AppliedTaxRO
      {
      • "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: AppliedTax
      • "amount":
        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
        }
      • "rate":
        number
        the tax rate, 100 = 100% | Example: 19
      }
      ]
    }
    ]
  • "salesTaxTotalsByTaxRate":
    array
    An array of AppliedTaxRO objects. The Sales Tax Totals by tax rate for this basket
    [
    AppliedTaxRO: the taxes applied to the surcharge amount as collection of AppliedTaxRO
    {
    • "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: AppliedTax
    • "amount":
      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
      }
    • "rate":
      number
      the tax rate, 100 = 100% | Example: 19
    }
    ]
  • "shippingTaxTotalsByTaxRate":
    array
    An array of AppliedTaxRO objects. The Shipping Tax Totals by tax rate for this basket
    [
    AppliedTaxRO: the taxes applied to the surcharge amount as collection of AppliedTaxRO
    {
    • "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: AppliedTax
    • "amount":
      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
      }
    • "rate":
      number
      the tax rate, 100 = 100% | Example: 19
    }
    ]
  • "recurrence":
    object
    A RecurrenceRO object. The ReccurenceRO for this basket
    {
    • "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: Recurrence
    • "startDate":
      string
      the start date of the reccurence | Format: date-time
    • "endDate":
      string
      the end date of the reccurence | Format: date-time
    • "interval":
      object
      the reccurence interval | Example: P3M
      {
      • "years":
        integer
        Format: int32
      • "months":
        integer
        Format: int32
      • "days":
        integer
        Format: int32
      • "zero":
        boolean
      • "chronology":
        object
        {
        • "calendarType":
          string
        • "id":
          string
        }
      • "units":
        array
        An array of object literals.
        [
        {
        • "duration":
          object
          {
          • "seconds":
            integer
            Format: int64
          • "zero":
            boolean
          • "nano":
            integer
            Format: int32
          • "negative":
            boolean
          }
        • "dateBased":
          boolean
        • "timeBased":
          boolean
        • "durationEstimated":
          boolean
        }
        ]
      • "negative":
        boolean
      }
    • "repetitions":
      integer
      the number of repetitions for this reccurence | Format: int32 | Example: 42
    • "executeMissedOrders":
      boolean
    }
  • "shippingBuckets":
    array
    An array of BasketShippingBucketRO objects. The Shipping Buckets in this basket
    [
    BasketShippingBucketRO: The Shipping Buckets in this basket
    {
    • "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: BasketShippingBucket
    • "shipToAddress":
      object
      A AddressRO object. This resource holds the details of an address.
      {
      • "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: Address
      • "urn":
        string
        the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
      • "id":
        string
        The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
      • "addressName":
        string
        The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
      • "title":
        string
        The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
      • "aristocraticTitle":
        string
        the aristocratic title of the contact person, like Lord or Lady
      • "jobTitle":
        string
        the job title of the contact person | Example: CEO
      • "honorific":
        string
        the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
      • "firstName":
        string
        The (first) given name of the contact person | Example: Patricia
      • "secondName":
        string
        the second given name of the contact person | Example: Luise
      • "lastName":
        string
        The last name of the contact person | Example: Miller
      • "secondLastName":
        string
        the second last name of the contact person
      • "companyName1":
        string
        the company name | Example: PMiller ltd.
      • "companyName2":
        string
        The second company name
      • "addressLine1":
        string
        the first address line | Example: Berliner Str. 20
      • "addressLine2":
        string
        the second address line | Example: 1st Floor
      • "addressLine3":
        string
        The third address line | Example: Second door on the right
      • "postBox":
        string
        the post-office box | Example: PO Box 42
      • "mainDivision":
        string
        the main division of the country, e. g. a state or province | Example: AL
      • "mainDivisionName":
        string
        The localized display name of the main division | Example: Alabama
      • "subDivision":
        string
        The sub division code of the country. | Example: GB-PKN
      • "subDivisionName":
        string
        The localized display name of the sub division | Example: Perth and Kinross
      • "postalCode":
        string
        The postal code | Example: 14482
      • "email":
        string
        the e-mail address of the contact person | Example: pmiller@intershop.de
      • "phoneMobile":
        string
        The number of the contact person's cell phone | Example: 49364112677
      • "phoneHome":
        string
        The phone number of the house or apartment where the contact person lives | Example: 049364112677
      • "phoneBusiness":
        string
        The phone number of the contact person's company | Example: 049364112699
      • "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 | Example: 049364112659
      • "country":
        string
        The display name of the country in the current locale | Example: Germany
      • "countryCode":
        string
        The country code | Example: DE
      • "city":
        string
        The name of the city | Example: Potsdam
      • "fax":
        string
        the fax number | Example: 049364112643
      • "usage":
        object
        Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
        {
        • "empty":
          boolean
        }
      }
    • "shippingMethod":
      object
      A BasketShippingMethodRO object. the shippingMethod of the bucket as ShippingMethodRO
      {
      • "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: BasketShippingMethod
      • "id":
        string
        The id of the returned element | Example: STD_GROUND
      • "shippingTimeMin":
        integer
        The minimum shipping time in days | Format: int32 | Example: 3
      • "shippingTimeMax":
        integer
        The maximum shipping time in days | Format: int32 | Example: 7
      }
    • "packSlipMessage":
      string
      the pack slip message of the bucket | Example: Your order is here!
    • "shippingInstructions":
      string
      the shipping instrucations of the bucket | Example: Keep away from water
    • "bucketSurcharges":
      array
      An array of SurchargeRO objects. the surcharges of the bucket as SurchargeRO
      [
      SurchargeRO: This resource describes a single surcharge incurred to a shipping bucket.
      {
      • "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: Surcharge
      • "amount":
        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
        }
      • "description":
        string
        the description of the surcharge
      • "displayName":
        string
        the display name of the surcharge
      • "taxes":
        array
        An array of AppliedTaxRO objects. the taxes applied to the surcharge amount as collection of AppliedTaxRO
        [
        AppliedTaxRO: the taxes applied to the surcharge amount as collection of AppliedTaxRO
        {
        • "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: AppliedTax
        • "amount":
          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
          }
        • "rate":
          number
          the tax rate, 100 = 100% | Example: 19
        }
        ]
      }
      ]
    • "shippingRebates":
      array
      An array of AppliedRebateRO objects. the shipping rebates of the bucket as AppliedRebateRO
      [
      AppliedRebateRO:
      {
      • "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: AppliedRebate
      • "rebateType":
        string
        the type of the applied rebate | Example: OrderValueOffDiscount
      • "amount":
        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
        }
      • "code":
        string
        the code of the applied rebate | Example: INTERSHOP
      • "description":
        string
        The description of the applied rebate | Example: For orders over 200 USD, a 10 USD Order discount is guaranteed for the Promo Code 'INTERSHOP'.
      }
      ]
    • "lineItems":
      array
      An array of LinkRO objects. the line items of the bucket as Collection of LinkROs
      [
      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.
        }
      }
      ]
    }
    ]
  • "affiliatePartnerID":
    string
    The AffiliatePartnerID for this basket
  • "affiliateProgramID":
    string
    The AffiliateProgramID for this basket
  • "totals":
    object
    A BasketTotalsRO object. The totals for this basket
    {
    • "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: BasketTotals
    • "itemTotal":
      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
      }
    • "itemRebatesTotal":
      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
      }
    • "shippingTotal":
      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
      }
    • "itemShippingRebatesTotal":
      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
      }
    • "bucketShippingRebatesTotal":
      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
      }
    • "basketValueRebatesTotal":
      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
      }
    • "basketShippingRebatesTotal":
      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
      }
    • "paymentCostsTotal":
      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
      }
    • "taxTotal":
      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
      }
    • "dutiesAndSurchargesTotal":
      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
      }
    • "basketTotal":
      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
      }
    • "basketTotalMinusLimitedTender":
      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
      }
    • "limitedTenderTotal":
      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
      }
    }
  • "multipleShippmentsSupported":
    boolean
    true, if multiple shipments are supported | Example: true
}
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
}
ExtendedLineItemCollectionRO 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 BasketLineItemRO objects. The list of elements
    [
    BasketLineItemRO:
    {
    • "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.
    • "sku":
      string
    • "quantity":
      object
      A QuantityRO object. Quantity combines a quantity value and the ISO unit code the value is defined in.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | This is a constant: Quantity | Example: Quantity
      • "value":
        number
        The quantity's value | Example: 10.99
      • "unit":
        string
        The quantity's ISO unit code. | Example: PIEC
      }
    • "shipToAddress":
      object
      A AddressRO object. This resource holds the details of an address.
      {
      • "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: Address
      • "urn":
        string
        the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
      • "id":
        string
        The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
      • "addressName":
        string
        The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
      • "title":
        string
        The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
      • "aristocraticTitle":
        string
        the aristocratic title of the contact person, like Lord or Lady
      • "jobTitle":
        string
        the job title of the contact person | Example: CEO
      • "honorific":
        string
        the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
      • "firstName":
        string
        The (first) given name of the contact person | Example: Patricia
      • "secondName":
        string
        the second given name of the contact person | Example: Luise
      • "lastName":
        string
        The last name of the contact person | Example: Miller
      • "secondLastName":
        string
        the second last name of the contact person
      • "companyName1":
        string
        the company name | Example: PMiller ltd.
      • "companyName2":
        string
        The second company name
      • "addressLine1":
        string
        the first address line | Example: Berliner Str. 20
      • "addressLine2":
        string
        the second address line | Example: 1st Floor
      • "addressLine3":
        string
        The third address line | Example: Second door on the right
      • "postBox":
        string
        the post-office box | Example: PO Box 42
      • "mainDivision":
        string
        the main division of the country, e. g. a state or province | Example: AL
      • "mainDivisionName":
        string
        The localized display name of the main division | Example: Alabama
      • "subDivision":
        string
        The sub division code of the country. | Example: GB-PKN
      • "subDivisionName":
        string
        The localized display name of the sub division | Example: Perth and Kinross
      • "postalCode":
        string
        The postal code | Example: 14482
      • "email":
        string
        the e-mail address of the contact person | Example: pmiller@intershop.de
      • "phoneMobile":
        string
        The number of the contact person's cell phone | Example: 49364112677
      • "phoneHome":
        string
        The phone number of the house or apartment where the contact person lives | Example: 049364112677
      • "phoneBusiness":
        string
        The phone number of the contact person's company | Example: 049364112699
      • "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 | Example: 049364112659
      • "country":
        string
        The display name of the country in the current locale | Example: Germany
      • "countryCode":
        string
        The country code | Example: DE
      • "city":
        string
        The name of the city | Example: Potsdam
      • "fax":
        string
        the fax number | Example: 049364112643
      • "usage":
        object
        Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
        {
        • "empty":
          boolean
        }
      }
    • "shippingMethod":
      object
      A ShippingMethodRO object. This resource describes a shipping method that can be selected as delivery option.
      {
      • "name":
        string
        The name of an element. | Example: Standard Ground
      • "type":
        string
        Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
      • "id":
        string
        the id of the returned element | Example: STD_GROUND
      • "description":
        string
        The description of the Shipping Method | Example: 3-7 Day Ground - Delivered to you 3-7 business days after we process your order
      • "shippingTimeMin":
        integer
        The minimum shipping time in days | Format: int32 | Example: 3
      • "shippingTimeMax":
        integer
        The maximum shipping time in days | Format: int32 | Example: 7
      }
    • "totals":
      object
      A BasketLineItemTotalsRO object.
      {
      • "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.
      • "total":
        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
        }
      • "valueRebatesTotal":
        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
        }
      • "shippingTotal":
        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
        }
      • "shippingRebatesTotal":
        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
        }
      • "giftingTotal":
        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
        }
      • "salesTaxTotal":
        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
        }
      • "shippingTaxTotal":
        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
        }
      }
    • "salesTaxes":
      array
      An array of AppliedTaxRO objects.
      [
      AppliedTaxRO: the taxes applied to the surcharge amount as collection of AppliedTaxRO
      {
      • "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: AppliedTax
      • "amount":
        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
        }
      • "rate":
        number
        the tax rate, 100 = 100% | Example: 19
      }
      ]
    • "shippingTaxes":
      array
      An array of AppliedTaxRO objects.
      [
      AppliedTaxRO: the taxes applied to the surcharge amount as collection of AppliedTaxRO
      {
      • "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: AppliedTax
      • "amount":
        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
        }
      • "rate":
        number
        the tax rate, 100 = 100% | Example: 19
      }
      ]
    • "itemSurcharges":
      array
      An array of SurchargeRO objects.
      [
      SurchargeRO: This resource describes a single surcharge incurred to a shipping bucket.
      {
      • "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: Surcharge
      • "amount":
        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
        }
      • "description":
        string
        the description of the surcharge
      • "displayName":
        string
        the display name of the surcharge
      • "taxes":
        array
        An array of AppliedTaxRO objects. the taxes applied to the surcharge amount as collection of AppliedTaxRO
        [
        AppliedTaxRO: the taxes applied to the surcharge amount as collection of AppliedTaxRO
        {
        • "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: AppliedTax
        • "amount":
          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
          }
        • "rate":
          number
          the tax rate, 100 = 100% | Example: 19
        }
        ]
      }
      ]
    • "itemImportSurcharges":
      array
      An array of SurchargeRO objects.
      [
      SurchargeRO: This resource describes a single surcharge incurred to a shipping bucket.
      {
      • "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: Surcharge
      • "amount":
        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
        }
      • "description":
        string
        the description of the surcharge
      • "displayName":
        string
        the display name of the surcharge
      • "taxes":
        array
        An array of AppliedTaxRO objects. the taxes applied to the surcharge amount as collection of AppliedTaxRO
        [
        AppliedTaxRO: the taxes applied to the surcharge amount as collection of AppliedTaxRO
        {
        • "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: AppliedTax
        • "amount":
          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
          }
        • "rate":
          number
          the tax rate, 100 = 100% | Example: 19
        }
        ]
      }
      ]
    • "valueRebates":
      array
      An array of AppliedRebateRO objects.
      [
      AppliedRebateRO:
      {
      • "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: AppliedRebate
      • "rebateType":
        string
        the type of the applied rebate | Example: OrderValueOffDiscount
      • "amount":
        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
        }
      • "code":
        string
        the code of the applied rebate | Example: INTERSHOP
      • "description":
        string
        The description of the applied rebate | Example: For orders over 200 USD, a 10 USD Order discount is guaranteed for the Promo Code 'INTERSHOP'.
      }
      ]
    • "shippingRebates":
      array
      An array of AppliedRebateRO objects.
      [
      AppliedRebateRO:
      {
      • "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: AppliedRebate
      • "rebateType":
        string
        the type of the applied rebate | Example: OrderValueOffDiscount
      • "amount":
        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
        }
      • "code":
        string
        the code of the applied rebate | Example: INTERSHOP
      • "description":
        string
        The description of the applied rebate | Example: For orders over 200 USD, a 10 USD Order discount is guaranteed for the Promo Code 'INTERSHOP'.
      }
      ]
    • "product":
      object
      A LinkRO object. 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.
        }
      }
    • "warranty":
      object
      A LinkRO object. 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.
        }
      }
    • "giftMessage":
      object
      A LinkRO object. 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.
        }
      }
    • "thumbnail":
      object
      A LinkRO object. 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.
        }
      }
    • "price":
      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
      }
    • "singleBasePrice":
      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
      }
    • "id":
      string
    • "position":
      integer
      Format: int32
    • "isHiddenGift":
      boolean
    • "isFreeGift":
      boolean
    • "inStock":
      boolean
    • "senderName":
      string
    • "senderEmail":
      string
    • "recipientName":
      string
    • "recipientEmail":
      string
    • "greetingMessage":
      string
    • "variationProduct":
      boolean
    • "bundleProduct":
      boolean
    • "availability":
      boolean
    • "giftwrap":
      object
      A LinkRO object. 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
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "quoteID":
    string
  • "name":
    string
    The name of an element.
}
LinkRO application/json{
  • "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.
    }
}
PaymentOptionsRO 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: PaymentOptions
  • "methods":
    array
    An array of PaymentOptionsForMethodRO objects. payment methods that can be added via http
    [
    PaymentOptionsForMethodRO: payment methods that can be added via http
    {
    • "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: PaymentOptionsForMethodRO
    • "payments":
      array
      An array of PaymentOptionRO objects. the payments
      [
      PaymentOptionRO: the payments
      {
      • "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: PaymentOption
      • "id":
        string
        the id of the payment option | Example: ISH_INVOICE
      • "displayName":
        string
        the display name of the payment option | Example: Invoice
      • "applicability":
        string
      • "restrictions":
        array
        An array of string literals.
      • "paymentParameters":
        array
        An array of GenericPropertyROObject objects. the parameters for this payment option
        [
        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
        }
        ]
      }
      ]
    • "method":
      string
      the http method to use when adding this method | Example: POST
    }
    ]
}
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.
    }
}
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