Document Properties
Kbid
29Y606
Last Modified
30-May-2023
Added to KB
03-Sep-2020
Public Access
Everyone
Status
Online
Doc Type
References
Product
ICM 7.10
Home ⋮ Knowledge Base
Reference - Subscription (Recurring Order) REST API 1.0.0
Share this document
ReDoc View
Document View


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

References

The following page lists available REST APIs for ICM 7.10 and their version dependencies:

API Specification

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

The Intershop Recurring Order API contains operations for managing a recipient's recurring orders and related payment information.

General API

This section covers operations for managing recurring orders. This includes retrieving a list of recurring orders, details for a specific recurring order and activating/deactivating a specific recurring order.

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

Description

This operation returns a list of links of all recurring orders for the customer.

Note: This operation requires account administrator permissions for B2B.

Java Method

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

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID

Response

200 - OK - The recurring orders for the given customer.

RecurringOrderLinkROResourceCollection application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer could not be found.

501 - Not Implemented - The recurring order feature is disabled. Possible values for header value 'error-key':
- error.recurring_orders.disabled

503 - Service Unavailable - The Microservice is not available and/or cannot be discovered.

/customers/{CustomerKey}/recurringorders/{RecurringOrderKey}
GET: Returns details about a customer's recurring order

Description

This operation returns details about the recurring order to the client.

Note: This operation requires account administrator permissions for B2B.

The recurrence Interval is defined as Java Period Object that supports ISO 8601. It provides numerous ways 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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

200 - OK - The recurring order with the given ID.

RecurringOrderRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer or the recurring order could not be found.

501 - Not Implemented - The recurring order feature is disabled. Possible values for header 'error-key':
- error.recurring_orders.disabled

503 - Service Unavailable - The microservice is not available and/or cannot be discovered.

PUT: Updates a recurring order

Description

This operation updates the selected recurring order.

Only activation and deactivation are supported. Expired recurring orders cannot be set to active.

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

200 - OK - The updated recurring order.

RecurringOrderRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer or the recurring order could not be found.

409 - Conflict - The recurring order cannot be enabled. Possible values for header value 'error-key':
- error.recurring_orders.enable-not-possible

501 - Not Implemented - The recurring order feature is disabled. Possible values for header value 'error-key':
- error.recurring-orders.disabled

503 - Service Unavailable - The 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

This operation returns a list of links of all recurring orders for the customer.

Note: This operation requires account administrator permissions for B2B.

Java Method

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

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCustomerItemUserKeystringpmiller@test.intershop.deRequired | The user ID

Response

200 - OK - The recurring orders for the given customer.

RecurringOrderLinkROResourceCollection application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer could not be found.

501 - Not Implemented - The recurring order feature is disabled. Possible values for header value 'error-key':
- error.recurring_orders.disabled

503 - Service Unavailable - The Microservice is not available and/or cannot be discovered.

/customers/{CustomerKey}/users/{CustomerItemUserKey}/recurringorders/{RecurringOrderKey}
GET: Returns details about a customer's recurring order

Description

This operation returns details about the recurring order to the client.

Note: This operation requires account administrator permissions for B2B.

The recurrence Interval is defined as Java Period Object that supports ISO 8601. It provides numerous ways 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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCustomerItemUserKeystringpmiller@test.intershop.deRequired | The user ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

200 - OK - The recurring order with the given ID.

RecurringOrderRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer or the recurring order could not be found.

501 - Not Implemented - The recurring order feature is disabled. Possible values for header 'error-key':
- error.recurring_orders.disabled

503 - Service Unavailable - The microservice is not available and/or cannot be discovered.

PUT: Updates a recurring order

Description

This operation updates the selected recurring order.

Only activation and deactivation are supported. Expired recurring orders cannot be set to active.

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCustomerItemUserKeystringpmiller@test.intershop.deRequired | The user ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

200 - OK - The updated recurring order.

RecurringOrderRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer or the recurring order could not be found.

409 - Conflict - The recurring order cannot be enabled. Possible values for header value 'error-key':
- error.recurring_orders.enable-not-possible

501 - Not Implemented - The recurring order feature is disabled. Possible values for header value 'error-key':
- error.recurring-orders.disabled

503 - Service Unavailable - The 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

This operation returns a list of links of all recurring orders for the customer.

Note: This operation requires account administrator permissions for B2B.

Java Method

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

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID

Response

200 - OK - The recurring orders for the given customer.

RecurringOrderLinkROResourceCollection application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer could not be found.

501 - Not Implemented - The recurring order feature is disabled. Possible values for header value 'error-key':
- error.recurring_orders.disabled

503 - Service Unavailable - The Microservice is not available and/or cannot be discovered.

/privatecustomers/{CustomerKey}/recurringorders/{RecurringOrderKey}
GET: Returns details about a customer's recurring order

Description

This operation returns details about the recurring order to the client.

Note: This operation requires account administrator permissions for B2B.

The recurrence Interval is defined as Java Period Object that supports ISO 8601. It provides numerous ways 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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

200 - OK - The recurring order with the given ID.

RecurringOrderRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer or the recurring order could not be found.

501 - Not Implemented - The recurring order feature is disabled. Possible values for header 'error-key':
- error.recurring_orders.disabled

503 - Service Unavailable - The microservice is not available and/or cannot be discovered.

PUT: Updates a recurring order

Description

This operation updates the selected recurring order.

Only activation and deactivation are supported. Expired recurring orders cannot be set to active.

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

200 - OK - The updated recurring order.

RecurringOrderRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer or the recurring order could not be found.

409 - Conflict - The recurring order cannot be enabled. Possible values for header value 'error-key':
- error.recurring_orders.enable-not-possible

501 - Not Implemented - The recurring order feature is disabled. Possible values for header value 'error-key':
- error.recurring-orders.disabled

503 - Service Unavailable - The microservice is not available and/or cannot be discovered.

Payment API

This section covers operations for managing payments for recurring orders. This includes retrieving, adding and removing payments.

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

Description

This operation 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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

200 - OK - The payments for the given recurring order.

LinkROResourceCollectionRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the basket could not be found.

POST: Adds payment to recurring order

Description

This operation adds a payment method to the recurring order. A registered payment method can be referenced via ID (for payments that have been created with POST /customers/-/payments).

Java Method

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

Request Body

PaymentRO application/json

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

201 - Created - The payment was added successfully.

400 - Bad Request - The payment instrument with this ID could not be found. 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 - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the basket could not be found. Possible values for header error-key:
- basket.basket_not_found.error

OPTIONS: Returns all payment options of recurring order

Description

This operation returns all available payment methods and their parameters available for the recurring order.

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

200 - OK - The payment options for the given recurring order.

PaymentOptionsRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer or the recurring order could not be found.

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

Description

This Operation returns details about the selected payment method for the recurring order.

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID
in pathRecurringOrderPaymentKeystringS2qsEmZRqqwAAAF27a.CwBhvRequired | The payment ID

Response

200 - OK - The payment with the given ID.

PaymentRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the payment could not be found.

DELETE: Removes payment from recurring order

Description

This operation removes the selected payment method from the 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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID
in pathRecurringOrderPaymentKeystringS2qsEmZRqqwAAAF27a.CwBhvRequired | The payment ID

Response

204 - No Content - The payment was successfully deleted.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the payment could not be found.

/customers/{CustomerKey}/recurringorders/{RecurringOrderKey}/payments/{RecurringOrderPaymentKey}/redirect
PUT: Creates URL for redirect to the payment provider

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

Note: This operation requires authentication with the 'Purchase' permission ('APP_B2B_PURCHASE', only in B2B applications).

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID
in pathRecurringOrderPaymentKeystringS2qsEmZRqqwAAAF27a.CwBhvRequired | The payment ID

Response

201 - Created - The redirect URL was successfully created.

400 - Bad Request - The payment service does not support redirect capability.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the payment could not be found.

POST: Sends transaction details after redirect to the shop system

Description

When the user has processed a payment transaction at the payment provider's system, he will be redirected back to the REST client. Regardless of the outcome of this transaction, the 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 request 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

  • etc

Note: This operation requires authentication with the 'Purchase' permission ('APP_B2B_PURCHASE', only in B2B applications).

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID
in pathRecurringOrderPaymentKeystringS2qsEmZRqqwAAAF27a.CwBhvRequired | The payment ID

Response

200 - OK - The payment transaction was activated successfully.

PaymentRO application/json

400 - Bad Request - The payment service does not support redirect capability.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the payment could not be found.

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

Description

This operation 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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCustomerItemUserKeystringpmiller@test.intershop.deRequired | The user ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

200 - OK - The payments for the given recurring order.

LinkROResourceCollectionRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the basket could not be found.

POST: Adds payment to recurring order

Description

This operation adds a payment method to the recurring order. A registered payment method can be referenced via ID (for payments that have been created with POST /customers/-/payments).

Java Method

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

Request Body

PaymentRO application/json

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCustomerItemUserKeystringpmiller@test.intershop.deRequired | The user ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

201 - Created - The payment was added successfully.

400 - Bad Request - The payment instrument with this ID could not be found. 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 - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the basket could not be found. Possible values for header error-key:
- basket.basket_not_found.error

OPTIONS: Returns all payment options of recurring order

Description

This operation returns all available payment methods and their parameters available for the recurring order.

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCustomerItemUserKeystringpmiller@test.intershop.deRequired | The user ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

200 - OK - The payment options for the given recurring order.

PaymentOptionsRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer or the recurring order could not be found.

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

Description

This Operation returns details about the selected payment method for the recurring order.

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCustomerItemUserKeystringpmiller@test.intershop.deRequired | The user ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID
in pathRecurringOrderPaymentKeystringS2qsEmZRqqwAAAF27a.CwBhvRequired | The payment ID

Response

200 - OK - The payment with the given ID.

PaymentRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the payment could not be found.

DELETE: Removes payment from recurring order

Description

This operation removes the selected payment method from the 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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCustomerItemUserKeystringpmiller@test.intershop.deRequired | The user ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID
in pathRecurringOrderPaymentKeystringS2qsEmZRqqwAAAF27a.CwBhvRequired | The payment ID

Response

204 - No Content - The payment was successfully deleted.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the payment could not be 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 sent 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.

Note: This operation requires authentication with the 'Purchase' permission ('APP_B2B_PURCHASE', only in B2B applications).

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCustomerItemUserKeystringpmiller@test.intershop.deRequired | The user ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID
in pathRecurringOrderPaymentKeystringS2qsEmZRqqwAAAF27a.CwBhvRequired | The payment ID

Response

201 - Created - The redirect URL was successfully created.

400 - Bad Request - The payment service does not support redirect capability.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the payment could not be found.

POST: Get transaction details after redirect before checkout

Description

When the user has processed a payment transaction at the payment provider's system, he will be redirected back to the REST client. Regardless of the outcome of this transaction, the 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 request 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

  • etc

Note: This operation requires authentication with the 'Purchase' permission ('APP_B2B_PURCHASE', only in B2B applications).

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathCustomerItemUserKeystringpmiller@test.intershop.deRequired | The user ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID
in pathRecurringOrderPaymentKeystringS2qsEmZRqqwAAAF27a.CwBhvRequired | The payment ID

Response

200 - OK - The payment transaction was activated successfully.

PaymentRO application/json

400 - Bad Request - The payment service does not support redirect capability.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the payment could not be found.

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

Description

This operation 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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

200 - OK - The payments for the given recurring order.

LinkROResourceCollectionRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the basket could not be found.

POST: Adds payment to recurring order

Description

This operation adds a payment method to the recurring order. A registered payment method can be referenced via ID (for payments that have been created with POST /customers/-/payments).

Java Method

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

Request Body

PaymentRO application/json

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

201 - Created - The payment was added successfully.

400 - Bad Request - The payment instrument with this ID could not be found. 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 - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the basket could not be found. Possible values for header error-key:
- basket.basket_not_found.error

