The Intershop Customer Support website uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Further information on privacy can be found in the Intershop Privacy Policy and Legal Notice.
OK
Related Documents
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
Reference - Recurring Orders (Subscription) API 1.0.0
●
●
●
●
●
Document Properties
Kbid29Y606
Last Modified23-Mar-2021
Added to KB03-Sep-2020
Public AccessEveryone
StatusOnline
Doc TypeReferences
ProductICM 7.10
⋮

Reference - Recurring Orders (Subscription) API 1.0.0

https://support.intershop.com/kb/29Y606
Share this document


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: 

References

API Specification

Introduction

OpenAPI Version: 3.0.1
Subscription (Recurring Order) Version: 1.0.0

This is Intershop ICM REST API documentation.

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

Introduction

This API is documented in OpenAPI format.

General API

/customers/{CustomerKey}/recurringorders
GET: Returns a list of recurring orders of the given individual customer

Description

B2B: Returns a list of links of all recurring orders for the customer. Account administrator permissions required

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource.getRecurringOrders()

Request Body

--

Request Parameters

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

Response

200 - OK

RecurringOrderLinkROResourceCollection application/json

401 - Unauthorized

403 - Forbidden

501 - Not Implemented

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

503 - Service Unavailable

(if Microservice is not available and/or can not be discovered)
/customers/{CustomerKey}/recurringorders/{RecurringOrderKey}
GET: Returns details about customers recurring order to the client

Description

Returns details about business customers recurring order to the client. Requires account administrator permissions

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).

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource.getRecurringOrder()

Request Body

--

Request Parameters

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

Response

200 - OK

RecurringOrderRO application/json

401 - Unauthorized

404 - Not Found

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)
PUT: Updates a recurring order, support only activation and deactivation

Description

Expired recurring orders cannot be set to active

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).

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource.updateRecurringOrder(com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.UpdateRecurringOrderRO)

Request Body

UpdateRecurringOrderRO application/json

Request Parameters

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

Response

200 - OK

RecurringOrderRO application/json

401 - Unauthorized

409 - Conflict

(if recurring order cannot be enabled)
possible values for header value 'error-key':
- error.recurring_orders.enable-not-possible

500 - Internal Server Error

501 - Not Implemented

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

503 - Service Unavailable

(if Microservice is not available and/or cannot be discovered)
/customers/{CustomerKey}/users/{CustomerItemUserKey}/recurringorders
GET: Returns a list of recurring orders of the given individual customer

Description

B2B: Returns a list of links of all recurring orders for the customer. Account administrator permissions required

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource.getRecurringOrders()

Request Body

--

Request Parameters

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

Response

200 - OK

RecurringOrderLinkROResourceCollection application/json

401 - Unauthorized

403 - Forbidden

501 - Not Implemented

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

503 - Service Unavailable

(if Microservice is not available and/or can not be discovered)
/customers/{CustomerKey}/users/{CustomerItemUserKey}/recurringorders/{RecurringOrderKey}
GET: Returns details about customers recurring order to the client

Description

Returns details about business customers recurring order to the client. Requires account administrator permissions

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).

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource.getRecurringOrder()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

RecurringOrderRO application/json

401 - Unauthorized

404 - Not Found

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)
PUT: Updates a recurring order, support only activation and deactivation

Description

Expired recurring orders cannot be set to active

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).

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource.updateRecurringOrder(com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.UpdateRecurringOrderRO)

Request Body

UpdateRecurringOrderRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

RecurringOrderRO application/json

401 - Unauthorized

409 - Conflict

(if recurring order cannot be enabled)
possible values for header value 'error-key':
- error.recurring_orders.enable-not-possible

500 - Internal Server Error

501 - Not Implemented

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

503 - Service Unavailable

(if Microservice is not available and/or cannot be discovered)
/privatecustomers/{CustomerKey}/recurringorders
GET: Returns a list of recurring orders of the given individual customer

Description

B2B: Returns a list of links of all recurring orders for the customer. Account administrator permissions required

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderListResource.getRecurringOrders()

Request Body

--

Request Parameters

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

Response

200 - OK

RecurringOrderLinkROResourceCollection application/json

401 - Unauthorized

403 - Forbidden

501 - Not Implemented

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

503 - Service Unavailable

(if Microservice is not available and/or can not be discovered)
/privatecustomers/{CustomerKey}/recurringorders/{RecurringOrderKey}
GET: Returns details about customers recurring order to the client

Description

Returns details about business customers recurring order to the client. Requires account administrator permissions

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).

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource.getRecurringOrder()

