1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Store
  4. Orders

getAllOrdersForProfile

get

/ccstore/v1/orders

Get All Orders For Profile. Retrieves all orders associated with the logged in user. Also if the user is approver, orders of other users of the organziation which are requiring approval will be sent, Optionally takes the x-ccasset-language headers to get translated content in another language. Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization context of logged in user.

Request

Supported Media Types
  • application/json
Query Parameters
countOnly
Type: boolean
Only return the count of orders for the current profile.
limit
Type: integer
Specifies the number of orders to be retrieved starting from offset. In case this is not present, the complete list of orders for the profile is returned.
offset
Type: integer
Starting index.
q
Type: string
This field specifies the query used to limit the orders returns. Defaults to RQL. To use SCIM use the queryFormat parameter
sort
Type: string
This field specifies the sort order of the list to be fetched.
Header Parameters
X-CCOrganization
Type: string
Current organization context of the logged in user

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getAllOrdersForProfile_response
Nested Schema : items
Type: object
List of all the orders from the profile.
Nested Schema : priceListGroup
Type: object
The price list group object.
Nested Schema : currency
Type: object
The currency object.
Nested Schema : listPriceList
Type: object
List Pricelist object.
Nested Schema : salePriceList
Type: object
Sale Price List object.
Nested Schema : shippingSurchargePriceList
Type: object
Shipping Surcharge PriceList object.
Example 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,
                "subTotal":699,
                "creationDate":"2015-12-02T11:56:34.000Z",
                "submittedDate":"2015-12-02T11:57:47.090Z",
                "totalWithoutTax":705.5,
                "total":705.5,
                "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,
                "subTotal":98,
                "creationDate":"2015-12-02T11:53:46.000Z",
                "submittedDate":"2015-12-02T11:55:18.000Z",
                "totalWithoutTax":104.5,
                "total":104.5,
                "state":"SUBMITTED",
                "currencyCode":"EUR",
                "stateDetailsAsUser":"Submitted to fulfillment",
                "status":"Submitted to fulfillment"
            }
        ]
    }
]
Default Response
The error response
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

[{
  "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,
      "subTotal": 699,
      "creationDate": "2015-12-02T11:56:34.000Z",
      "submittedDate": "2015-12-02T11:57:47.090Z",
      "totalWithoutTax": 705.5,
      "total": 705.5,
      "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,
      "subTotal": 98,
      "creationDate": "2015-12-02T11:53:46.000Z",
      "submittedDate": "2015-12-02T11:55:18.000Z",
      "totalWithoutTax": 104.5,
      "total": 104.5,
      "state": "SUBMITTED",
      "currencyCode": "EUR",
      "stateDetailsAsUser": "Submitted to fulfillment",
      "status": "Submitted to fulfillment"
    }
  ]
}]