Related Documents
Document Properties
Kbid2U5169
Last Modified23-Jun-2020
Added to KB20-Sep-2013
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8

REST API - Get order details (valid from 7.4 to 7.7)

URI

/orders/<orderID>

Http Method

GET

Short Description

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

Query Parameters

none

Example Requests

/orders/HrsKDgAbGCoAAAFBVl6D_DUF

HTTP Status Codes

401 Unauthorized
403 Forbidden
       ID of current user does not match user-ID of order.
404 Not Found

       Possible values for header ‘error-key’:

    • order.tracking.error

Description

The request returns a detailed representation of a specific order.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

Product To Version

7.7

Status

final

 

JSON

Request Data Format

Request related java object

n/a

Request Example

n/a

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.OrderResource
com.intershop.sellside.rest.common.capi.resourceobject.OrderRO

Response Example

{
    "name": "order",
    "type": "Order",
    "creationDate": 1401795374340,
    "invoiceToAddress":
    {
        "type": "Address",
        "city": "Potsdam",
        "countryCode": "DE",
        "postalCode": "14482",
        "street": "Berliner Str. 20",
        "phoneHome": "049364112677",
        "firstName": "Patricia",
        "lastName": "Miller",
        "title": "Mrs.",
        "addressName": "Patricia Miller, Berliner Str. 20, Potsdam",
        "id": "BVUKAB17pEYAAAFGRuxU7mGD",
        "country": "Germany"
    },
    "documentNo": "00000051",
    "externalOrderReferenceID": "",
    "payments":
    [
        {
            "name": "BPS_INVOICE",
            "type": "OrderPayment",
            "status": "unprocessed",
            "displayName": "Invoice"
        }
    ],
    "purchaseCurrency": "USD",
    "shippingTaxTotalsByTaxRate":
    [
        {
            "name": "name",
            "type": "AppliedTax",
            "amount":
            {
                "type": "Money",
                "currencyMnemonic": "USD",
                "value": 0.52
            },
            "rate": 19
        }
    ],
    "itemSurchargeTotalsByType":
    [
        {
            "name": "surcharge",
            "type": "Surcharge",
            "description": "Surcharge for battery deposit",
            "amount":
            {
                "type": "Money",
                "currencyMnemonic": "USD",
                "value": 5.95
            },
            "displayName": "Battery Deposit Surcharge"
        }
    ],
    "salesTaxTotalsByTaxRate":
    [
        {
            "name": "name",
            "type": "AppliedTax",
            "amount":
            {
                "type": "Money",
                "currencyMnemonic": "USD",
                "value": 26.6
            },
            "rate": 19
        }
    ],
    "totals":
    {
        "name": "orderTotals",
        "type": "OrderTotals",
        "itemRebatesTotal":
        {
            "type": "Money",
            "currencyMnemonic": "USD",
            "value": 3.57
        },
        "itemTotal":
        {
            "type": "Money",
            "currencyMnemonic": "USD",
            "value": 337.28
        },
        "orderValueRebatesTotal":
        {
            "type": "Money",
            "currencyMnemonic": "USD",
            "value": 174.25
        },
        "orderTotal":
        {
            "type": "Money",
            "currencyMnemonic": "USD",
            "value": 181.74
        },
        "itemShippingRebatesTotal":
        {
            "type": "Money",
            "currencyMnemonic": "USD",
            "value": 0
        },
        "bucketShippingRebatesTotal":
        {
            "type": "Money",
            "currencyMnemonic": "USD",
            "value": 0
        },
        "dutiesAndSurchargesTotal":
        {
            "type": "Money",
            "currencyMnemonic": "USD",
            "value": 0
        },
        "shippingTotal":
        {
            "type": "Money",
            "currencyMnemonic": "USD",
            "value": 3.59
        },
        "paymentCostsTotal":
        {
            "type": "Money",
            "currencyMnemonic": "USD",
            "value": 5.95
        },
        "taxTotal":
        {
            "type": "Money",
            "currencyMnemonic": "USD",
            "value": 29.02
        },
        "orderShippingRebatesTotal":
        {
            "type": "Money",
            "currencyMnemonic": "USD",
            "value": 0.36
        }
    },
    "shippingBuckets":
    [
        {
            "name": "orderShippingBucket",
            "type": "OrderShippingBucket",
            "shippingMethod":
            {
                "name": "Standard Ground",
                "type": "OrderShippingMethod",
                "shippingTimeMax": 7,
                "shippingTimeMin": 3,
                "id": "STD_GROUND"
            },
            "shipToAddress":
            {
                "type": "Address",
                "city": "Potsdam",
                "countryCode": "DE",
                "postalCode": "14482",
                "street": "Berliner Str. 20",
                "phoneHome": "049364112677",
                "firstName": "Patricia",
                "lastName": "Miller",
                "title": "Mrs.",
                "addressName": "Patricia Miller, Berliner Str. 20, Potsdam",
                "id": "BVUKAB17pEYAAAFGRuxU7mGD",
                "country": "Germany"
            },
            "lineItems":
            [
                {
                    "name": "Canon LEGRIA HF R16",
                    "type": "OrderLineItem",
                    "position": 1,
                    "quantity":
                    {
                        "type": "Quantity",
                        "unit": "",
                        "value": 1
                    },
                    "price":
                    {
                        "type": "Money",
                        "currencyMnemonic": "USD",
                        "value": 337.28
                    },
                    "product":
                    {
                        "type": "Link",
                        "description": "Canon LEGRIA HF R16",
                        "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/3953312",
                        "title": "3953312"
                    },
                    "thumbnail":
                    {
                        "type": "Link",
                        "uri": "PrimeTech:/4XS/3953312-9812.jpg",
                        "title": "thumbnail"
                    },
                    "shippingMethod":
                    {
                        "name": "Standard Ground",
                        "type": "OrderShippingMethod",
                        "shippingTimeMax": 7,
                        "shippingTimeMin": 3,
                        "id": "STD_GROUND"
                    },
                    "shipToAddress":
                    {
                        "type": "Address",
                        "city": "Potsdam",
                        "countryCode": "DE",
                        "postalCode": "14482",
                        "street": "Berliner Str. 20",
                        "phoneHome": "049364112677",
                        "firstName": "Patricia",
                        "lastName": "Miller",
                        "title": "Mrs.",
                        "addressName": "Patricia Miller, Berliner Str. 20, Potsdam",
                        "id": "BVUKAB17pEYAAAFGRuxU7mGD",
                        "country": "Germany"
                    },
                    "singleBasePrice":
                    {
                        "type": "Money",
                        "currencyMnemonic": "USD",
                        "value": 340.85
                    },
                    "shippingTaxes":
                    [
                        {
                            "name": "name",
                            "type": "AppliedTax",
                            "amount":
                            {
                                "type": "Money",
                                "currencyMnemonic": "USD",
                                "value": 0.52
                            },
                            "rate": 0.19
                        }
                    ],
                    "salesTaxes":
                    [
                        {
                            "name": "name",
                            "type": "AppliedTax",
                            "amount":
                            {
                                "type": "Money",
                                "currencyMnemonic": "USD",
                                "value": 53.85
                            },
                            "rate": 0.19
                        }
                    ],
                    "availability": true,
                    "totals":
                    {
                        "name": "orderLineItemTotals",
                        "type": "OrderLineItemTotalsRO",
                        "shippingTaxTotal":
                        {
                            "type": "Money",
                            "currencyMnemonic": "USD",
                            "value": 0.52
                        },
                        "salesTaxTotal":
                        {
                            "type": "Money",
                            "currencyMnemonic": "USD",
                            "value": 53.85
                        },
                        "shippingTotal":
                        {
                            "type": "Money",
                            "currencyMnemonic": "USD",
                            "value": 3.59
                        },
                        "total":
                        {
                            "type": "Money",
                            "currencyMnemonic": "USD",
                            "value": 337.28
                        }
                    },
                    "itemSurcharges":
                    [
                        {
                            "name": "surcharge",
                            "type": "Surcharge",
                            "description": "Surcharge for battery deposit",
                            "taxes":
                            [
                                {
                                    "name": "name",
                                    "type": "AppliedTax",
                                    "amount":
                                    {
                                        "type": "Money",
                                        "currencyMnemonic": "USD",
                                        "value": 0.95
                                    },
                                    "rate": 0.19
                                }
                            ],
                            "amount":
                            {
                                "type": "Money",
                                "currencyMnemonic": "USD",
                                "value": 5.95
                            },
                            "displayName": "Battery Deposit Surcharge"
                        }
                    ],
                    "isFreeGift": false,
                    "isHiddenGift": false,
                    "variationProduct": false,
                    "bundleProduct": false,
                    "id": "2hIKAB17haUAAAFG4.xU7mGD"
                }
            ]
        }
    ],
    "valueRebates":
    [
        {
            "name": "appliedRebate",
            "type": "AppliedRebate",
            "description": "",
            "rebateType": "OrderValueOffDiscount",
            "amount":
            {
                "type": "Money",
                "currencyMnemonic": "USD",
                "value": 170.68
            }
        }
    ],
    "shippingRebates":
    [
        {
            "name": "appliedRebate",
            "type": "AppliedRebate",
            "description": "10% Off for Shipping",
            "rebateType": "ShippingPercentageOffDiscount",
            "amount":
            {
                "type": "Money",
                "currencyMnemonic": "USD",
                "value": 0.36
            }
        }
    ],
    "status": "NEW",
    "id": "mXAKAB17RqIAAAFGOuxU7mGD"
}

 


