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(optional): boolean
Only return the count of orders for the current profile.
-
incompleteOnly(optional): boolean
Only return the list of incomplete orders for the current profile.
-
limit(optional): 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(optional): integer
Starting index.
-
q(optional): string
This field specifies the query used to limit the orders returns. Defaults to RQL. To use SCIM use the queryFormat parameter
-
sort(optional): string
This field specifies the sort order of the list to be fetched.
Header Parameters
-
X-CCOrganization(optional): string
Current organization context of the logged in user
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getAllOrdersForProfile_response
Type:
Show Source
object-
items(optional):
object items
List of all the orders from the profile.
Nested Schema : items
Type:
objectList of all the orders from the profile.
Show Source
-
cartName(optional):
string
Cart name for this order.
-
creationDate(optional):
string
Order creation date.
-
currencyCode(optional):
string
Currency code for this order.
-
lastModifiedDate(optional):
string
last modified date for this order.
-
orderId(optional):
string
Id for this order.
-
priceListGroup(optional):
object priceListGroup
The price list group object.
-
scheduledOrderId(optional):
string
Scheduled order id if exists.
-
scheduledOrderName(optional):
string
Scheduled order name if exists.
-
state(optional):
string
state of the current order.
-
stateDetailsAsUser(optional):
string
Order State description for this order. Incorporates changes made by merchant from admin UI, if any.
-
status(optional):
string
status of the current order.
-
submittedDate(optional):
string
Order submitted date.
-
total(optional):
number
total price of the order.
Nested Schema : priceListGroup
Type:
objectThe price list group object.
Show Source
-
active(optional):
boolean
Active status of the price list group.
-
currency(optional):
object currency
The currency object.
-
deleted(optional):
boolean
Property to determine existence of the price list grou.p
-
displayName(optional):
string
Display name of the price list group.
-
id(optional):
string
ID of the price list group.
-
listPriceList(optional):
object listPriceList
List Pricelist object.
-
locale(optional):
string
Locale of the price list group.
-
repositoryId(optional):
string
Repository ID of the price list group.
-
salePriceList(optional):
object salePriceList
Sale Price List object.
-
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
Shipping Surcharge PriceList object.
Nested Schema : currency
Type:
objectThe currency object.
Show Source
-
currencyCode(optional):
string
The currency code.
-
displayName(optional):
string
Display name of the currency.
-
fractionalDigits(optional):
integer
Number of fractional digits for the currency.
-
numericCode(optional):
string
Numeric code of the currency.
-
repositoryId(optional):
string
Repository ID of the currency.
-
symbol(optional):
string
The currency symbol.
Nested Schema : listPriceList
Type:
objectList Pricelist object.
Show Source
-
repositoryId(optional):
string
Repository ID of the list price list.
Nested Schema : salePriceList
Type:
objectSale Price List object.
Show Source
-
repositoryId(optional):
string
Repository ID of the sale price list.
Nested Schema : shippingSurchargePriceList
Type:
objectShipping Surcharge PriceList object.
Show Source
-
repositoryId(optional):
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,
"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,
"state":"SUBMITTED",
"currencyCode":"EUR",
"stateDetailsAsUser":"Submitted to fulfillment",
"status":"Submitted to fulfillment"
}
]
}
]Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code