References

Public Release Note - D365 Finance and Operations Order History Connector 1

API Specification

Introduction

OpenAPI Version: none

Order History Service Version: 2.0.0

Microservice for retrieving order history details from Microsoft systems.

Order History Service - V1 API

/customers/urn:customer:MSDynamics365:{customerDataAreaId}:{customerAccountNumber}/orders

GET: Retrieves the order list for a given customer.

Description

Request Body

Request Parameters

Location	Name	Format	Description
in path	customerDataAreaId	string	Required
in path	customerAccountNumber	string	Required
in query	limit	integer `int32`
in query	offset	integer `int32`

Response

200 - OK The order list.

OrderSummaryListRO application/json

404 - Not Found No orders found for the specified user.

500 - Internal Server Error Error calling the backend system.

/customers/urn:customer:MSDynamics365:{customerDataAreaId}:{customerAccountNumber}/orders/urn:order:MSDynamics365:{salesOrderDataAreaId}:{salesOrderNumber}

GET: Retrieves order details for a given customer and order ID.

Description

Request Body

Request Parameters

Location	Name	Format	Description
in path	customerDataAreaId	string	Required
in path	customerAccountNumber	string	Required
in path	salesOrderDataAreaId	string	Required
in path	salesOrderNumber	string	Required

Response

200 - OK The updated basket

OrderRO application/json

500 - Internal Server Error Error calling the backend system.

Request and Response Object Schemata

OrderRO application/json

