1. REST API for Oracle Commerce Cloud 21B
  2. Tasks
  3. Store
  4. Orders

Get all orders for profile

get

/ccstore/v1/orders

Retrieves all submitted orders associated with the profile in the currently authenticated session. If the profile is not logged in or is anonymous then the endpoint will fail. This endpoint is typically used to retrieve order history.

Note: Access to orders can be role based i.e. if the user is an approver, orders of other users within the organization, which are requiring approval, will be sent. This is primarily for B2B use cases.

Prerequisite: The user must be logged in. See REST API Authentication.

This endpoint supports SCIM filtering. See REST API query parameters.

Request

Supported Media Types
Query Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Returned when the operation succeeds.
Body ()
Root Schema : getAllOrdersForProfile_response
Type: object
Show Source
Nested Schema : items
Type: object
List of all the orders from the profile.
Show Source
Nested Schema : priceListGroup
Type: object
The price list group object.
Show Source
Nested Schema : currency
Type: object
The currency object.
Show Source
Nested Schema : listPriceList
Type: object
List Pricelist object.
Show Source
Nested Schema : salePriceList
Type: object
Sale Price List object.
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Shipping Surcharge PriceList object.
Show Source
Example Response (application/json)
[
    {
        "total":2,
        "limit":-1,
        "items":[
            {
                "cost":6.5,
                "lastModifiedDate":"2015-12-02T11:57:47.100Z",
                "orderId":"o10030",
                "shippingSurchargeValue":0,
                "priceListGroup":{
                    "deleted":false,
                    "displayName":"UsDollar",
                    "listPriceList":{
                        "repositoryId":"listPrices"
                    },
                    "repositoryId":"UsDollar",
                    "active":true,
                    "salePriceList":{
                        "repositoryId":"salePrices"
                    },
                    "currency":{
                        "symbol":"$",
                        "displayName":"US Dollar",
                        "repositoryId":"en_US",
                        "fractionalDigits":2,
                        "currencyCode":"USD",
                        "numericCode":"840"
                    },
                    "id":"UsDollar",
                    "locale":"en_US",
                    "shippingSurchargePriceList":{
                        "repositoryId":"shippingSurchargePrices"
                    }
                },
                "tax":0,
                "cartName":"Test Name",
                "subTotal":699,
                "creationDate":"2015-12-02T11:56:34.000Z",
                "submittedDate":"2015-12-02T11:57:47.090Z",
                "totalWithoutTax":705.5,
                "total":705.5,
                "siteId":"siteUS",
                "state":"SUBMITTED",
                "currencyCode":"USD",
                "stateDetailsAsUser":"Submitted to fulfillment",
                "status":"Submitted to fulfillment"
            },
            {
                "cost":6.5,
                "lastModifiedDate":"2015-12-02T11:55:18.000Z",
                "orderId":"o10021",
                "shippingSurchargeValue":0,
                "priceListGroup":{
                    "deleted":false,
                    "displayName":"Euros",
                    "listPriceList":{
                        "repositoryId":"euros_listPrices"
                    },
                    "repositoryId":"euros",
                    "active":true,
                    "salePriceList":{
                        "repositoryId":"euros_salePrices"
                    },
                    "currency":{
                        "symbol":"???",
                        "displayName":"Euro",
                        "repositoryId":"de_DE_EURO",
                        "fractionalDigits":2,
                        "currencyCode":"EUR",
                        "numericCode":"978"
                    },
                    "id":"euros",
                    "locale":"de_DE_EURO",
                    "shippingSurchargePriceList":{
                        "repositoryId":"euros_shippingSurchargePrices"
                    }
                },
                "tax":0,
                "cartName":"Euro cart",
                "subTotal":98,
                "creationDate":"2015-12-02T11:53:46.000Z",
                "submittedDate":"2015-12-02T11:55:18.000Z",
                "totalWithoutTax":104.5,
                "total":104.5,
                "siteId":"siteUS",
                "state":"SUBMITTED",
                "currencyCode":"EUR",
                "stateDetailsAsUser":"Submitted to fulfillment",
                "status":"Submitted to fulfillment"
            }
        ]
    }
]

Default Response

The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
Error CodeDescriptionPossible Fix
28117Invalid offset or limit parameters defined.Correct the parameter values and try again.
28314There was an error getting the order.The current shopper context may be invalid or there may not be a current order selected for the logged in user.

The error response:
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top