Document Properties
Kbid
29768F
Last Modified
30-May-2023
Added to KB
22-Jan-2021
Public Access
Everyone
Status
Online
Doc Type
References
Product
ICM 7.10
Reference - Order REST API 0.1.0
Document View


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

References

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

API Specification

Introduction
OpenAPI Version: 3.0.1
Order Version: 0.1.0

This version is deprecated. Please use the newer version which covers all supported operations from this version and also additional functionality.

The Order REST API contains resources that cover aspects of the checkout process and order handling.

A typical checkout process requires a series of REST requests, some of which are based on one another and must therefore
take place in a defined sequence. This cannot be sufficiently represented by the OpenAPI documentation only. Detailed
descriptions of various checkout scenarios can be found in the Business Guide "Basket & Checkout REST API" in the Intershop knowledge base.

Cost Object API
/orders/{orderKey}/costobjects
GET: (Deprecated) Returns the cost objects assigned to the selected order Deprecated.

Description

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

ResourceCollectionRO contains elements of type LinkRO

Java Method

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

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

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

401 - Unauthorized

403 - Forbidden Requires authentication with a user who has been assigned the following permissions:
- View Cost Object (APP_B2B_VIEW_COSTOBJECT)

/orders/{orderKey}/costobjects/{OrderCostObjectAssignmentKey}
GET: (Deprecated) Returns a specific cost object assigned to the selected order Deprecated.

Description

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

Java Method

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

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathOrderCostObjectAssignmentKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

CostObjectAssignmentRO application/json

401 - Unauthorized

403 - Forbidden Requires authentication with a user who has been assigned the following permissions:
- View Cost Object (APP_B2B_VIEW_COSTOBJECT)

404 - Not Found

General API
/orders
GET: Get order history list Deprecated.

Description

Get a list of links to orders of logged-in user
ResourceCollectionRO contains objects of type LinkRO

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.order.OrderListResource.getOrderList(java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String,java.lang.String) throws com.intershop.beehive.foundation.quantity.CurrencyException

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in querypageablestringthe ID of the respective pageable
in queryoffsetinteger int32the pageable offset
in queryamountinteger int32the pageable amount
in queryattrsstring
in queryviewstring

Response

200 - OK

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

400 - Bad Request

401 - Unauthorized

403 - Forbidden

500 - Internal Server Error possible values for header value error-key:
- search.error

POST: Create new order Deprecated.

Description

Creates/submits an order.
When created, this call returns a LinkRO to the created order.
in genreal, failures that occur during error creation will be sent with the failures fieldof the response

Java Method

public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.order.OrderListResource.createOrder(com.intershop.sellside.rest.common.capi.resourceobject.OrderDescriptionRO)

Request Body

OrderDescriptionRO application/json

Request Parameters

--

Response

201 - Created

202 - Accepted returned for example if the order has not been approved yet

404 - Not Found example reasons:
- wrong basketID
- order already created for this basketID

/orders/{orderKey}
GET: Get order details Deprecated.

Description

Get detailed information of the order with given orderID for logged-in user

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.order.OrderRO com.intershop.sellside.rest.common.capi.resource.order.OrderResource.getOrder()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

OrderRO application/json

401 - Unauthorized

403 - Forbidden if ID of current user does not match userID of order

404 - Not Found possible values for header error-key:
- order.tracking.error

PUT: Cancel an order Deprecated.

Description

Cancel an Order.
If successfull, status of returned OrderRO is CANCELED

Java Method

public com.intershop.sellside.rest.common.capi.resourceobject.order.OrderRO com.intershop.sellside.rest.common.capi.resource.order.OrderResource.cancelOrder(com.intershop.sellside.rest.common.capi.resourceobject.order.OrderRO) throws com.intershop.beehive.foundation.quantity.CurrencyException

Request Body

OrderRO application/json

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

OrderRO application/json

400 - Bad Request possible values for header error-key:
- order.wrong_status
- order.cancel.error
- order.cancel.not_possible.error

401 - Unauthorized

403 - Forbidden

404 - Not Found

409 - Conflict possible values for header error-key:
- order.cancel.not_possible.status

Request and Response Object Schemata
CostObjectAssignmentRO application/json{
  • "name":
    string
    The name of an element | Example: 451
  • "type":
    string
    The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Project
}
OrderDescriptionRO application/json{
  • "name":
    string
    The name of an element
  • "type":
    string
    The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: OrderDescription
  • "paymentInformations":
    object
    A OrderPaymentInformationsRO object. The payment information for this order as OrderPaymentInformationsRO
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: OrderPaymentInformations
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "id":
      string
    • "parameters":
      array
      An array of GenericPropertyROObject objects.
      [
      GenericPropertyROObject
      {
      • "name":
        string
        The name of an element
      • "type":
        string
        Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
      • "key":
        string
      • "property":
        object
      • "displayName":
        string
      }
      ]
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "basketID":
    string
    the id of the corresponding basket | Example: u.0KDgAjIYsAAAFjIQxW6PNc
  • "acceptTermsAndConditions":
    boolean
    did the customer accept the terms and conditions
}
OrderRO application/json{
  • "name":
    string
    The name of an element
  • "type":
    string
    The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Order
  • "documentNo":
    string
    the document number of the order | Example: 00000051
  • "creationDate":
    string
    the creation date of the order | Format: date-time
  • "status":
    string
    the status of the order | Example: NEW
  • "department":
    string
    the deparment this order belongs to | Example: Sales
  • "purchaseCurrency":
    string
    the currencymnemonic of the order | Example: USD
  • "taxationID":
    string
    the taxation ID of the order | Example: 99999999999
  • "customer":
    string
    Readonly | The order owner customer number.
  • "user":
    string
    Readonly | The order owner user login.
  • "taxExempt":
    boolean
    indicating if the order is tax exempt | Example: false
  • "subscription":
    object
    A LinkRO object. A Link pointing to a resource
    {
    • "name":
      string
      The name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The URI
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      The ID of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
  • "invoiceToAddress":
    object
    A AddressRO object. This resource holds the details of an address.
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Address
    • "urn":
      string
      the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
    • "id":
      string
      The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
    • "addressName":
      string
      The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
    • "title":
      string
      The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
    • "aristocraticTitle":
      string
      the aristocratic title of the contact person, like Lord or Lady
    • "jobTitle":
      string
      the job title of the contact person | Example: CEO
    • "honorific":
      string
      the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
    • "firstName":
      string
      The (first) given name of the contact person | Example: Patricia
    • "secondName":
      string
      the second given name of the contact person | Example: Luise
    • "lastName":
      string
      The last name of the contact person | Example: Miller
    • "secondLastName":
      string
      the second last name of the contact person
    • "companyName1":
      string
      the company name | Example: PMiller ltd.
    • "companyName2":
      string
      The second company name
    • "addressLine1":
      string
      the first address line | Example: Berliner Str. 20
    • "addressLine2":
      string
      the second address line | Example: 1st Floor
    • "addressLine3":
      string
      The third address line | Example: Second door on the right
    • "postBox":
      string
      the post-office box | Example: PO Box 42
    • "mainDivision":
      string
      the main division of the country, e. g. a state or province | Example: AL
    • "mainDivisionName":
      string
      The localized display name of the main division | Example: Alabama
    • "subDivision":
      string
      The sub division code of the country. | Example: GB-PKN
    • "subDivisionName":
      string
      The localized display name of the sub division | Example: Perth and Kinross
    • "postalCode":
      string
      The postal code | Example: 14482
    • "email":
      string
      the e-mail address of the contact person | Example: pmiller@intershop.de
    • "phoneMobile":
      string
      The number of the contact person's cell phone | Example: 49364112677
    • "phoneHome":
      string
      The phone number of the house or apartment where the contact person lives | Example: 049364112677
    • "phoneBusiness":
      string
      The phone number of the contact person's company | Example: 049364112699
    • "phoneBusinessDirect":
      string
      the business phone number of the contact person that allows an outside caller to connect directly to the contact person without any help of an attendant or operator | Example: 049364112659
    • "country":
      string
      The display name of the country in the current locale | Example: Germany
    • "countryCode":
      string
      The country code | Example: DE
    • "city":
      string
      The name of the city | Example: Potsdam
    • "fax":
      string
      the fax number | Example: 049364112643
    • "usage":
      object
      Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
      {
      • "empty":
        boolean
      }
    }
  • "shippingBuckets":
    array
    An array of OrderShippingBucketRO objects. the shipping buckets in this order
    [
    OrderShippingBucketRO: the shipping buckets in this order
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: OrderShippingBucket
    • "shipToAddress":
      object
      A AddressRO object. This resource holds the details of an address.
      {
      • "name":
        string
        The name of an element
      • "type":
        string
        The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Address
      • "urn":
        string
        the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
      • "id":
        string
        The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
      • "addressName":
        string
        The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
      • "title":
        string
        The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
      • "aristocraticTitle":
        string
        the aristocratic title of the contact person, like Lord or Lady
      • "jobTitle":
        string
        the job title of the contact person | Example: CEO
      • "honorific":
        string
        the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
      • "firstName":
        string
        The (first) given name of the contact person | Example: Patricia
      • "secondName":
        string
        the second given name of the contact person | Example: Luise
      • "lastName":
        string
        The last name of the contact person | Example: Miller
      • "secondLastName":
        string
        the second last name of the contact person
      • "companyName1":
        string
        the company name | Example: PMiller ltd.
      • "companyName2":
        string
        The second company name
      • "addressLine1":
        string
        the first address line | Example: Berliner Str. 20
      • "addressLine2":
        string
        the second address line | Example: 1st Floor
      • "addressLine3":
        string
        The third address line | Example: Second door on the right
      • "postBox":
        string
        the post-office box | Example: PO Box 42
      • "mainDivision":
        string
        the main division of the country, e. g. a state or province | Example: AL
      • "mainDivisionName":
        string
        The localized display name of the main division | Example: Alabama
      • "subDivision":
        string
        The sub division code of the country. | Example: GB-PKN
      • "subDivisionName":
        string
        The localized display name of the sub division | Example: Perth and Kinross
      • "postalCode":
        string
        The postal code | Example: 14482
      • "email":
        string
        the e-mail address of the contact person | Example: pmiller@intershop.de
      • "phoneMobile":
        string
        The number of the contact person's cell phone | Example: 49364112677
      • "phoneHome":
        string
        The phone number of the house or apartment where the contact person lives | Example: 049364112677
      • "phoneBusiness":
        string
        The phone number of the contact person's company | Example: 049364112699
      • "phoneBusinessDirect":
        string
        the business phone number of the contact person that allows an outside caller to connect directly to the contact person without any help of an attendant or operator | Example: 049364112659
      • "country":
        string
        The display name of the country in the current locale | Example: Germany
      • "countryCode":
        string
        The country code | Example: DE
      • "city":
        string
        The name of the city | Example: Potsdam
      • "fax":
        string
        the fax number | Example: 049364112643
      • "usage":
        object
        Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
        {
        • "empty":
          boolean
        }
      }
    • "shippingMethod":
      object
      A OrderShippingMethodRO object. the shipping method for the line item as OrderShippingMethodRO
      {
      • "name":
        string
        The name of an element
      • "type":
        string
        The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: OrderShippingMethod
      • "id":
        string
        The id of the returned element | Example: STD_GROUND
      • "shippingTimeMin":
        integer
        The minimum shipping time in days | Format: int32 | Example: 3
      • "shippingTimeMax":
        integer
        The maximum shipping time in days | Format: int32 | Example: 7
      }
    • "lineItems":
      array
      An array of OrderLineItemRO objects. the line items of this OrderShippingBucket as Collection of LinkROs
      [
      OrderLineItemRO: the line items of this OrderShippingBucket as Collection of LinkROs
      {
      • "name":
        string
        The name of an element
      • "type":
        string
        The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: OrderLineItem
      • "shipToAddress":
        object
        A AddressRO object. This resource holds the details of an address.
        {
        • "name":
          string
          The name of an element
        • "type":
          string
          The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Address
        • "urn":
          string
          the URN representation of this address | Example: urn:address:customer:1234567890:0987654321
        • "id":
          string
          The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
        • "addressName":
          string
          The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
        • "title":
          string
          The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
        • "aristocraticTitle":
          string
          the aristocratic title of the contact person, like Lord or Lady
        • "jobTitle":
          string
          the job title of the contact person | Example: CEO
        • "honorific":
          string
          the honorific title of the contact person that denotes the honored person's occupation, like Captain, Coach, Officer, Reverend or the academic title, like PhD
        • "firstName":
          string
          The (first) given name of the contact person | Example: Patricia
        • "secondName":
          string
          the second given name of the contact person | Example: Luise
        • "lastName":
          string
          The last name of the contact person | Example: Miller
        • "secondLastName":
          string
          the second last name of the contact person
        • "companyName1":
          string
          the company name | Example: PMiller ltd.
        • "companyName2":
          string
          The second company name
        • "addressLine1":
          string
          the first address line | Example: Berliner Str. 20
        • "addressLine2":
          string
          the second address line | Example: 1st Floor
        • "addressLine3":
          string
          The third address line | Example: Second door on the right
        • "postBox":
          string
          the post-office box | Example: PO Box 42
        • "mainDivision":
          string
          the main division of the country, e. g. a state or province | Example: AL
        • "mainDivisionName":
          string
          The localized display name of the main division | Example: Alabama
        • "subDivision":
          string
          The sub division code of the country. | Example: GB-PKN
        • "subDivisionName":
          string
          The localized display name of the sub division | Example: Perth and Kinross
        • "postalCode":
          string
          The postal code | Example: 14482
        • "email":
          string
          the e-mail address of the contact person | Example: pmiller@intershop.de
        • "phoneMobile":
          string
          The number of the contact person's cell phone | Example: 49364112677
        • "phoneHome":
          string
          The phone number of the house or apartment where the contact person lives | Example: 049364112677
        • "phoneBusiness":
          string
          The phone number of the contact person's company | Example: 049364112699
        • "phoneBusinessDirect":
          string
          the business phone number of the contact person that allows an outside caller to connect directly to the contact person without any help of an attendant or operator | Example: 049364112659
        • "country":
          string
          The display name of the country in the current locale | Example: Germany
        • "countryCode":
          string
          The country code | Example: DE
        • "city":
          string
          The name of the city | Example: Potsdam
        • "fax":
          string
          the fax number | Example: 049364112643
        • "usage":
          object
          Returns usage information for the address. Every bit in the returned set marks a specific usage type, like ship-from or invoice-to address. If a bit is set, the address may be used for the specific purpose mapped to this bit. Further bits may be used for custom types. Default usage for first 4 bits are Invoice-to, Ship-to, Service-to and Install-to
          {
          • "empty":
            boolean
          }
        }
      • "shippingMethod":
        object
        A OrderShippingMethodRO object. the shipping method for the line item as OrderShippingMethodRO
        {
        • "name":
          string
          The name of an element
        • "type":
          string
          The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: OrderShippingMethod
        • "id":
          string
          The id of the returned element | Example: STD_GROUND
        • "shippingTimeMin":
          integer
          The minimum shipping time in days | Format: int32 | Example: 3
        • "shippingTimeMax":
          integer
          The maximum shipping time in days | Format: int32 | Example: 7
        }
      • "quantity":
        object
        A QuantityRO object. Quantity combines a quantity value and the ISO unit code the value is defined in.
        {
        • "type":
          string
          Readonly | This is a constant: Quantity | Example: Quantity
        • "value":
          number
          The quantity's value | Example: 10.99
        • "unit":
          string
          The quantity's ISO unit code. | Example: PIEC
        }
      • "product":
        object
        A LinkRO object. A Link pointing to a resource
        {
        • "name":
          string
          The name of the returned element
        • "type":
          string
          Readonly | This is a constant: Link | Example: Link
        • "attributes":
          array
          An array of ResourceAttribute objects. The list of attributes
          [
          ResourceAttribute: An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
          ]
        • "uri":
          string
          The URI
        • "relation":
          string
          The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
        • "title":
          string
          The title of the link
        • "description":
          string
          The description of the link
        • "itemId":
          string
          The ID of the linked item
        • "attribute":
          object
          A ResourceAttribute object. An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
        }
      • "thumbnail":
        object
        A LinkRO object. A Link pointing to a resource
        {
        • "name":
          string
          The name of the returned element
        • "type":
          string
          Readonly | This is a constant: Link | Example: Link
        • "attributes":
          array
          An array of ResourceAttribute objects. The list of attributes
          [
          ResourceAttribute: An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
          ]
        • "uri":
          string
          The URI
        • "relation":
          string
          The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
        • "title":
          string
          The title of the link
        • "description":
          string
          The description of the link
        • "itemId":
          string
          The ID of the linked item
        • "attribute":
          object
          A ResourceAttribute object. An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
        }
      • "giftMessage":
        object
        A LinkRO object. A Link pointing to a resource
        {
        • "name":
          string
          The name of the returned element
        • "type":
          string
          Readonly | This is a constant: Link | Example: Link
        • "attributes":
          array
          An array of ResourceAttribute objects. The list of attributes
          [
          ResourceAttribute: An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
          ]
        • "uri":
          string
          The URI
        • "relation":
          string
          The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
        • "title":
          string
          The title of the link
        • "description":
          string
          The description of the link
        • "itemId":
          string
          The ID of the linked item
        • "attribute":
          object
          A ResourceAttribute object. An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
        }
      • "warranty":
        object
        A LinkRO object. A Link pointing to a resource
        {
        • "name":
          string
          The name of the returned element
        • "type":
          string
          Readonly | This is a constant: Link | Example: Link
        • "attributes":
          array
          An array of ResourceAttribute objects. The list of attributes
          [
          ResourceAttribute: An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
          ]
        • "uri":
          string
          The URI
        • "relation":
          string
          The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
        • "title":
          string
          The title of the link
        • "description":
          string
          The description of the link
        • "itemId":
          string
          The ID of the linked item
        • "attribute":
          object
          A ResourceAttribute object. An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
        }
      • "id":
        string
        the id of the line item | Example: 2hIKAB17haUAAAFG4.xU7mGD
      • "fulfillmentStatus":
        string
        the fulfillment status of the line item | Example: NEW
      • "position":
        integer
        the position of the line item | Format: int32 | Example: 1
      • "isHiddenGift":
        boolean
        indicates if the line item is a hidden gift | Example: false
      • "isFreeGift":
        boolean
        indicates if the line item is a free gift | Example: false
      • "singleBasePrice":
        object
        A MoneyRO object. Money combines a currency and a money amount.
        {
        • "type":
          string
          Readonly | This is a constant: Money | Example: Money
        • "value":
          number
          The monetary value. | Example: 10.99
        • "currencyMnemonic":
          string
          Deprecated
        • "currency":
          string
          Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        }
      • "price":
        object
        A MoneyRO object. Money combines a currency and a money amount.
        {
        • "type":
          string
          Readonly | This is a constant: Money | Example: Money
        • "value":
          number
          The monetary value. | Example: 10.99
        • "currencyMnemonic":
          string
          Deprecated
        • "currency":
          string
          Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        }
      • "totals":
        object
        A OrderLineItemTotalsRO object. the totals of the line item as LineItemTotals
        {
        • "name":
          string
          The name of an element
        • "type":
          string
          Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
        • "total":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        • "valueRebatesTotal":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        • "shippingTotal":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        • "shippingRebatesTotal":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        • "giftingTotal":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        • "salesTaxTotal":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        • "shippingTaxTotal":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        }
      • "salesTaxes":
        array
        An array of AppliedTaxRO objects. the line item's applied taxes
        [
        AppliedTaxRO: The Shipping Tax Totals by tax rate for this order
        {
        • "name":
          string
          The name of an element
        • "type":
          string
          The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedTax
        • "rate":
          number
          the tax rate, 100 = 100% | Example: 19
        • "amount":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        }
        ]
      • "shippingTaxes":
        array
        An array of AppliedTaxRO objects. the line items shipping taxes
        [
        AppliedTaxRO: The Shipping Tax Totals by tax rate for this order
        {
        • "name":
          string
          The name of an element
        • "type":
          string
          The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedTax
        • "rate":
          number
          the tax rate, 100 = 100% | Example: 19
        • "amount":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        }
        ]
      • "itemSurcharges":
        array
        An array of SurchargeRO objects. the line item's surcharges
        [
        SurchargeRO: This resource describes a single surcharge incurred to a shipping bucket.
        {
        • "name":
          string
          The name of an element
        • "type":
          string
          The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Surcharge
        • "amount":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        • "description":
          string
          the description of the surcharge
        • "displayName":
          string
          the display name of the surcharge
        • "taxes":
          array
          An array of AppliedTaxRO objects. the taxes applied to the surcharge amount as collection of AppliedTaxRO
          [
          AppliedTaxRO: The Shipping Tax Totals by tax rate for this order
          {
          • "name":
            string
            The name of an element
          • "type":
            string
            The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedTax
          • "rate":
            number
            the tax rate, 100 = 100% | Example: 19
          • "amount":
            object
            A MoneyRO object. Money combines a currency and a money amount.
            {
            • "type":
              string
              Readonly | This is a constant: Money | Example: Money
            • "value":
              number
              The monetary value. | Example: 10.99
            • "currencyMnemonic":
              string
              Deprecated
            • "currency":
              string
              Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            }
          }
          ]
        }
        ]
      • "itemImportSurcharges":
        array
        An array of SurchargeRO objects. the line item's import surcharges
        [
        SurchargeRO: This resource describes a single surcharge incurred to a shipping bucket.
        {
        • "name":
          string
          The name of an element
        • "type":
          string
          The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Surcharge
        • "amount":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        • "description":
          string
          the description of the surcharge
        • "displayName":
          string
          the display name of the surcharge
        • "taxes":
          array
          An array of AppliedTaxRO objects. the taxes applied to the surcharge amount as collection of AppliedTaxRO
          [
          AppliedTaxRO: The Shipping Tax Totals by tax rate for this order
          {
          • "name":
            string
            The name of an element
          • "type":
            string
            The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedTax
          • "rate":
            number
            the tax rate, 100 = 100% | Example: 19
          • "amount":
            object
            A MoneyRO object. Money combines a currency and a money amount.
            {
            • "type":
              string
              Readonly | This is a constant: Money | Example: Money
            • "value":
              number
              The monetary value. | Example: 10.99
            • "currencyMnemonic":
              string
              Deprecated
            • "currency":
              string
              Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
            }
          }
          ]
        }
        ]
      • "valueRebates":
        array
        An array of AppliedRebateRO objects. the line item's value rebates
        [
        AppliedRebateRO: the shipping rebates for this order
        {
        • "name":
          string
          The name of an element
        • "type":
          string
          The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedRebate
        • "rebateType":
          string
          the type of the applied rebate | Example: OrderValueOffDiscount
        • "description":
          string
          The description of the applied rebate | Example: For orders over 200 USD, a 10 USD Order discount is guaranteed for the Promo Code 'INTERSHOP'.
        • "code":
          string
          the code of the applied rebate | Example: INTERSHOP
        • "amount":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        }
        ]
      • "shippingRebates":
        array
        An array of AppliedRebateRO objects. the line item's shipping rebates
        [
        AppliedRebateRO: the shipping rebates for this order
        {
        • "name":
          string
          The name of an element
        • "type":
          string
          The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedRebate
        • "rebateType":
          string
          the type of the applied rebate | Example: OrderValueOffDiscount
        • "description":
          string
          The description of the applied rebate | Example: For orders over 200 USD, a 10 USD Order discount is guaranteed for the Promo Code 'INTERSHOP'.
        • "code":
          string
          the code of the applied rebate | Example: INTERSHOP
        • "amount":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        }
        ]
      • "senderName":
        string
        the name of the sender | Example: Patricia Miller
      • "senderEmail":
        string
        the senders email | Example: pmiller@test.intershop.de
      • "recipientName":
        string
        the name of the recipient | Example: Fritz Birdo
      • "recipientEmail":
        string
        the email of the recipient | Example: f.birdo@test.intershop.de
      • "greetingMessage":
        string
        the greeting message | Example: Greetings!
      • "variationProduct":
        boolean
        indicates if the line item is a product variation | Example: false
      • "bundleProduct":
        boolean
        indicates if the line item is part of a bundle | Example: false
      • "availability":
        boolean
        indicates if the line item is available
      • "giftwrap":
        object
        A LinkRO object. A Link pointing to a resource
        {
        • "name":
          string
          The name of the returned element
        • "type":
          string
          Readonly | This is a constant: Link | Example: Link
        • "attributes":
          array
          An array of ResourceAttribute objects. The list of attributes
          [
          ResourceAttribute: An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
          ]
        • "uri":
          string
          The URI
        • "relation":
          string
          The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
        • "title":
          string
          The title of the link
        • "description":
          string
          The description of the link
        • "itemId":
          string
          The ID of the linked item
        • "attribute":
          object
          A ResourceAttribute object. An attribute
          {
          • "name":
            string
            The attribute's name
          • "type":
            string
            This is a constant: ResourceAttribute | Example: ResourceAttribute
          • "value":
            object
            The attribute's value.
          }
        }
      }
      ]
    • "bucketSurcharges":
      array
      An array of SurchargeRO objects. the surcharges of this OrderShippingBucket as SurchargeRO
      [
      SurchargeRO: This resource describes a single surcharge incurred to a shipping bucket.
      {
      • "name":
        string
        The name of an element
      • "type":
        string
        The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Surcharge
      • "amount":
        object
        A MoneyRO object. Money combines a currency and a money amount.
        {
        • "type":
          string
          Readonly | This is a constant: Money | Example: Money
        • "value":
          number
          The monetary value. | Example: 10.99
        • "currencyMnemonic":
          string
          Deprecated
        • "currency":
          string
          Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        }
      • "description":
        string
        the description of the surcharge
      • "displayName":
        string
        the display name of the surcharge
      • "taxes":
        array
        An array of AppliedTaxRO objects. the taxes applied to the surcharge amount as collection of AppliedTaxRO
        [
        AppliedTaxRO: The Shipping Tax Totals by tax rate for this order
        {
        • "name":
          string
          The name of an element
        • "type":
          string
          The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedTax
        • "rate":
          number
          the tax rate, 100 = 100% | Example: 19
        • "amount":
          object
          A MoneyRO object. Money combines a currency and a money amount.
          {
          • "type":
            string
            Readonly | This is a constant: Money | Example: Money
          • "value":
            number
            The monetary value. | Example: 10.99
          • "currencyMnemonic":
            string
            Deprecated
          • "currency":
            string
            Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
          }
        }
        ]
      }
      ]
    • "shippingRebates":
      array
      An array of AppliedRebateRO objects. the shipping rebates of this OrderShippingBucket as AppliedRebateRO
      [
      AppliedRebateRO: the shipping rebates for this order
      {
      • "name":
        string
        The name of an element
      • "type":
        string
        The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedRebate
      • "rebateType":
        string
        the type of the applied rebate | Example: OrderValueOffDiscount
      • "description":
        string
        The description of the applied rebate | Example: For orders over 200 USD, a 10 USD Order discount is guaranteed for the Promo Code 'INTERSHOP'.
      • "code":
        string
        the code of the applied rebate | Example: INTERSHOP
      • "amount":
        object
        A MoneyRO object. Money combines a currency and a money amount.
        {
        • "type":
          string
          Readonly | This is a constant: Money | Example: Money
        • "value":
          number
          The monetary value. | Example: 10.99
        • "currencyMnemonic":
          string
          Deprecated
        • "currency":
          string
          Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        }
      }
      ]
    • "packSlipMessage":
      string
      the pack slip message for this OrderShippingBucket | Example: Your order is here!
    • "shippingInstructions":
      string
      the shipping instrucations of this OrderShippingBucket | Example: Keep away from water
    }
    ]
  • "payments":
    array
    An array of OrderPaymentRO objects. the payments of this order
    [
    OrderPaymentRO: the payments of this order
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: OrderPayment
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "displayName":
      string
      the payment method's display name | Example: Gift Card / Certificate
    • "number":
      string
      the number of the payment method if applicable (e.g. CreditCardNumber) | Example: *******6241
    • "status":
      string
      the status of the payment | Example: Captured
    • "limitedTenderBalance":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "paymentTotalAmount":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "valueRebates":
    array
    An array of AppliedRebateRO objects. the value rebates for this order
    [
    AppliedRebateRO: the shipping rebates for this order
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedRebate
    • "rebateType":
      string
      the type of the applied rebate | Example: OrderValueOffDiscount
    • "description":
      string
      The description of the applied rebate | Example: For orders over 200 USD, a 10 USD Order discount is guaranteed for the Promo Code 'INTERSHOP'.
    • "code":
      string
      the code of the applied rebate | Example: INTERSHOP
    • "amount":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    }
    ]
  • "shippingRebates":
    array
    An array of AppliedRebateRO objects. the shipping rebates for this order
    [
    AppliedRebateRO: the shipping rebates for this order
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedRebate
    • "rebateType":
      string
      the type of the applied rebate | Example: OrderValueOffDiscount
    • "description":
      string
      The description of the applied rebate | Example: For orders over 200 USD, a 10 USD Order discount is guaranteed for the Promo Code 'INTERSHOP'.
    • "code":
      string
      the code of the applied rebate | Example: INTERSHOP
    • "amount":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    }
    ]
  • "itemSurchargeTotalsByType":
    array
    An array of SurchargeRO objects. The Item Surcharge Totals by type for this order
    [
    SurchargeRO: This resource describes a single surcharge incurred to a shipping bucket.
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Surcharge
    • "amount":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "description":
      string
      the description of the surcharge
    • "displayName":
      string
      the display name of the surcharge
    • "taxes":
      array
      An array of AppliedTaxRO objects. the taxes applied to the surcharge amount as collection of AppliedTaxRO
      [
      AppliedTaxRO: The Shipping Tax Totals by tax rate for this order
      {
      • "name":
        string
        The name of an element
      • "type":
        string
        The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedTax
      • "rate":
        number
        the tax rate, 100 = 100% | Example: 19
      • "amount":
        object
        A MoneyRO object. Money combines a currency and a money amount.
        {
        • "type":
          string
          Readonly | This is a constant: Money | Example: Money
        • "value":
          number
          The monetary value. | Example: 10.99
        • "currencyMnemonic":
          string
          Deprecated
        • "currency":
          string
          Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        }
      }
      ]
    }
    ]
  • "bucketSurchargeTotalsByType":
    array
    An array of SurchargeRO objects. The Bucket Surcharge Totals by type for this order
    [
    SurchargeRO: This resource describes a single surcharge incurred to a shipping bucket.
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Surcharge
    • "amount":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "description":
      string
      the description of the surcharge
    • "displayName":
      string
      the display name of the surcharge
    • "taxes":
      array
      An array of AppliedTaxRO objects. the taxes applied to the surcharge amount as collection of AppliedTaxRO
      [
      AppliedTaxRO: The Shipping Tax Totals by tax rate for this order
      {
      • "name":
        string
        The name of an element
      • "type":
        string
        The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedTax
      • "rate":
        number
        the tax rate, 100 = 100% | Example: 19
      • "amount":
        object
        A MoneyRO object. Money combines a currency and a money amount.
        {
        • "type":
          string
          Readonly | This is a constant: Money | Example: Money
        • "value":
          number
          The monetary value. | Example: 10.99
        • "currencyMnemonic":
          string
          Deprecated
        • "currency":
          string
          Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
        }
      }
      ]
    }
    ]
  • "salesTaxTotalsByTaxRate":
    array
    An array of AppliedTaxRO objects. The Sales Tax Totals by tax rate for this order
    [
    AppliedTaxRO: The Shipping Tax Totals by tax rate for this order
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedTax
    • "rate":
      number
      the tax rate, 100 = 100% | Example: 19
    • "amount":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    }
    ]
  • "shippingTaxTotalsByTaxRate":
    array
    An array of AppliedTaxRO objects. The Shipping Tax Totals by tax rate for this order
    [
    AppliedTaxRO: The Shipping Tax Totals by tax rate for this order
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: AppliedTax
    • "rate":
      number
      the tax rate, 100 = 100% | Example: 19
    • "amount":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    }
    ]
  • "affiliatePartnerID":
    string
    the affiliate PartnerID | Example: 4bcKAB2Ykg4AAAFbjvEYRPJ7
  • "affiliateProgramID":
    string
    the affiliate ProgramID | Example: uzMKAB2YvKAAAAFb7DUYRPJ8
  • "externalOrderReferenceID":
    string
    the external order reference id of the order
  • "totals":
    object
    A OrderTotalsRO object. the totals of this order as OrderTotalsRO
    {
    • "name":
      string
      The name of an element
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: OrderTotals
    • "itemTotal":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "itemRebatesTotal":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "shippingTotal":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "itemShippingRebatesTotal":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "bucketShippingRebatesTotal":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "orderValueRebatesTotal":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "orderShippingRebatesTotal":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "taxTotal":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "dutiesAndSurchargesTotal":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "orderTotal":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "paymentCostsTotal":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "orderTotalMinusLimitedTender":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "limitedTenderTotal":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    }
  • "id":
    string
    the id of the order | Example: mXAKAB17RqIAAAFGOuxU7mGD
}
ResourceCollectionROLinkRO application/json{
  • "pageable":
    string
    The pageable ID.
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of LinkRO objects. The list of elements
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      The name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. The list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The URI
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      The ID of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
  • "type":
    string
    This is a constant: ResourceCollection | Example: ResourceCollection
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of the returned element
}
Disclaimer
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.