XML

XML Request Data Format

XML Request Java Objects

n/a

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.common.capi.resource.OrderResource
com.intershop.sellside.rest.common.capi.resourceobject.OrderRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Order name="order" type="Order">
  <creationDate>2014-06-03T13:36:14.340+02:00</creationDate>
  <documentNo>00000051</documentNo>
  <externalOrderReferenceID>
  </externalOrderReferenceID>
  <id>mXAKAB17RqIAAAFGOuxU7mGD</id>
  <itemSurchargeTotalsByType>
    <Surcharge name="surcharge" type="Surcharge">
      <amount type="Money">
        <currencyMnemonic>USD</currencyMnemonic>
        <value>5.95</value>
      </amount>
      <description>Surcharge for battery deposit</description>
      <displayName>Battery Deposit Surcharge</displayName>
    </Surcharge>
  </itemSurchargeTotalsByType>
  <payments>
    <OrderPayment name="BPS_INVOICE" type="OrderPayment">
      <displayName>Invoice</displayName>
      <status>unprocessed</status>
    </OrderPayment>
  </payments>
  <purchaseCurrency>USD</purchaseCurrency>
  <salesTaxTotalsByTaxRate>
    <AppliedTax name="name" type="AppliedTax">
      <amount type="Money">
        <currencyMnemonic>USD</currencyMnemonic>
        <value>26.60</value>
      </amount>
      <rate>19.0</rate>
    </AppliedTax>
  </salesTaxTotalsByTaxRate>
  <shippingBuckets>
    <OrderShippingBucket name="orderShippingBucket" type="OrderShippingBucket">
      <lineItems>
        <OrderLineItem name="Canon LEGRIA HF R16" type="OrderLineItem">
          <availability>true</availability>
          <bundleProduct>false</bundleProduct>
          <id>2hIKAB17haUAAAFG4.xU7mGD</id>
          <isFreeGift>false</isFreeGift>
          <isHiddenGift>false</isHiddenGift>
          <itemSurcharges>
            <Surcharge name="surcharge" type="Surcharge">
              <amount type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>5.95</value>
              </amount>
              <description>Surcharge for battery deposit</description>
              <displayName>Battery Deposit Surcharge</displayName>
              <taxes>
                <AppliedTax name="name" type="AppliedTax">
                  <amount type="Money">
                    <currencyMnemonic>USD</currencyMnemonic>
                    <value>0.95</value>
                  </amount>
                  <rate>0.19</rate>
                </AppliedTax>
              </taxes>
            </Surcharge>
          </itemSurcharges>
          <position>1</position>
          <price type="Money">
            <currencyMnemonic>USD</currencyMnemonic>
            <value>337.28</value>
          </price>
          <quantity type="Quantity">
            <unit>
            </unit>
            <value>1</value>
          </quantity>
          <salesTaxes>
            <AppliedTax name="name" type="AppliedTax">
              <amount type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>53.85</value>
              </amount>
              <rate>0.19</rate>
            </AppliedTax>
          </salesTaxes>
          <shipToAddress type="Address">
            <addressName>Patricia Miller, Berliner Str. 20, Potsdam</addressName>
            <city>Potsdam</city>
            <country>Germany</country>
            <countryCode>DE</countryCode>
            <firstName>Patricia</firstName>
            <id>BVUKAB17pEYAAAFGRuxU7mGD</id>
            <lastName>Miller</lastName>
            <phoneHome>049364112677</phoneHome>
            <postalCode>14482</postalCode>
            <street>Berliner Str. 20</street>
            <title>Mrs.</title>
          </shipToAddress>
          <shippingMethod name="Standard Ground" type="OrderShippingMethod">
            <id>STD_GROUND</id>
            <shippingTimeMax>7</shippingTimeMax>
            <shippingTimeMin>3</shippingTimeMin>
          </shippingMethod>
          <shippingTaxes>
            <AppliedTax name="name" type="AppliedTax">
              <amount type="Money">
                <currencyMnemonic>USD</currencyMnemonic>
                <value>0.52</value>
              </amount>
              <rate>0.19</rate>
            </AppliedTax>
          </shippingTaxes>
          <singleBasePrice type="Money">
            <currencyMnemonic>USD</currencyMnemonic>
            <value>340.85</value>
          </singleBasePrice>
          <thumbnail type="Link">
            <title>thumbnail</title>
            <uri>PrimeTech:/4XS/3953312-9812.jpg</uri>
          </thumbnail>
          <totals name="orderLineItemTotals" type="OrderLineItemTotalsRO"/>
          <variationProduct>false</variationProduct>
        </OrderLineItem>
      </lineItems>
      <shipToAddress type="Address">
        <addressName>Patricia Miller, Berliner Str. 20, Potsdam</addressName>
        <city>Potsdam</city>
        <country>Germany</country>
        <countryCode>DE</countryCode>
        <firstName>Patricia</firstName>
        <id>BVUKAB17pEYAAAFGRuxU7mGD</id>
        <lastName>Miller</lastName>
        <phoneHome>049364112677</phoneHome>
        <postalCode>14482</postalCode>
        <street>Berliner Str. 20</street>
        <title>Mrs.</title>
      </shipToAddress>
      <shippingMethod name="Standard Ground" type="OrderShippingMethod">
        <id>STD_GROUND</id>
        <shippingTimeMax>7</shippingTimeMax>
        <shippingTimeMin>3</shippingTimeMin>
      </shippingMethod>
    </OrderShippingBucket>
  </shippingBuckets>
  <shippingRebates>
    <AppliedRebate name="appliedRebate" type="AppliedRebate">
      <rebateType>ShippingPercentageOffDiscount</rebateType>
    </AppliedRebate>
  </shippingRebates>
  <shippingTaxTotalsByTaxRate>
    <AppliedTax name="name" type="AppliedTax">
      <amount type="Money">
        <currencyMnemonic>USD</currencyMnemonic>
        <value>0.52</value>
      </amount>
      <rate>19.0</rate>
    </AppliedTax>
  </shippingTaxTotalsByTaxRate>
  <status>NEW</status>
  <totals name="orderTotals" type="OrderTotals">
    <bucketShippingRebatesTotal type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.0</value>
    </bucketShippingRebatesTotal>
    <dutiesAndSurchargesTotal type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.0</value>
    </dutiesAndSurchargesTotal>
    <itemRebatesTotal type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>3.57</value>
    </itemRebatesTotal>
    <itemShippingRebatesTotal type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.0</value>
    </itemShippingRebatesTotal>
    <itemTotal type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>337.28</value>
    </itemTotal>
    <orderShippingRebatesTotal type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>0.36</value>
    </orderShippingRebatesTotal>
    <orderTotal type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>181.74</value>
    </orderTotal>
    <orderValueRebatesTotal type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>174.25</value>
    </orderValueRebatesTotal>
    <paymentCostsTotal type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>5.95</value>
    </paymentCostsTotal>
    <shippingTotal type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>3.59</value>
    </shippingTotal>
    <taxTotal type="Money">
      <currencyMnemonic>USD</currencyMnemonic>
      <value>29.02</value>
    </taxTotal>
  </totals>
  <valueRebates>
    <AppliedRebate name="appliedRebate" type="AppliedRebate">
      <rebateType>OrderValueOffDiscount</rebateType>
    </AppliedRebate>
  </valueRebates>
</Order>

Reference - WebShop REST APIs

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets