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
- application/json
Query Parameters
-
countOnly: boolean
Only return the count of orders for the current profile.Default Value:
false
-
expand: string
Specify
profile
to include shopper profile information in the response. -
incompleteOnly: boolean
Only return the list of incomplete orders for the current profile.Default Value:
false
-
limit: 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: integer
Starting index when paging through orders.
-
q: string
This field specifies the query used to limit the orders returns.
-
sort: string
This field specifies the sort order of the list to be fetched.Default Value:
submittedDate:desc
Header Parameters
-
X-CCAsset-Language: string
Instructs the endpoint to use the specified locale code for content returned in the response. The locale supplied in the header must be supported by your store.
-
X-CCOrganization: string
Current organization context of the logged in user
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : getAllOrdersForProfile_response
Type:
Show Source
object
-
items:
object items
List of all the orders from the profile.
Nested Schema : items
Type:
object
List of all the orders from the profile.
Show Source
-
cartName:
string
Cart name for this order.
-
creationDate:
string
Order creation date.
-
currencyCode:
string
Currency code for this order.
-
lastModifiedDate:
string
last modified date for this order.
-
orderId:
string
ID for this order.
-
priceListGroup:
object priceListGroup
The price list group object.
-
scheduledOrderId:
string
Scheduled order ID if exists.
-
scheduledOrderName:
string
Scheduled order name if exists.
-
siteId:
string
The ID of the site on which the order was placed.
-
state:
string
State of the current order.
-
stateDetailsAsUser:
string
Order State description for this order. Incorporates changes made by merchant from admin UI, if any.
-
status:
string
Status of the current order.
-
submittedDate:
string
Order submitted date.
-
total:
number
total price of the order.
Nested Schema : priceListGroup
Type:
object
The price list group object.
Show Source
-
active:
boolean
Active status of the price list group.
-
currency:
object currency
The currency object.
-
deleted:
boolean
Property to determine existence of the price list grou.p
-
displayName:
string
Display name of the price list group.
-
id:
string
ID of the price list group.
-
listPriceList:
object listPriceList
List Pricelist object.
-
locale:
string
Locale of the price list group.
-
repositoryId:
string
Repository ID of the price list group.
-
salePriceList:
object salePriceList
Sale Price List object.
-
shippingSurchargePriceList:
object shippingSurchargePriceList
Shipping Surcharge PriceList object.
Nested Schema : currency
Type:
object
The currency object.
Show Source
-
currencyCode:
string
The currency code.
-
displayName:
string
Display name of the currency.
-
fractionalDigits:
integer
Number of fractional digits for the currency.
-
numericCode:
string
Numeric code of the currency.
-
repositoryId:
string
Repository ID of the currency.
-
symbol:
string
The currency symbol.
Nested Schema : listPriceList
Type:
object
List Pricelist object.
Show Source
-
repositoryId:
string
Repository ID of the list price list.
Nested Schema : salePriceList
Type:
object
Sale Price List object.
Show Source
-
repositoryId:
string
Repository ID of the sale price list.
Nested Schema : shippingSurchargePriceList
Type:
object
Shipping Surcharge PriceList object.
Show Source
-
repositoryId:
string
Repository ID of the shipping surcharge price list.
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:
The error response:
Error Code | Description | Possible Fix |
---|---|---|
28117 | Invalid offset or limit parameters defined. | Correct the parameter values and try again. |
28314 | There 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:
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code