{

"header":
object
Required | A HeaderRO object. General information about the order. Describes general order document and processing data. Note: Beta version - This class can still be subject of change!
{
- "documentInfo":
  object
  Required | A DocumentInfoRO object. Information about the processing status of the order. Provides information about an order document. Note: Beta version - This class can still be subject of change!
  {
  - "orderUrn":
    string
    Required | URN representation of the order in an Intershop system. | Example: urn:order:ICM:inSPIRED:inTRONICS:00000002
  - "documentNo":
    string
    Required | Order document number uniquely identifying the order in the context of the store. | Example: 00000002
  - "store":
    string
    Required | Identifier of the store where the order has been placed. | Example: inTRONICS
  - "currency":
    string
    Required | The currency used for calculating prices and costs of the order (ISO 4217). | Example: USD
  - "locale":
    string
    Required | The locale the business partner used during the checkout process. | Example: en_US
  - "customerReferenceId":
    string
    Any custom reference ID of the order that can be specified by the buyer during the checkout process. An example would be a reference number existing in one of buyer's backend systems. | Example: RE201700002786598
  - "costCenter":
    string
    Customer's cost center the order should be assigned too. | Example: 100400
  - "costCenterName":
    string
    Name of customer's cost center the order should be assigned too. | Example: Oil Corp Headquarter
  - "messageToMerchant":
    string
    Something what the buyer would like to tell the merchant. | Example: Is it possible to send the ordered articles before Christmas?
  }
- "processInfo":
  object
  Required | A ProcessInfoRO object. General information about the order document. Describes the processing state of the order. Note: Beta version - This class can still be subject of change!
  {
  - "status":
    string
    Required | Processing the status of the order. | Possible Values: CANCELLEDCANCELLEDANDEXPORTEDCOMPLETEDCREATEDDELIVEREDEXPORTFAILEDINPROGRESSMANUAL_INTERVENTION_NEEDEDNEWNOTDELIVERABLEOPENPAYMENTCANCELLEDPENDINGREJECTEDRETURNED
  - "creationDate":
    string
    Required | The date, the order has been placed. | Example: 2001-07-04T12:08:56.235-07:00
  - "subscriptionNo":
    string
    The document no of the subscription if the order is triggered by a subscription. | Example: 00975-9C1
  }
}
"totals":
object
Required | A TotalsRO object. The order totals. Describes the order totals. Note: Beta version - This class can still be subject of change!
{
- "grandTotal":
  object
  Required | A PriceRO object. Grand total order value, simply spoken what the buyer has to pay for the order. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "itemTotal":
  object
  Required | A PriceRO object. Accumulated line item prices of the order including all discounts granted for line item prices (item value discounts). (Note: This value replaces the former "discountedItemTotal".) Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "undiscountedItemTotal":
  object
  Required | A PriceRO object. Accumulated line item prices of the order without any discounts. (Note: This value replaces the former "itemTotal".) Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "shippingTotal":
  object
  Required | A PriceRO object. Accumulated shipping costs of the order including all discounts, granted for shipping costs on all levels of the order (line item, shipping bucket, order). (Note: This value replaces the former "shippingTotal".) Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "undiscountedShippingTotal":
  object
  Required | A PriceRO object. Accumulated shipping costs of the order without any discounts. (Note: This value replaces the former "discountedShippingTotal".) Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "discountTotal":
  object
  A PriceRO object. Accumulated discounts of the order. Includes all kinds of discounts (item value, shipping) granted for item prices and shipping costs on all levels of the order (line item, shipping bucket, order). Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "giftingTotal":
  object
  A PriceRO object. Accumulated costs for gift wraps and messages. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "surchargeTotal":
  object
  A PriceRO object. Accumulated surcharges of the order, e.g. for bulky goods. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "itemValueDiscountsTotal":
  object
  A PriceRO object. Accumulated item level value discounts of the order, granted for line item prices on line item level. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "itemShippingDiscountsTotal":
  object
  A PriceRO object. Accumulated line item level shipping discounts of the order, granted for shipping costs on line item level. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "bucketShippingDiscountsTotal":
  object
  A PriceRO object. Accumulated bucket level shipping discounts of the order, granted for shipping costs on shipping bucket level. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "orderValueDiscountsTotal":
  object
  A PriceRO object. Accumulated order level value discounts of the order, granted for item prices on order level. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "orderShippingDiscountsTotal":
  object
  A PriceRO object. Accumulated order level shipping discounts of the order, granted for shipping costs on order level. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "valueDiscountsTotal":
  object
  A PriceRO object. Accumulated value discounts of the order, granted for item prices on line item and order level. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "shippingDiscountsTotal":
  object
  A PriceRO object. Accumulated shipping discounts of the order, granted for shipping costs on all levels (line item, shipping bucket, order). Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "paymentCostsTotal":
  object
  A PriceRO object. Accumulated payment costs of the order. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  - "net":
    object
    Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "gross":
    object
    Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  - "tax":
    object
    A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
    {
    "currency":
    string
    Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    "value":
    number
    Required | The monetary value. | Example: 10.99
    }
  }
- "salesTaxTotalsByTaxRate":
  array
  An array of TaxItemRO objects. All taxes applied to item sales prices of the order, accumulated by their tax rates.
  [
  TaxItemRO: Describes a single tax item. Note: Beta version - This class can still be subject of change!
  {
  "calculatedTax":
  object
  A MoneyRO object. The calculated tax amount. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  The effective rate used to calculate the tax.
  "taxId":
  string
  The ISH internal or user defined ID of the tax that can be used for retrieval of localized taxName. | Example: tax.germany.vat.full
  "taxName":
  string
  The ISH internal or user defined localized tax name. | Example: Germany Full VAT (19%)
  "situs":
  string
  The situs/place of taxation. | Example: DESTINATION | Possible Values: NULLADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "jurisdiction":
  object
  A JurisdictionRO object. The jurisdiction, an area subject to its own distinct tax regulations, such as a municipality, city, county or country. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country. Note: Beta version - This class can still be subject of change!
  {
  "value":
  string
  The jurisdiction. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  "id":
  string
  The ID identifiying the jurisdiction. This ID can be taxation service dependent, e.g. Vertex, AvaTax | Example: 35763
  }
  "imposition":
  object
  A ImpositionRO object. The kind of tax imposed/levied on the subjects of a state.
  {
  "value":
  string
  The imposed tax. | Example: Sales and Use Tax
  "type":
  string
  The type of the imposed tax. | Example: General Sales and Use Tax
  }
  "nonTaxableAmount":
  object
  A MoneyRO object. The amount, no tax has been calculated for. This is the portion of a specific price or a cost amount that is ignored for tax purposes. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "taxableAmount":
  object
  A MoneyRO object. The amount, the tax has been calculated for. This is the portion of a specific price or a cost amount that is subject to tax. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  ]
- "shippingTaxTotalsByTaxRate":
  array
  An array of TaxItemRO objects. All taxes applied to shipping costs of the order, accumulated by their tax rates.
  [
  TaxItemRO: Describes a single tax item. Note: Beta version - This class can still be subject of change!
  {
  "calculatedTax":
  object
  A MoneyRO object. The calculated tax amount. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  The effective rate used to calculate the tax.
  "taxId":
  string
  The ISH internal or user defined ID of the tax that can be used for retrieval of localized taxName. | Example: tax.germany.vat.full
  "taxName":
  string
  The ISH internal or user defined localized tax name. | Example: Germany Full VAT (19%)
  "situs":
  string
  The situs/place of taxation. | Example: DESTINATION | Possible Values: NULLADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "jurisdiction":
  object
  A JurisdictionRO object. The jurisdiction, an area subject to its own distinct tax regulations, such as a municipality, city, county or country. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country. Note: Beta version - This class can still be subject of change!
  {
  "value":
  string
  The jurisdiction. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  "id":
  string
  The ID identifiying the jurisdiction. This ID can be taxation service dependent, e.g. Vertex, AvaTax | Example: 35763
  }
  "imposition":
  object
  A ImpositionRO object. The kind of tax imposed/levied on the subjects of a state.
  {
  "value":
  string
  The imposed tax. | Example: Sales and Use Tax
  "type":
  string
  The type of the imposed tax. | Example: General Sales and Use Tax
  }
  "nonTaxableAmount":
  object
  A MoneyRO object. The amount, no tax has been calculated for. This is the portion of a specific price or a cost amount that is ignored for tax purposes. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "taxableAmount":
  object
  A MoneyRO object. The amount, the tax has been calculated for. This is the portion of a specific price or a cost amount that is subject to tax. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  ]
- "taxTotalsByTaxRate":
  array
  An array of TaxItemRO objects. All taxes applied to the order, accumulated by their tax rates. Includes taxes applied to item sales prices, shipping costs and surcharges.
  [
  TaxItemRO: Describes a single tax item. Note: Beta version - This class can still be subject of change!
  {
  "calculatedTax":
  object
  A MoneyRO object. The calculated tax amount. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  The effective rate used to calculate the tax.
  "taxId":
  string
  The ISH internal or user defined ID of the tax that can be used for retrieval of localized taxName. | Example: tax.germany.vat.full
  "taxName":
  string
  The ISH internal or user defined localized tax name. | Example: Germany Full VAT (19%)
  "situs":
  string
  The situs/place of taxation. | Example: DESTINATION | Possible Values: NULLADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "jurisdiction":
  object
  A JurisdictionRO object. The jurisdiction, an area subject to its own distinct tax regulations, such as a municipality, city, county or country. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country. Note: Beta version - This class can still be subject of change!
  {
  "value":
  string
  The jurisdiction. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  "id":
  string
  The ID identifiying the jurisdiction. This ID can be taxation service dependent, e.g. Vertex, AvaTax | Example: 35763
  }
  "imposition":
  object
  A ImpositionRO object. The kind of tax imposed/levied on the subjects of a state.
  {
  "value":
  string
  The imposed tax. | Example: Sales and Use Tax
  "type":
  string
  The type of the imposed tax. | Example: General Sales and Use Tax
  }
  "nonTaxableAmount":
  object
  A MoneyRO object. The amount, no tax has been calculated for. This is the portion of a specific price or a cost amount that is ignored for tax purposes. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "taxableAmount":
  object
  A MoneyRO object. The amount, the tax has been calculated for. This is the portion of a specific price or a cost amount that is subject to tax. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  ]
}
"invoiceToAddress":
object
Required | A AddressRO object. The invoice-to address of the order. Provides details about an address. Note: Beta version - This class can still be subject of change!
{
- "addressLine1":
  string
  Required | The first address line, that usual contains street and house number. | Example: Sample Street 1a
- "city":
  string
  Required | The name of the local authority district. | Example: Sample City
- "countryCode":
  string
  Required | The ISO 3166 (ALPHA2) country code. | Example: US
- "postalCode":
  string
  Required | The code of letters and digits used as part of a postal address to aid the sorting of mail. Also called (in Britain and certain other countries) postcode US equivalent zip code. | Example: 77093
- "contact":
  object
  Required | A ContactRO object. The contact data. Provides details about a contact person. Note: Beta version - This class can still be subject of change!
  {
  - "firstName":
    string
    Required | The given name (also known as a personal name, first name, forename, or Christian name) of the contact person. | Example: Peter
  - "lastName":
    string
    Required | The surname (also known as a family name, last name, or gentile name) of the contact person. | Example: Sampleman
  - "title":
    string
    The personal title, like Ms., Mr. | Example: Mr.
  - "aristocraticTitle":
    string
    The aristocratic title of the contact person, like Lady, Lord. | Example: Lady
  - "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. | Example: PhD
  - "jobTitle":
    string
    The job title of the contact person. | Example: Procurement Lead
  - "secondName":
    string
    The second given name of the contact person. Allocation depends on the culture area, in European countries this would be regarded as the second name, whereas in United States a person has usually one middle name. | Example: Max
  - "secondLastName":
    string
    The second last name of the contact person. Allocation depends on the culture area, second last (sur-) name is common in Hispanic culture. | Example: Rodriguez
  - "phoneHome":
    string
    The phone number of the house or apartment where the contact person lives. | Example: +49 (3641) 123456
  - "phoneMobile":
    string
    The number of contact person's cell phone. | Example: +49 (165) 5673123
  - "phoneBusiness":
    string
    The number of contact person's company. | Example: +49 (3641) 50-0
  - "phoneBusinessDirect":
    string
    Business phone number extension that allows an outside caller to connect directly to the contact person without any help of an attendant or operator. | Example: 3479
  - "fax":
    string
    The number of contact persons for facsimile machine. | Example: +49 (3641) 50-1344
  - "email":
    string
    Contact person's e-mail account. | Example: peter.sampleman@intershop.de
  }
- "addressType":
  string
  The address type describes the nature and intended use of the given address. | Example: POSTAL | Possible Values: POSTALDIGITALSTORE
- "companyName1":
  string
  First part of addressee's company name. | Example: OilCorp Ltd.
- "companyName2":
  string
  Second part of addressee's company name. | Example: OilCorp Corporate Headquarters
- "addressLine2":
  string
  The second address line. This line is optional if room is needed to include more identifying information than a simple street and house number. | Example: Northern University
- "addressLine3":
  string
  The third address line. This line is optional if room is needed to include additional information. | Example: Floor 3
- "postBox":
  string
  The number of a post office box (commonly referred to as a PO box or a postal box). | Example: 143
- "mainDivision":
  string
  The main division of the country, e.g., state or province. | Example: Texas
- "subDivision":
  string
  The sub division of the main division, e.g., county or prefecture. | Example: Harris County
- "additionalAttributes":
  array
  An array of AttributeROObject objects. Additional attributes specified for the address.
  [
  AttributeROObject: Base type for an attribute (key-value pair). Note: Beta version - This class can still be subject of change!
  {
  "name":
  string
  The attribute's name | Example: someAttribute
  "value":
  object
  The attribute's value. | Example: true
  "type":
  string
  The attribute's type. | Example: BOOLEAN | Possible Values: BOOLEANDATEDECIMALDOUBLEINTEGERLONGMONEYQUANTITYSTRINGTEXT
  }
  ]
}
"buckets":
array
Required | An array of BucketRO objects. The shipping buckets of the order.
[
BucketRO: Describes a shipping bucket. Note: Beta version - This class can still be subject of change!
{
- "shipToAddress":
  object
  Required | A AddressRO object. The ship-to address of the bucket. Provides details about an address. Note: Beta version - This class can still be subject of change!
  {
  "addressLine1":
  string
  Required | The first address line, that usual contains street and house number. | Example: Sample Street 1a
  "city":
  string
  Required | The name of the local authority district. | Example: Sample City
  "countryCode":
  string
  Required | The ISO 3166 (ALPHA2) country code. | Example: US
  "postalCode":
  string
  Required | The code of letters and digits used as part of a postal address to aid the sorting of mail. Also called (in Britain and certain other countries) postcode US equivalent zip code. | Example: 77093
  "contact":
  object
  Required | A ContactRO object. The contact data. Provides details about a contact person. Note: Beta version - This class can still be subject of change!
  {
  "firstName":
  string
  Required | The given name (also known as a personal name, first name, forename, or Christian name) of the contact person. | Example: Peter
  "lastName":
  string
  Required | The surname (also known as a family name, last name, or gentile name) of the contact person. | Example: Sampleman
  "title":
  string
  The personal title, like Ms., Mr. | Example: Mr.
  "aristocraticTitle":
  string
  The aristocratic title of the contact person, like Lady, Lord. | Example: Lady
  "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. | Example: PhD
  "jobTitle":
  string
  The job title of the contact person. | Example: Procurement Lead
  "secondName":
  string
  The second given name of the contact person. Allocation depends on the culture area, in European countries this would be regarded as the second name, whereas in United States a person has usually one middle name. | Example: Max
  "secondLastName":
  string
  The second last name of the contact person. Allocation depends on the culture area, second last (sur-) name is common in Hispanic culture. | Example: Rodriguez
  "phoneHome":
  string
  The phone number of the house or apartment where the contact person lives. | Example: +49 (3641) 123456
  "phoneMobile":
  string
  The number of contact person's cell phone. | Example: +49 (165) 5673123
  "phoneBusiness":
  string
  The number of contact person's company. | Example: +49 (3641) 50-0
  "phoneBusinessDirect":
  string
  Business phone number extension that allows an outside caller to connect directly to the contact person without any help of an attendant or operator. | Example: 3479
  "fax":
  string
  The number of contact persons for facsimile machine. | Example: +49 (3641) 50-1344
  "email":
  string
  Contact person's e-mail account. | Example: peter.sampleman@intershop.de
  }
  "addressType":
  string
  The address type describes the nature and intended use of the given address. | Example: POSTAL | Possible Values: POSTALDIGITALSTORE
  "companyName1":
  string
  First part of addressee's company name. | Example: OilCorp Ltd.
  "companyName2":
  string
  Second part of addressee's company name. | Example: OilCorp Corporate Headquarters
  "addressLine2":
  string
  The second address line. This line is optional if room is needed to include more identifying information than a simple street and house number. | Example: Northern University
  "addressLine3":
  string
  The third address line. This line is optional if room is needed to include additional information. | Example: Floor 3
  "postBox":
  string
  The number of a post office box (commonly referred to as a PO box or a postal box). | Example: 143
  "mainDivision":
  string
  The main division of the country, e.g., state or province. | Example: Texas
  "subDivision":
  string
  The sub division of the main division, e.g., county or prefecture. | Example: Harris County
  "additionalAttributes":
  array
  An array of AttributeROObject objects. Additional attributes specified for the address.
  [
  AttributeROObject: Base type for an attribute (key-value pair). Note: Beta version - This class can still be subject of change!
  {
  "name":
  string
  The attribute's name | Example: someAttribute
  "value":
  object
  The attribute's value. | Example: true
  "type":
  string
  The attribute's type. | Example: BOOLEAN | Possible Values: BOOLEANDATEDECIMALDOUBLEINTEGERLONGMONEYQUANTITYSTRINGTEXT
  }
  ]
  }
- "shippingMethod":
  object
  Required | A ShippingMethodRO object. The shipping method of the bucket. Describes a shipping method. Note: Beta version - This class can still be subject of change!
  {
  "id":
  string
  Required | The id of the shipping method. | Example: STD_GROUND
  "name":
  string
  The localized name of the shipping method. | Example: STANDARD GROUND
  "additionalAttributes":
  array
  An array of AttributeROObject objects. Additional attributes specified for this shipping method.
  [
  AttributeROObject: Base type for an attribute (key-value pair). Note: Beta version - This class can still be subject of change!
  {
  "name":
  string
  The attribute's name | Example: someAttribute
  "value":
  object
  The attribute's value. | Example: true
  "type":
  string
  The attribute's type. | Example: BOOLEAN | Possible Values: BOOLEANDATEDECIMALDOUBLEINTEGERLONGMONEYQUANTITYSTRINGTEXT
  }
  ]
  }
- "items":
  array
  Required | An array of ItemRO objects. The items of the bucket.
  [
  ItemRO: Describes an item contained in a bucket. Note: Beta version - This class can still be subject of change!
  {
  "lineItem":
  object
  A LineItemRO object. Details about the line item, like line item position, quantity, etc. Describes a line item of an order. Note: Beta version - This class can still be subject of change!
  {
  "position":
  integer
  The position of the item in the order. | Format: int32
  "quantity":
  object
  A QuantityRO object. The quantity of the Item. Quantity combines a quantity value and the unit of measurement the value is defined in. Note: Beta version - This class can still be subject of change!
  {
  "unit":
  string
  Required | The unit of measurement. | Example: pcs.
  "value":
  number
  Required | The quantity value. | Example: 3
  }
  "desiredDeliveryDate":
  string
  The desired delivery date for the Item. | Example: 2018-12-20
  }
  "itemProduct":
  object
  A ItemProductRO object. The Product assigned to the Item. Describes a product representing the line item. Note: Beta version - This class can still be subject of change!
  {
  "id":
  string
  The ID identifying product uniquely throughout entire communication. | Example: 5079747@inSPIRED-inTRONICS
  "sku":
  string
  The stock keeping unit (SKU) of the product. | Example: 5079747
  "name":
  string
  The product's name. | Example: InTRONICS IS-25Y Portable
  "additionalAttributes":
  array
  An array of AttributeROObject objects. Additional attributes specified for the Product.
  [
  AttributeROObject: Base type for an attribute (key-value pair). Note: Beta version - This class can still be subject of change!
  {
  "name":
  string
  The attribute's name | Example: someAttribute
  "value":
  object
  The attribute's value. | Example: true
  "type":
  string
  The attribute's type. | Example: BOOLEAN | Possible Values: BOOLEANDATEDECIMALDOUBLEINTEGERLONGMONEYQUANTITYSTRINGTEXT
  }
  ]
  "isGiftCard":
  boolean
  True if Item represents a gift card, false otherwise. | Example: true | Possible Values: 1
  "isDigital":
  boolean
  True if Item represents a digital good, false otherwise. | Example: false | Possible Values: 1
  }
  "itemPricing":
  object
  A ItemPricingRO object. Details about the Item pricing. Describes sales and shipping pricing details for the Item. Note: Beta version - This class can still be subject of change!
  {
  "salesPricing":
  object
  A SalesPricingRO object. Details about the sales pricing of the Item. Describes sales pricing details for Item, GiftMessage, GiftWrap, Warranty. Note: Beta version - This class can still be subject of change!
  {
  "singleBasePrice":
  object
  Required | A PriceRO object. The price of a single unit with all item value discounts. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  "undiscountedSingleBasePrice":
  object
  Required | A PriceRO object. The price of a single unit without any item value discounts. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  "price":
  object
  Required | A PriceRO object. The price with all item value discounts. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  "undiscountedPrice":
  object
  Required | A PriceRO object. The price of the line item without any discounts. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  "singleBasePriceRemainder":
  object
  Required | A PriceRO object. The remainder resulting from splitting order discounts to item's single base prices. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  "itemValueDiscountsTotal":
  object
  A PriceRO object. The total of all value discounts of the item. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  "itemValueDiscounts":
  array
  An array of DiscountRO objects. All discounts granted on the sales price.
  [
  DiscountRO: Describes a discount arising from an applied promotion. Note: Beta version - This class can still be subject of change!
  {
  "id":
  string
  The ID of the promotion that triggered the discount. | Example: 92YKAM6dZtIAAAFb_KwtfPFU
  "promotionType":
  string
  The promotion action type. | Example: Order Value Off
  "description":
  string
  The localized promotion description. | Example: 20 USD Order discount
  "code":
  string
  The used promotion code. | Example: Intershop
  "amount":
  object
  A PriceRO object. The amount of the applied rebate granted to the parent object. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  }
  ]
  "taxes":
  array
  An array of TaxItemRO objects. All taxes applied to the net price.
  [
  TaxItemRO: Describes a single tax item. Note: Beta version - This class can still be subject of change!
  {
  "calculatedTax":
  object
  A MoneyRO object. The calculated tax amount. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  The effective rate used to calculate the tax.
  "taxId":
  string
  The ISH internal or user defined ID of the tax that can be used for retrieval of localized taxName. | Example: tax.germany.vat.full
  "taxName":
  string
  The ISH internal or user defined localized tax name. | Example: Germany Full VAT (19%)
  "situs":
  string
  The situs/place of taxation. | Example: DESTINATION | Possible Values: NULLADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "jurisdiction":
  object
  A JurisdictionRO object. The jurisdiction, an area subject to its own distinct tax regulations, such as a municipality, city, county or country. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country. Note: Beta version - This class can still be subject of change!
  {
  "value":
  string
  The jurisdiction. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  "id":
  string
  The ID identifiying the jurisdiction. This ID can be taxation service dependent, e.g. Vertex, AvaTax | Example: 35763
  }
  "imposition":
  object
  A ImpositionRO object. The kind of tax imposed/levied on the subjects of a state.
  {
  "value":
  string
  The imposed tax. | Example: Sales and Use Tax
  "type":
  string
  The type of the imposed tax. | Example: General Sales and Use Tax
  }
  "nonTaxableAmount":
  object
  A MoneyRO object. The amount, no tax has been calculated for. This is the portion of a specific price or a cost amount that is ignored for tax purposes. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "taxableAmount":
  object
  A MoneyRO object. The amount, the tax has been calculated for. This is the portion of a specific price or a cost amount that is subject to tax. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  ]
  }
  "shippingPricing":
  object
  A ShippingPricingRO object. Details about the shipping and handling costs for the Item. Describes shipping pricing details for an Item. Note: Beta version - This class can still be subject of change!
  {
  "undiscountedShippingTotal":
  object
  A PriceRO object. The total for shipping and handling of the Item. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  "itemShippingDiscounts":
  array
  An array of DiscountRO objects. All discounts granted on shipping and handling costs.
  [
  DiscountRO: Describes a discount arising from an applied promotion. Note: Beta version - This class can still be subject of change!
  {
  "id":
  string
  The ID of the promotion that triggered the discount. | Example: 92YKAM6dZtIAAAFb_KwtfPFU
  "promotionType":
  string
  The promotion action type. | Example: Order Value Off
  "description":
  string
  The localized promotion description. | Example: 20 USD Order discount
  "code":
  string
  The used promotion code. | Example: Intershop
  "amount":
  object
  A PriceRO object. The amount of the applied rebate granted to the parent object. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  }
  ]
  "itemShippingDiscountsTotal":
  object
  A PriceRO object. The total of all shipping discounts of the item. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  "taxes":
  array
  An array of TaxItemRO objects. All taxes applied to the shipping and handling costs.
  [
  TaxItemRO: Describes a single tax item. Note: Beta version - This class can still be subject of change!
  {
  "calculatedTax":
  object
  A MoneyRO object. The calculated tax amount. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  The effective rate used to calculate the tax.
  "taxId":
  string
  The ISH internal or user defined ID of the tax that can be used for retrieval of localized taxName. | Example: tax.germany.vat.full
  "taxName":
  string
  The ISH internal or user defined localized tax name. | Example: Germany Full VAT (19%)
  "situs":
  string
  The situs/place of taxation. | Example: DESTINATION | Possible Values: NULLADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "jurisdiction":
  object
  A JurisdictionRO object. The jurisdiction, an area subject to its own distinct tax regulations, such as a municipality, city, county or country. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country. Note: Beta version - This class can still be subject of change!
  {
  "value":
  string
  The jurisdiction. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  "id":
  string
  The ID identifiying the jurisdiction. This ID can be taxation service dependent, e.g. Vertex, AvaTax | Example: 35763
  }
  "imposition":
  object
  A ImpositionRO object. The kind of tax imposed/levied on the subjects of a state.
  {
  "value":
  string
  The imposed tax. | Example: Sales and Use Tax
  "type":
  string
  The type of the imposed tax. | Example: General Sales and Use Tax
  }
  "nonTaxableAmount":
  object
  A MoneyRO object. The amount, no tax has been calculated for. This is the portion of a specific price or a cost amount that is ignored for tax purposes. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "taxableAmount":
  object
  A MoneyRO object. The amount, the tax has been calculated for. This is the portion of a specific price or a cost amount that is subject to tax. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  ]
  }
  "surcharges":
  object
  A SurchargesRO object. Details about additional surcharges applied to the Item. Details about additional surcharges arising from shipping, handling and import fees. Note: Beta version - This class can still be subject of change!
  {
  "itemSurcharges":
  array
  An array of SurchargeRO objects. All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item'.
  [
  SurchargeRO: Describes a single surcharge. Note: Beta version - This class can still be subject of change!
  {
  "amount":
  object
  Required | A PriceRO object. The surcharge's amount. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  "name":
  string
  Required | The surcharge's localized name. | Example: Fridge Box
  "description":
  string
  The surcharge's localized description. | Example: Needs a fridge box for shipping.
  "taxes":
  array
  An array of TaxItemRO objects. The taxes applied to the surcharge.
  [
  TaxItemRO: Describes a single tax item. Note: Beta version - This class can still be subject of change!
  {
  "calculatedTax":
  object
  A MoneyRO object. The calculated tax amount. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  The effective rate used to calculate the tax.
  "taxId":
  string
  The ISH internal or user defined ID of the tax that can be used for retrieval of localized taxName. | Example: tax.germany.vat.full
  "taxName":
  string
  The ISH internal or user defined localized tax name. | Example: Germany Full VAT (19%)
  "situs":
  string
  The situs/place of taxation. | Example: DESTINATION | Possible Values: NULLADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "jurisdiction":
  object
  A JurisdictionRO object. The jurisdiction, an area subject to its own distinct tax regulations, such as a municipality, city, county or country. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country. Note: Beta version - This class can still be subject of change!
  {
  "value":
  string
  The jurisdiction. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  "id":
  string
  The ID identifiying the jurisdiction. This ID can be taxation service dependent, e.g. Vertex, AvaTax | Example: 35763
  }
  "imposition":
  object
  A ImpositionRO object. The kind of tax imposed/levied on the subjects of a state.
  {
  "value":
  string
  The imposed tax. | Example: Sales and Use Tax
  "type":
  string
  The type of the imposed tax. | Example: General Sales and Use Tax
  }
  "nonTaxableAmount":
  object
  A MoneyRO object. The amount, no tax has been calculated for. This is the portion of a specific price or a cost amount that is ignored for tax purposes. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "taxableAmount":
  object
  A MoneyRO object. The amount, the tax has been calculated for. This is the portion of a specific price or a cost amount that is subject to tax. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  ]
  }
  ]
  "itemImportSurcharges":
  array
  An array of SurchargeRO objects. All item based extra charges arising from surcharges directly specified on product or by shipping rules with action type 'item - import'.
  [
  SurchargeRO: Describes a single surcharge. Note: Beta version - This class can still be subject of change!
  {
  "amount":
  object
  Required | A PriceRO object. The surcharge's amount. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  "name":
  string
  Required | The surcharge's localized name. | Example: Fridge Box
  "description":
  string
  The surcharge's localized description. | Example: Needs a fridge box for shipping.
  "taxes":
  array
  An array of TaxItemRO objects. The taxes applied to the surcharge.
  [
  TaxItemRO: Describes a single tax item. Note: Beta version - This class can still be subject of change!
  {
  "calculatedTax":
  object
  A MoneyRO object. The calculated tax amount. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "effectiveTaxRate":
  number
  The effective rate used to calculate the tax.
  "taxId":
  string
  The ISH internal or user defined ID of the tax that can be used for retrieval of localized taxName. | Example: tax.germany.vat.full
  "taxName":
  string
  The ISH internal or user defined localized tax name. | Example: Germany Full VAT (19%)
  "situs":
  string
  The situs/place of taxation. | Example: DESTINATION | Possible Values: NULLADMINISTRATIVE_DESTINATIONADMINISTRATIVE_ORIGINDESTINATIONORIGIN
  "jurisdiction":
  object
  A JurisdictionRO object. The jurisdiction, an area subject to its own distinct tax regulations, such as a municipality, city, county or country. Describes the jurisdiction, an area subject to its own distinct tax regulations,such as a municipality, city, county, or country. Note: Beta version - This class can still be subject of change!
  {
  "value":
  string
  The jurisdiction. | Example: CANADA
  "level":
  string
  The level of the jurisdiction for which the tax is applied. | Example: COUNTRY | Possible Values: APOBOROUGHCITYCOUNTRYCOUNTYDISTRICTFPOLOCAL_IMPROVEMENT_DISTRICTPARISHPROVINCESPECIAL_PURPOSE_DISTRICTSTATETERRITORYTOWNSHIPTRADE_BLOCKTRANSIT_DISTRICT
  "id":
  string
  The ID identifiying the jurisdiction. This ID can be taxation service dependent, e.g. Vertex, AvaTax | Example: 35763
  }
  "imposition":
  object
  A ImpositionRO object. The kind of tax imposed/levied on the subjects of a state.
  {
  "value":
  string
  The imposed tax. | Example: Sales and Use Tax
  "type":
  string
  The type of the imposed tax. | Example: General Sales and Use Tax
  }
  "nonTaxableAmount":
  object
  A MoneyRO object. The amount, no tax has been calculated for. This is the portion of a specific price or a cost amount that is ignored for tax purposes. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "taxableAmount":
  object
  A MoneyRO object. The amount, the tax has been calculated for. This is the portion of a specific price or a cost amount that is subject to tax. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  ]
  }
  ]
  "itemSurchargesTotal":
  object
  A PriceRO object. The total of all item based extra charges arising from surcharges directly specified on product or by shipping rules with action types 'item' and 'item - import'. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
  "distributedBucketSurcharges":
  array
  An array of SurchargeRO objects. The percentage shares of all surcharges specified for the bucket this line item is contained in. These shares are arising from surcharges created by shipping rules with action type 'bucket'.
  [
  SurchargeRO: Describes a single surcharge. Note: Beta version - This class can still be subject of change!
  {
  "amount":
  object
  Required | A PriceRO object. The surcharge's amount. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  }
  "name":
  string
  Required | The surcharge's localized name. | Example: Fridge Box
  "description":
  string
  The surcharge's localized description. | Example: Needs a fridge box for shipping.
  "taxes":
  array
  An array of TaxItemRO objects. The taxes applied to the surcharge.
  }
  ]
  "distributedBucketSurchargesTotal":
  object
  A PriceRO object. The total of the percentage shares of all surcharges levied on the bucket this line item is contained in. These shares are arising from surcharges created by shipping rules with action type 'bucket'. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  "surchargesTotal":
  object
  A PriceRO object. The net total of all surcharges levied on this line item, containing surcharge types 'item', 'item -import' and 'bucket'. Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  }
  }
  "itemGiftWrap":
  object
  A GiftWrapRO object. Details about the gift wrapping for line item's products. Describes a gift wrap assigned to the line item. Note: Beta version - This class can still be subject of change!
  "itemGiftMessage":
  object
  A GiftMessageRO object. Details about the gift message that has been added to the line item. Describes a gift messages assigned to the line item. Note: Beta version - This class can still be subject of change!
  "itemWarranty":
  object
  A WarrantyRO object. Details about warranties assigned to the Item. Describes a warranty assigned to the line item. Note: Beta version - This class can still be subject of change!
  "additionalAttributes":
  array
  An array of AttributeROObject objects. Additional attributes specified for the item.
  }
  ]
- "bucketTotals":
  object
  Required | A BucketTotalsRO object. The totals of the bucket. Describes the bucket totals. Note: Beta version - This class can still be subject of change!
- "shippingInstructions":
  string
  The shipping instructions for this shipping bucket. | Example: Handle with care!
- "bucketDiscounts":
  array
  An array of DiscountRO objects. The bucket discounts for this shipping bucket.
}
]
"payments":
array
Required | An array of PaymentRO objects. The payments used to pay the order.
"customer":
object
A CustomerRO object. The customer who placed the order. Note that customer is not specified in case of unregistered checkout! Provides details about a customer. Note: Beta version - This class can still be subject of change!
"orderDiscounts":
object
A OrderDiscountsRO object. The discounts applied to the order totals. Provides details about the applied discounts on order level. Note: Beta version - This class can still be subject of change!
"additionalAttributes":
array
An array of AttributeROObject objects. Additional attributes specified for the order.

}

OrderSummaryListRO application/json

{

"orderSummaries":
array
An array of OrderSummaryRO objects. The list of order summaries
[
OrderSummaryRO: Note: Beta version - This class can still be subject of change!
{
- "orderUrn":
  string
  Required | URN representation of the order in an Intershop system. | Example: urn:order:ICM:inSPIRED:inTRONICS:00000002
- "externalOrderUrn":
  string
  Required | URN representation of the order in a backend system. | Example: urn:order:MSDynamics365:MyCorp:0023975
- "creationDate":
  string
  Required | date the order has been placed | Example: 2001-07-04T12:08:56.235-07:00
- "status":
  string
  Required | The processing status of the order. Depends on the status values defined by the backend system.
- "grandTotal":
  object
  Required | A PriceRO object. The grand total order value (i. e. what the buyer has to pay) Describes a price. A price has a monetary net, gross and tax value. Note: Beta version - This class can still be subject of change!
  {
  "net":
  object
  Required | A MoneyRO object. The net value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "gross":
  object
  Required | A MoneyRO object. The gross value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  "tax":
  object
  A MoneyRO object. The tax value. Money combines a currency and a money amount. Note: Beta version - This class can still be subject of change!
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
  "value":
  number
  Required | The monetary value. | Example: 10.99
  }
  }
- "orderDetailUri":
  string
  Required | The uri for order details.
- "destinations":
  array
  Required | An array of AddressRO objects. The shipping addresses of the order.
  [
  AddressRO: Provides details about an address. Note: Beta version - This class can still be subject of change!
  {
  "addressLine1":
  string
  Required | The first address line, that usual contains street and house number. | Example: Sample Street 1a
  "city":
  string
  Required | The name of the local authority district. | Example: Sample City
  "countryCode":
  string
  Required | The ISO 3166 (ALPHA2) country code. | Example: US
  "postalCode":
  string
  Required | The code of letters and digits used as part of a postal address to aid the sorting of mail. Also called (in Britain and certain other countries) postcode US equivalent zip code. | Example: 77093
  "contact":
  object
  Required | A ContactRO object. The contact data. Provides details about a contact person. Note: Beta version - This class can still be subject of change!
  {
  "firstName":
  string
  Required | The given name (also known as a personal name, first name, forename, or Christian name) of the contact person. | Example: Peter
  "lastName":
  string
  Required | The surname (also known as a family name, last name, or gentile name) of the contact person. | Example: Sampleman
  "title":
  string
  The personal title, like Ms., Mr. | Example: Mr.
  "aristocraticTitle":
  string
  The aristocratic title of the contact person, like Lady, Lord. | Example: Lady
  "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. | Example: PhD
  "jobTitle":
  string
  The job title of the contact person. | Example: Procurement Lead
  "secondName":
  string
  The second given name of the contact person. Allocation depends on the culture area, in European countries this would be regarded as the second name, whereas in United States a person has usually one middle name. | Example: Max
  "secondLastName":
  string
  The second last name of the contact person. Allocation depends on the culture area, second last (sur-) name is common in Hispanic culture. | Example: Rodriguez
  "phoneHome":
  string
  The phone number of the house or apartment where the contact person lives. | Example: +49 (3641) 123456
  "phoneMobile":
  string
  The number of contact person's cell phone. | Example: +49 (165) 5673123
  "phoneBusiness":
  string
  The number of contact person's company. | Example: +49 (3641) 50-0
  "phoneBusinessDirect":
  string
  Business phone number extension that allows an outside caller to connect directly to the contact person without any help of an attendant or operator. | Example: 3479
  "fax":
  string
  The number of contact persons for facsimile machine. | Example: +49 (3641) 50-1344
  "email":
  string
  Contact person's e-mail account. | Example: peter.sampleman@intershop.de
  }
  "addressType":
  string
  The address type describes the nature and intended use of the given address. | Example: POSTAL | Possible Values: POSTALDIGITALSTORE
  "companyName1":
  string
  First part of addressee's company name. | Example: OilCorp Ltd.
  "companyName2":
  string
  Second part of addressee's company name. | Example: OilCorp Corporate Headquarters
  "addressLine2":
  string
  The second address line. This line is optional if room is needed to include more identifying information than a simple street and house number. | Example: Northern University
  "addressLine3":
  string
  The third address line. This line is optional if room is needed to include additional information. | Example: Floor 3
  "postBox":
  string
  The number of a post office box (commonly referred to as a PO box or a postal box). | Example: 143
  "mainDivision":
  string
  The main division of the country, e.g., state or province. | Example: Texas
  "subDivision":
  string
  The sub division of the main division, e.g., county or prefecture. | Example: Harris County
  "additionalAttributes":
  array
  An array of AttributeROObject objects. Additional attributes specified for the address.
  [
  AttributeROObject: Base type for an attribute (key-value pair). Note: Beta version - This class can still be subject of change!
  {
  "name":
  string
  The attribute's name | Example: someAttribute
  "value":
  object
  The attribute's value. | Example: true
  "type":
  string
  The attribute's type. | Example: BOOLEAN | Possible Values: BOOLEANDATEDECIMALDOUBLEINTEGERLONGMONEYQUANTITYSTRINGTEXT
  }
  ]
  }
  ]
- "itemCount":
  integer
  Required | The items number of the order. | Format: int32
- "customerReferenceId":
  string
  Any custom reference ID of the order that can be specified by the buyer during the checkout process. An example would be a reference number existing in one of buyer's backend systems. | Example: RE201700002786598
- "buyer":
  object
  A BuyerRO object. The corresponding buyer of the order. Describes a business partner holding the role BUYER. Note: Beta version - This class can still be subject of change!
  {
  "contact":
  object
  Required | A ContactRO object. The contact data. Provides details about a contact person. Note: Beta version - This class can still be subject of change!
  {
  "firstName":
  string
  Required | The given name (also known as a personal name, first name, forename, or Christian name) of the contact person. | Example: Peter
  "lastName":
  string
  Required | The surname (also known as a family name, last name, or gentile name) of the contact person. | Example: Sampleman
  "title":
  string
  The personal title, like Ms., Mr. | Example: Mr.
  "aristocraticTitle":
  string
  The aristocratic title of the contact person, like Lady, Lord. | Example: Lady
  "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. | Example: PhD
  "jobTitle":
  string
  The job title of the contact person. | Example: Procurement Lead
  "secondName":
  string
  The second given name of the contact person. Allocation depends on the culture area, in European countries this would be regarded as the second name, whereas in United States a person has usually one middle name. | Example: Max
  "secondLastName":
  string
  The second last name of the contact person. Allocation depends on the culture area, second last (sur-) name is common in Hispanic culture. | Example: Rodriguez
  "phoneHome":
  string
  The phone number of the house or apartment where the contact person lives. | Example: +49 (3641) 123456
  "phoneMobile":
  string
  The number of contact person's cell phone. | Example: +49 (165) 5673123
  "phoneBusiness":
  string
  The number of contact person's company. | Example: +49 (3641) 50-0
  "phoneBusinessDirect":
  string
  Business phone number extension that allows an outside caller to connect directly to the contact person without any help of an attendant or operator. | Example: 3479
  "fax":
  string
  The number of contact persons for facsimile machine. | Example: +49 (3641) 50-1344
  "email":
  string
  Contact person's e-mail account. | Example: peter.sampleman@intershop.de
  }
  "role":
  string
  Role of the business partner in the checkout process. | Example: BUYER | Possible Values: BUYER
  "additionalAttributes":
  array
  An array of AttributeROObject objects. Additional attributes specified for this role.
  [
  AttributeROObject: Base type for an attribute (key-value pair). Note: Beta version - This class can still be subject of change!
  {
  "name":
  string
  The attribute's name | Example: someAttribute
  "value":
  object
  The attribute's value. | Example: true
  "type":
  string
  The attribute's type. | Example: BOOLEAN | Possible Values: BOOLEANDATEDECIMALDOUBLEINTEGERLONGMONEYQUANTITYSTRINGTEXT
  }
  ]
  "department":
  string
  The department the buyer is assigned to. | Example: Procurement
  "gender":
  string
  Buyer's gender. | Example: FEMALE | Possible Values: MALEFEMALE
  "dateOfBirth":
  string
  Buyer's date of birth. | Example: 1989-07-11
  "accountId":
  string
  Buyer's account ID. | Example: patricia.miller@test.intershop.de
  "socialSecurityNumber":
  string
  Buyer's social security number.
  }
}
]
"offset":
integer
The offset, means all entries, starting from the first one, will be skipped until the desired one has been found. | Format: int32 | Example: For example offset=100 and limit=20 will retrieve 20 rows starting with the 100th row.
"limit":
integer
Limit the number of entries provided by the response to the specified value. | Format: int32
"totalCount":
integer
The total element count, i. e. the maximum number of records that can be retrieved. | Format: int32
"startDate":
string
The begin of the date range for order creation date. | Example: 2001-07-04T12:08:56.235-07:00
"endDate":
string
The end of the date range for order creation date. | Example: 2001-07-04T12:08:56.235-07:00

}

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.