Request Body

--

Request Parameters

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

Response

200 - OK

RecurringOrderRO application/json

401 - Unauthorized

404 - Not Found

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)
PUT: Updates a recurring order, support only activation and deactivation

Description

Expired recurring orders cannot be set to active

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).

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderItemResource.updateRecurringOrder(com.intershop.sellside.rest.common.capi.resourceobject.recurringorder.UpdateRecurringOrderRO)

Request Body

UpdateRecurringOrderRO application/json

Request Parameters

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

Response

200 - OK

RecurringOrderRO application/json

401 - Unauthorized

409 - Conflict

(if recurring order cannot be enabled)
possible values for header value 'error-key':
- error.recurring_orders.enable-not-possible

500 - Internal Server Error

501 - Not Implemented

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

503 - Service Unavailable

(if Microservice is not available and/or cannot be discovered)

Payment API

/customers/{CustomerKey}/recurringorders/{RecurringOrderKey}/payments
GET: Get payments of recurring order

Description

Returns a list of all selected payments for the recurring order

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.getRecurringOrderPayments()

Request Body

--

Request Parameters

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

Response

200 - OK

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

401 - Unauthorized

403 - Forbidden

404 - Not Found

(basket not found)
POST: Add payment to recurring order

Description

--

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.addPaymentToRecurringOrder(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO)

Request Body

PaymentRO application/json

Request Parameters

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

Response

200 - OK

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

404 - Not Found

possible values for header error-key:
- basket.basket_not_found.error
OPTIONS: Returns all payment options of recurring order

Description

--

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.getRecurringOrderPaymentOptions()

Request Body

--

Request Parameters

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

Response

200 - OK

PaymentOptionsRO application/json

401 - Unauthorized

403 - Forbidden

404 - Not Found

/customers/{CustomerKey}/recurringorders/{RecurringOrderKey}/payments/{RecurringOrderPaymentKey}
GET: Get payment details of recurring order payments

Description

--

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource.getRecurringOrderPayment()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderPaymentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

PaymentRO application/json

401 - Unauthorized

403 - Forbidden

404 - Not Found

DELETE: Remove payment from recurring order

Description

Removes selected payment method from recurring order payments

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource.removePaymentFromRecurringOrder()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderPaymentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

401 - Unauthorized

403 - Forbidden

404 - Not Found

/customers/{CustomerKey}/recurringorders/{RecurringOrderKey}/payments/{RecurringOrderPaymentKey}/redirect
PUT: Get return-URLs from REST client for payment provider redirect

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.recurringorder.RecurringOrderPaymentRedirectResource.createRedirectURL(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectRO)

Request Body

PaymentRedirectRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderPaymentKeystringRequired | 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: Get transaction details after redirect before checkout

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.recurringorder.RecurringOrderPaymentRedirectResource.addRedirectResponseData(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectResponseRO)

Request Body

PaymentRedirectResponseRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderPaymentKeystringRequired | 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

/customers/{CustomerKey}/users/{CustomerItemUserKey}/recurringorders/{RecurringOrderKey}/payments
GET: Get payments of recurring order

Description

Returns a list of all selected payments for the recurring order

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.getRecurringOrderPayments()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

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

401 - Unauthorized

403 - Forbidden

404 - Not Found

(basket not found)
POST: Add payment to recurring order

Description

--

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.addPaymentToRecurringOrder(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO)

Request Body

PaymentRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

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

404 - Not Found

possible values for header error-key:
- basket.basket_not_found.error
OPTIONS: Returns all payment options of recurring order

Description

--

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.getRecurringOrderPaymentOptions()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

PaymentOptionsRO application/json

401 - Unauthorized

403 - Forbidden

404 - Not Found

/customers/{CustomerKey}/users/{CustomerItemUserKey}/recurringorders/{RecurringOrderKey}/payments/{RecurringOrderPaymentKey}
GET: Get payment details of recurring order payments

Description

--

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource.getRecurringOrderPayment()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderPaymentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

PaymentRO application/json

401 - Unauthorized

403 - Forbidden

404 - Not Found

DELETE: Remove payment from recurring order

Description

Removes selected payment method from recurring order payments

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource.removePaymentFromRecurringOrder()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderPaymentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

401 - Unauthorized

403 - Forbidden

404 - Not Found

/customers/{CustomerKey}/users/{CustomerItemUserKey}/recurringorders/{RecurringOrderKey}/payments/{RecurringOrderPaymentKey}/redirect
PUT: Get return-URLs from REST client for payment provider redirect

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.recurringorder.RecurringOrderPaymentRedirectResource.createRedirectURL(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectRO)

Request Body

PaymentRedirectRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderPaymentKeystringRequired | 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: Get transaction details after redirect before checkout

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.recurringorder.RecurringOrderPaymentRedirectResource.addRedirectResponseData(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectResponseRO)

Request Body

PaymentRedirectResponseRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderPaymentKeystringRequired | 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

/privatecustomers/{CustomerKey}/recurringorders/{RecurringOrderKey}/payments
GET: Get payments of recurring order

Description

Returns a list of all selected payments for the recurring order

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.getRecurringOrderPayments()

Request Body

--

Request Parameters

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

Response

200 - OK

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

401 - Unauthorized

403 - Forbidden

404 - Not Found

(basket not found)
POST: Add payment to recurring order

Description

--

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.addPaymentToRecurringOrder(com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO)

Request Body

PaymentRO application/json

Request Parameters

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

Response

200 - OK

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

404 - Not Found

possible values for header error-key:
- basket.basket_not_found.error
OPTIONS: Returns all payment options of recurring order

Description

--

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentListResource.getRecurringOrderPaymentOptions()

Request Body

--

Request Parameters

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

Response

200 - OK

PaymentOptionsRO application/json

401 - Unauthorized

403 - Forbidden

404 - Not Found

/privatecustomers/{CustomerKey}/recurringorders/{RecurringOrderKey}/payments/{RecurringOrderPaymentKey}
GET: Get payment details of recurring order payments

Description

--

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource.getRecurringOrderPayment()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderPaymentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

PaymentRO application/json

401 - Unauthorized

403 - Forbidden

404 - Not Found

DELETE: Remove payment from recurring order

Description

Removes selected payment method from recurring order payments

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentItemResource.removePaymentFromRecurringOrder()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderPaymentKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

401 - Unauthorized

403 - Forbidden

404 - Not Found

/privatecustomers/{CustomerKey}/recurringorders/{RecurringOrderKey}/payments/{RecurringOrderPaymentKey}/redirect
PUT: Get return-URLs from REST client for payment provider redirect

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.recurringorder.RecurringOrderPaymentRedirectResource.createRedirectURL(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectRO)

Request Body

PaymentRedirectRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderPaymentKeystringRequired | 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: Get transaction details after redirect before checkout

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.recurringorder.RecurringOrderPaymentRedirectResource.addRedirectResponseData(com.intershop.sellside.rest.common.capi.resource.basket.PaymentRedirectResponseRO)

Request Body

PaymentRedirectResponseRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathRecurringOrderPaymentKeystringRequired | 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

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.
    }
}
RecurringOrderLinkROResourceCollection 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 RecurringOrderLinkRO objects. The list of elements
    [
    RecurringOrderLinkRO: the list of elements
    {
    • "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: RecurringOrderLink
    • "creationDate":
      string
      the creation date of the recurring order | Format: date-time
    • "startDate":
      string
      the start date of the recurring order | Format: date-time
    • "endDate":
      string
      the end date of the recurring oder | Format: date-time
    • "lastOrderDate":
      string
      the last order date of the recurring order | Format: date-time
    • "nextOrderDate":
      string
      the next scheduled order date of this recurring order | Format: date-time
    • "totalNet":
      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
      }
    • "totalGross":
      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
      }
    • "number":
      string
      the number of the recurring order | Example: 0000009
    • "interval":
      object
      the period of the recurring order | 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 repititions for the recurring order | Format: int32 | Example: 0
    • "active":
      boolean
      is the recurring order active? | Example: true
    • "expired":
      boolean
      is the recurring order expired? | Example: false
    • "itemCount":
      integer
      the number of items in the recurring order | Format: int32 | Example: 1
    • "priceType":
      string
      the price type of the recurring order | Example: net
    • "buyer":
      object
      A RecurringOrderBuyerRO object. details about the buyer as RecurringOrderBuyerRO
      {
      • "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: RecurringOrderBuyer
      • "title":
        string
        the title of the buyer | Example: Mr.
      • "firstName":
        string
        the first name of the buyer | Example: Fritz
      • "lastName":
        string
        the last name of the buyer | Example: Birdo
      • "birthday":
        string
        the birthday of the buyer | Example: Mon Jan 10 00:00:00 CET 1916
      • "businessPartnerNo":
        string
        the business partner number of the buyer | Example: fbirdo
      • "department":
        string
        the department of the buyer
      • "login":
        string
        the login of the buyer | Example: fbirdo@test.intershop.de
      }
    • "link":
      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. | Example: RecurringOrderLinkResourceCollection
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element.
}
RecurringOrderRO 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: RecurringOrder
  • "id":
    string
    the id of the recurring order | Example: JFAKDgAj7jAAAAFiUhRgWKqi
  • "number":
    string
    the number of the recurring order | Example: 0000009
  • "active":
    boolean
    is the recurring order active? | Example: true
  • "expired":
    boolean
    is the recurring order expired? | Example: false
  • "multipleShipmentsSupported":
    boolean
    are multiple shipments supported? | Example: true
  • "interval":
    object
    the interval of the recurring order | Example: P7D
    {
    • "years":
      integer
      Format: int32
    • "months":
      integer
      Format: int32
    • "days":
      integer
      Format: int32
    • "zero":
      boolean
    • "chronology":
      object
      {
      • "calendarType":
        string
      • "id":
        string
      }
    • "units":
      array
      An array of object literals.
      [
      {
      • "duration":
        object
        {
        • "seconds":
          integer
          Format: int64
        • "zero":
          boolean
        • "nano":
          integer
          Format: int32
        • "negative":
          boolean
        }
      • "dateBased":
        boolean
      • "timeBased":
        boolean
      • "durationEstimated":
        boolean
      }
      ]
    • "negative":
      boolean
    }
  • "repetitions":
    integer
    the repetitions of the recurring order | Format: int32 | Example: 42
  • "creationDate":
    string
    the creation date of the recurring order | Format: date-time
  • "startDate":
    string
    the start date of the recurring order | Format: date-time
  • "endDate":
    string
    the end date of the recurring order | Format: date-time
  • "buyer":
    object
    A RecurringOrderBuyerRO object. details about the buyer as RecurringOrderBuyerRO
    {
    • "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: RecurringOrderBuyer
    • "title":
      string
      the title of the buyer | Example: Mr.
    • "firstName":
      string
      the first name of the buyer | Example: Fritz
    • "lastName":
      string
      the last name of the buyer | Example: Birdo
    • "birthday":
      string
      the birthday of the buyer | Example: Mon Jan 10 00:00:00 CET 1916
    • "businessPartnerNo":
      string
      the business partner number of the buyer | Example: fbirdo
    • "department":
      string
      the department of the buyer
    • "login":
      string
      the login of the buyer | Example: fbirdo@test.intershop.de
    }
  • "lastOrderDate":
    string
    the last order date of this recurring order | Format: date-time
  • "nextOrderDate":
    string
    the next scheduled order date of this recurring order | Format: date-time
  • "modifiedDate":
    string
    the date of the last modification of the recurring order | Format: date-time
  • "itemCount":
    integer
    the item count of this recurring order | Format: int32 | Example: 1
  • "orderCount":
    integer
    the count of orders from this recurring order | Format: int32 | Example: 2
  • "errorCode":
    string
    error code if an error occured during execution of recurring order
  • "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.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: ShippingMethod
    • "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
      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
    • "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.
      }
    }
  • "payments":
    array
    An array of PaymentRO objects. the payment methods for the recurring order as Collection of PaymentROs
    [
    PaymentRO:
    {
    • "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.
      }
    }
    ]
  • "shippingBuckets":
    array
    An array of RecurringOrderShippingBucketRO objects. the shipping buckets of the recurring order as collection of RecurringOrderShippingBucketROs
    [
    RecurringOrderShippingBucketRO: the shipping buckets of the recurring order as collection of RecurringOrderShippingBucketROs
    {
    • "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: RecurringOrderShippingBucket
    • "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.
      • "type":
        string
        The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: ShippingMethod
      • "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
        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
      • "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.
        }
      }
    • "packSlipMessage":
      string
      the pack slip message of the bucket | Example: your order is here
    • "shippingInstructions":
      string
      the shipping instructions of the bucket | Example: keep away from water
    • "lineItems":
      array
      An array of RecurringOrderLineItemRO objects. the line items of the bucket as Collection of RecurringOrderLineItemRO
      [
      RecurringOrderLineItemRO: the line items of the bucket as Collection of RecurringOrderLineItemRO
      {
      • "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: RecurringOrderLineItem
      • "sku":
        string
        the SKU of the line item | Example: 6946439
      • "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.
        • "type":
          string
          The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: ShippingMethod
        • "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
          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
        • "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.
          }
        }
      • "totals":
        object
        A RecurringOrderLineItemTotalsRO object. the totals of the recurring order as RecurringOrderLineItemTotalsRO
        {
        • "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: RecurringOrderLineItemTotals
        • "totalNet":
          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
          }
        • "rebatesTotalNet":
          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
          }
        • "shippingTotalNet":
          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
          }
        • "shippingRebatesTotalNet":
          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
          }
        • "giftingTotalNet":
          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
          }
        • "totalGross":
          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
          }
        • "rebatesTotalGross":
          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
          }
        • "shippingTotalGross":
          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
          }
        • "shippingRebatesTotalGross":
          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
          }
        • "giftingTotalGross":
          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
          }
        • "priceType":
          string
          the price type | Example: net
        • "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. the sales taxes 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
        }
        ]
      • "shippingTaxes":
        array
        An array of AppliedTaxRO objects. the shipping taxes 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
        }
        ]
      • "itemSurcharges":
        array
        An array of SurchargeRO objects. the item surcharges as Collection of 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
          }
          ]
        }
        ]
      • "itemImportSurcharges":
        array
        An array of SurchargeRO objects. the item import surcharges as Collection of 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
          }
          ]
        }
        ]
      • "rebates":
        array
        An array of AppliedRebateRO objects. the applied rebates as Collection of AppliedRebateRO
        [
        AppliedRebateRO: the shipping rebates as Collection of 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 shipping rebates as Collection of AppliedRebateRO
        [
        AppliedRebateRO: the shipping rebates as Collection of 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.
          }
        }
      • "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.
          }
        }
      • "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.
          }
        }
      • "priceNet":
        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
        }
      • "singleBasePriceNet":
        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
        }
      • "priceGross":
        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
        }
      • "singleBasePriceGross":
        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
        }
      • "priceType":
        string
        the price type of the line item | Example: net
      • "id":
        string
        the id of the line item | Example: g.AKDgA.KyoAAAFXVeY5PPtu
      • "position":
        integer
        the position of the line item | Format: int32 | Example: 1
      • "isHiddenGift":
        boolean
        is the line item a hidden gift? | Example: false
      • "isFreeGift":
        boolean
        is the line item a free gift? | Example: false
      • "inStock":
        boolean
        is this item in stock? | Example: true
      • "senderName":
        string
        the optional senders name
      • "senderEmail":
        string
        the optional senders email
      • "recipientName":
        string
        the optional recipients name
      • "recipientEmail":
        string
        the optional recipients email
      • "greetingMessage":
        string
        an optional greeting message
      • "availability":
        boolean
        is this item available? | Example: true
      • "variationProduct":
        boolean
        is this a product with variations? | Example: false
      • "bundleProduct":
        boolean
        is this item part of a bundle? | Example: false
      }
      ]
    }
    ]
  • "totals":
    object
    A RecurringOrderTotalsRO object. the recurring order's totals as RecurringOrderTotalsRO
    {
    • "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: RecurringOrderTotals
    • "itemTotalNet":
      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
      }
    • "itemRebatesTotalNet":
      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
      }
    • "shippingTotalNet":
      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
      }
    • "itemShippingRebatesTotalNet":
      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
      }
    • "bucketShippingRebatesTotalNet":
      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
      }
    • "rebatesTotalNet":
      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
      }
    • "shippingRebatesTotalNet":
      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
      }
    • "paymentCostsTotalNet":
      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
      }
    • "totalNet":
      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
      }
    • "itemTotalGross":
      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
      }
    • "itemRebatesTotalGross":
      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
      }
    • "shippingTotalGross":
      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
      }
    • "itemShippingRebatesTotalGross":
      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
      }
    • "bucketShippingRebatesTotalGross":
      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
      }
    • "rebatesTotalGross":
      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
      }
    • "shippingRebatesTotalGross":
      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
      }
    • "paymentCostsTotalGross":
      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
      }
    • "totalGross":
      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
      }
    • "priceType":
      string
      the price type | Example: net
    }
}
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
}
UpdateRecurringOrderRO 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.
  • "active":
    boolean
}

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.

Support Europe
+49 (3641)501600
support@intershop.de
Corporate Headquarters
Intershop Communications AG
Steinweg 10
07743 Jena
Germany
Support America
(415) 844-3730
support@intershop.com
Customer Support
Home Page
How To Contact Us
ISO 9001 Certified
Support Plans
Additional Services
Product Support Matrix
Support Newsletter
Contract Datasheet
Feedback Form
Support News Archive
Knowledge Base
Home Page
Search
Personal Library
Product Resources
Home Page
Search
Custom Fixes for your Account
Difference Report
Product Support Matrix
Service Connector Matrix
Tickets
Home Page
Search
Ticket Statistics
New Ticket