OPTIONS: Returns all payment options of recurring order

Description

This operation returns all available payment methods and their parameters available for the recurring order.

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID

Response

200 - OK - The payment options for the given recurring order.

PaymentOptionsRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer or the recurring order could not be found.

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

Description

This Operation returns details about the selected payment method for the recurring order.

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID
in pathRecurringOrderPaymentKeystringS2qsEmZRqqwAAAF27a.CwBhvRequired | The payment ID

Response

200 - OK - The payment with the given ID.

PaymentRO application/json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the payment could not be found.

DELETE: Removes payment from recurring order

Description

This operation removes the selected payment method from the 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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID
in pathRecurringOrderPaymentKeystringS2qsEmZRqqwAAAF27a.CwBhvRequired | The payment ID

Response

204 - No Content - The payment was successfully deleted.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the payment could not be 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 sent 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.

Note: This operation requires authentication with the 'Purchase' permission ('APP_B2B_PURCHASE', only in B2B applications).

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID
in pathRecurringOrderPaymentKeystringS2qsEmZRqqwAAAF27a.CwBhvRequired | The payment ID

Response

201 - Created - The redirect URL was successfully created.

400 - Bad Request - The payment service does not support redirect capability.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the payment could not be found.

POST: Get transaction details after redirect before checkout

Description

When the user has processed a payment transaction at the payment provider's system, he will be redirected back to the REST client. Regardless of the outcome of this transaction, the 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 request 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

  • etc

Note: This operation requires authentication with the 'Purchase' permission ('APP_B2B_PURCHASE', only in B2B applications).

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

LocationNameFormatDefaultExampleDescription
in pathCustomerKeystringOilCorpRequired | The customer ID
in pathRecurringOrderKeystring5Z.sEmZRpW0AAAF2Bi2CwBhvRequired | The recurring order ID
in pathRecurringOrderPaymentKeystringS2qsEmZRqqwAAAF27a.CwBhvRequired | The payment ID

Response

200 - OK - The payment transaction was activated successfully.

PaymentRO application/json

400 - Bad Request - The payment service does not support redirect capability.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

404 - Not Found - The customer, the recurring order or the payment could not be found.

Request and Response Object Schemata
LinkROResourceCollectionRO 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
    The type of the element. This is normally a constant that can be used to differentiate elements by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element
}
PaymentOptionsRO application/json{
  • "name":
    string
    The name of an element
  • "type":
    string
    The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: PaymentOptions
  • "methods":
    array
    An array of PaymentOptionsForMethodRO objects. The payment methods that can be added via HTTP
    [
    PaymentOptionsForMethodRO: This resource holds information about payment methods that can be added and the HTTP method to be used.
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: PaymentOptionsForMethodRO
    • "payments":
      array
      An array of PaymentOptionRO objects. The payments
      [
      PaymentOptionRO: This resource holds information on a payment option.
      {
      • "name":
        string
        The name of an element
      • "type":
        string
        The type of the element. This is normally a constant that can be used to differentiate elements 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
        Example: Applicable
      • "restrictions":
        array
        An array of string literals. The restrictions for this payment option
      • "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 element. This is normally a constant that can be used to differentiate elements 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 element. This is normally a constant that can be used to differentiate elements 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
    The payment ID | Example: dhKsEmZRPyEAAAF2hyV6dB2n
  • "limitedTenderBalance":
    object
    A MoneyRO object. Money combines a currency and a money amount.
    {
    • "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.
    {
    • "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. The parameters for this payment
    [
    GenericPropertyROObject
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      Readonly | The type of the element. This is normally a constant that can be used to differentiate elements 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 element. This is normally a constant that can be used to differentiate elements by their type. | Example: PaymentRedirect
  • "successURL":
    string
    The URL to return to when succeeded
  • "failURL":
    string
    The URL to return to when failed
  • "cancelURL":
    string
    The URL to return to when canceled
}
PaymentRedirectResponseRO application/json{
  • "name":
    string
    The name of an element
  • "type":
    string
    Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: PaymentRedirectResponse
  • "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
    Example: The ID
  • "parameters":
    array
    An array of GenericPropertyROObject objects. The parameters for this redirect response
    [
    GenericPropertyROObject
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      Readonly | The type of the element. This is normally a constant that can be used to differentiate elements 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: This resource holds basic information on the recurring order required for the list view.
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements 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.
      {
      • "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.
      {
      • "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
      • "chronology":
        object
        {
        • "calendarType":
          string
        • "id":
          string
        }
      • "zero":
        boolean
      • "negative":
        boolean
      • "units":
        array
        An array of object literals.
        [
        {
        • "dateBased":
          boolean
        • "timeBased":
          boolean
        • "durationEstimated":
          boolean
        • "duration":
          object
          {
          • "seconds":
            integer
            Format: int64
          • "zero":
            boolean
          • "negative":
            boolean
          • "nano":
            integer
            Format: int32
          }
        }
        ]
      }
    • "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
      Indicates whether the recurring order is 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. This resource holds details about the buyer as RecurringOrderBuyerRO.
      {
      • "name":
        string
        The name of an element
      • "type":
        string
        The type of the element. This is normally a constant that can be used to differentiate elements 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 | Example: Accounting
      • "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 element. This is normally a constant that can be used to differentiate elements 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 element. This is normally a constant that can be used to differentiate elements 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
    Indicates whether the recurring order is active or not | Example: true
  • "expired":
    boolean
    Is the recurring order expired? | Example: false
  • "multipleShipmentsSupported":
    boolean
    Are multiple shipments supported? | Example: true
  • "interval":
    string
    The interval of the recurring order | Example: P7D
  • "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. This resource holds details about the buyer as RecurringOrderBuyerRO.
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements 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 | Example: Accounting
    • "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
    The error code if an error occurred 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 element. This is normally a constant that can be used to differentiate elements 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
    • "externalId":
      string
      Readonly | The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
    • "externalUrn":
      string
      Readonly | The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
    • "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 element. This is normally a constant that can be used to differentiate elements 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
    • "externalId":
      string
      Readonly | The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
    • "externalUrn":
      string
      Readonly | The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
    • "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 element. This is normally a constant that can be used to differentiate elements by their type. | Example: ShippingMethod
    • "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
    }
  • "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 element. This is normally a constant that can be used to differentiate elements 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
      The payment ID | Example: dhKsEmZRPyEAAAF2hyV6dB2n
    • "limitedTenderBalance":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "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.
      {
      • "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. The parameters for this payment
      [
      GenericPropertyROObject
      {
      • "name":
        string
        The name of an element
      • "type":
        string
        Readonly | The type of the element. This is normally a constant that can be used to differentiate elements 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: This resource holds the shipping buckets of the recurring order as collection of RecurringOrderShippingBucketROs.
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements 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 element. This is normally a constant that can be used to differentiate elements 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
      • "externalId":
        string
        Readonly | The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
      • "externalUrn":
        string
        Readonly | The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
      • "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 element. This is normally a constant that can be used to differentiate elements by their type. | Example: ShippingMethod
      • "id":
        string
        the id of the returned element | Example: STD_GROUND
      • "shippingTimeMin":
        integer
        The minimum shipping time in days | Format: int32 | Example: 3
      • "shippingTimeMax":
        integer
        The maximum shipping time in days | Format: int32 | Example: 7
      }
    • "packSlipMessage":
      string
      The pack slip message of the bucket | Example: Your order is here.
    • "shippingInstructions":
      string
      The shipping 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: This resource holds the line items of the bucket as collection of RecurringOrderLineItemRO
      {
      • "name":
        string
        The name of an element
      • "type":
        string
        The type of the element. This is normally a constant that can be used to differentiate elements 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.
        {
        • "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 element. This is normally a constant that can be used to differentiate elements 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
        • "externalId":
          string
          Readonly | The ID uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: 000123456
        • "externalUrn":
          string
          Readonly | The URN uniquely identifying the address in an external system; required only for data objects that have already been synchronized with the external system | Example: urn:address:MSDynamics365:MyCorp:000123456
        • "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 element. This is normally a constant that can be used to differentiate elements by their type. | Example: ShippingMethod
        • "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
        }
      • "totals":
        object
        A RecurringOrderLineItemTotalsRO object. This resource holds the totals of the recurring order as RecurringOrderLineItemTotalsRO.
        {
        • "name":
          string
          The name of an element
        • "type":
          string
          The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: RecurringOrderLineItemTotals
        • "totalNet":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "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.
          {
          • "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.
          {
          • "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.
          {
          • "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.
          {
          • "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.
          {
          • "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.
          {
          • "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.
          {
          • "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.
          {
          • "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.
          {
          • "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.
          {
          • "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.
          {
          • "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 element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedTax
        • "rate":
          number
          the tax rate, 100 = 100% | Example: 19
        • "amount":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "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
          }
        }
        ]
      • "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 element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedTax
        • "rate":
          number
          the tax rate, 100 = 100% | Example: 19
        • "amount":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "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
          }
        }
        ]
      • "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 element. This is normally a constant that can be used to differentiate elements by their type. | Example: Surcharge
        • "amount":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "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 element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedTax
          • "rate":
            number
            the tax rate, 100 = 100% | Example: 19
          • "amount":
            object
            A MoneyRO object. Money combines a currency and a money amount.
            {
            • "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
            }
          }
          ]
        }
        ]
      • "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 element. This is normally a constant that can be used to differentiate elements by their type. | Example: Surcharge
        • "amount":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "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 element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedTax
          • "rate":
            number
            the tax rate, 100 = 100% | Example: 19
          • "amount":
            object
            A MoneyRO object. Money combines a currency and a money amount.
            {
            • "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
            }
          }
          ]
        }
        ]
      • "rebates":
        array
        An array of AppliedRebateRO objects. The applied rebates as collection of AppliedRebateRO
        [
        AppliedRebateRO
        {
        • "name":
          string
          The name of an element
        • "type":
          string
          The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedRebate
        • "rebateType":
          string
          the type of the applied rebate | Example: OrderValueOffDiscount
        • "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'.
        • "code":
          string
          the code of the applied rebate | Example: INTERSHOP
        • "amount":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "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
          }
        }
        ]
      • "shippingRebates":
        array
        An array of AppliedRebateRO objects. The shipping rebates as collection of AppliedRebateRO
        [
        AppliedRebateRO
        {
        • "name":
          string
          The name of an element
        • "type":
          string
          The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedRebate
        • "rebateType":
          string
          the type of the applied rebate | Example: OrderValueOffDiscount
        • "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'.
        • "code":
          string
          the code of the applied rebate | Example: INTERSHOP
        • "amount":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "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
          }
        }
        ]
      • "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.
        {
        • "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.
        {
        • "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.
        {
        • "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.
        {
        • "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 sender's name
      • "senderEmail":
        string
        The optional sender's email
      • "recipientName":
        string
        The optional recipients name
      • "recipientEmail":
        string
        The optional recipients email
      • "greetingMessage":
        string
        An optional greeting message
      • "variationProduct":
        boolean
        Indicates whether the product is a variation product. | Example: false
      • "bundleProduct":
        boolean
        Is this item part of a bundle? | Example: false
      • "availability":
        boolean
        Is this item available? | Example: true
      }
      ]
    }
    ]
  • "totals":
    object
    A RecurringOrderTotalsRO object. This resource holds the recurring order's totals as RecurringOrderTotalsRO.
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: RecurringOrderTotals
    • "itemTotalNet":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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.
      {
      • "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
    }
}
UpdateRecurringOrderRO application/json{
  • "name":
    string
    The name of an element
  • "type":
    string
    Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: RecurringOrder
  • "active":
    boolean
    Determines whether the recurring order is active | Example: true
}
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.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Home Page
Knowledge Base
Home Page
Search
Personal Library
Product Releases
Home Page
Search
Difference Report
Product Support Matrix
Service Connector Matrix
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.