Gets a specific order.
1 min
GET
/episerverapi/commerce/orders/{orderGroupId}
Path Parameters
- orderGroupIdinteger<int32>requiredDescriptionFormatint32
Header Parameters
- acceptstringDescriptionDefaulttext/plainAllowedtext/plainapplication/jsontext/json
Responses
200
- PurchaseOrderModelDescription
- addressIdstringDescription
- affiliateIdstring<uuid>DescriptionFormatuuid
- billingCurrencystringDescription
- customerIdstring<uuid>DescriptionFormatuuid
- customerNamestringDescription
- handlingTotalnumber<double>DescriptionFormatdouble
- instanceIdstring<uuid>DescriptionFormatuuid
- marketIdstringDescription
- namestringrequiredDescription
- orderAddressesOrderAddressModel[]Description
- orderGroupAddressIdinteger<int32>DescriptionFormatint32
- namestringDescription
- firstNamestringDescription
- lastNamestringDescription
- organizationstringDescription
- line1stringDescription
- line2stringDescription
- citystringDescription
- statestringDescription
- countryCodestringDescription
- countryNamestringDescription
- postalCodestringDescription
- regionCodestringDescription
- regionNamestringDescription
- daytimePhoneNumberstringDescription
- eveningPhoneNumberstringDescription
- faxNumberstringDescription
- emailstringDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- orderFormsOrderFormModel[]Description
- shipmentsShipmentModel[]Description
- discountsModelDiscountModel[]Description
- discountIdinteger<int32>DescriptionFormatint32
- discountAmountnumber<double>DescriptionFormatdouble
- discountCodestringDescription
- discountNamestringDescription
- displayMessagestringDescription
- discountValuenumber<double>DescriptionFormatdouble
- shipmentIdinteger<int32>DescriptionFormatint32
- shippingMethodIdstring<uuid>DescriptionFormatuuid
- shippingMethodNamestringDescription
- shippingTaxnumber<double>DescriptionFormatdouble
- shippingAddressIdstringDescription
- shipmentTrackingNumberstringDescription
- shippingDiscountAmountnumber<double>DescriptionFormatdouble
- shippingSubTotalnumber<double>DescriptionFormatdouble
- shippingTotalnumber<double>DescriptionFormatdouble
- statusstringDescription
- prevStatusstringDescription
- pickListIdinteger<int32>DescriptionFormatint32
- subTotalnumber<double>DescriptionFormatdouble
- warehouseCodestringDescription
- lineItemsLineItemModel[]Description
- lineItemIdinteger<int32>DescriptionFormatint32
- codestringDescription
- displayNamestringDescription
- placedPricenumber<double>DescriptionFormatdouble
- extendedPricenumber<double>DescriptionFormatdouble
- discountedPricenumber<double>DescriptionFormatdouble
- quantitynumber<double>DescriptionFormatdouble
- returnQuantitynumber<double>DescriptionFormatdouble
- inventoryTrackingStatusInventoryTrackingStatus
- isInventoryAllocatedbooleanDescription
- isGiftbooleanDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- lineItemsLineItemModel[]Description
- lineItemIdinteger<int32>DescriptionFormatint32
- codestringDescription
- displayNamestringDescription
- placedPricenumber<double>DescriptionFormatdouble
- extendedPricenumber<double>DescriptionFormatdouble
- discountedPricenumber<double>DescriptionFormatdouble
- quantitynumber<double>DescriptionFormatdouble
- returnQuantitynumber<double>DescriptionFormatdouble
- inventoryTrackingStatusInventoryTrackingStatus
- isInventoryAllocatedbooleanDescription
- isGiftbooleanDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- paymentsPaymentModel[]
- amountnumber<double>Formatdouble
- authorizationCodestring
- billingAddressIdstring
- customerNamestring
- implementationClassstring
- paymentIdinteger<int32>Formatint32
- paymentMethodIdstring<uuid>Formatuuid
- paymentMethodNamestring
- paymentTypeModelPaymentTypeModel
- statusstring
- transactionTypestring
- validationCodestring
- transactionIDstring
- providerTransactionIDstring
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- discountsDiscountModel[]Description
- discountIdinteger<int32>DescriptionFormatint32
- discountAmountnumber<double>DescriptionFormatdouble
- discountCodestringDescription
- discountNamestringDescription
- displayMessagestringDescription
- discountValuenumber<double>DescriptionFormatdouble
- returnCommentstringDescription
- returnTypestringDescription
- returnAuthCodestringDescription
- orderFormIdinteger<int32>DescriptionFormatint32
- namestringDescription
- billingAddressIdstringDescription
- shippingTotalnumber<double>DescriptionFormatdouble
- handlingTotalnumber<double>DescriptionFormatdouble
- taxTotalnumber<double>DescriptionFormatdouble
- discountAmountnumber<double>DescriptionFormatdouble
- subTotalnumber<double>DescriptionFormatdouble
- totalnumber<double>DescriptionFormatdouble
- statusstringDescription
- rmaNumberstringDescription
- authorizedPaymentTotalnumber<double>DescriptionFormatdouble
- capturedPaymentTotalnumber<double>DescriptionFormatdouble
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- orderGroupIdinteger<int32>DescriptionFormatint32
- orderNotesOrderNoteModel[]Description
- orderNoteIdinteger<int32>DescriptionFormatint32
- createdstring<date-time>DescriptionFormatdate-time
- customerIdstring<uuid>DescriptionFormatuuid
- detailstringDescription
- titlestringDescription
- typestringDescription
- lineItemIdinteger<int32>DescriptionFormatint32
- ownerstringDescription
- ownerOrgstringDescription
- providerIdstringDescription
- shippingTotalnumber<double>DescriptionFormatdouble
- statusstringDescription
- subTotalnumber<double>DescriptionFormatdouble
- taxTotalnumber<double>DescriptionFormatdouble
- totalnumber<double>DescriptionFormatdouble
- modifiedstring<date-time>DescriptionFormatdate-time
- createdstring<date-time>DescriptionFormatdate-time
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- orderNumberstringDescription
- returnFormsReturnOrderFormModel[]Description
- shipmentsShipmentModel[]Description
- discountsModelDiscountModel[]Description
- discountIdinteger<int32>DescriptionFormatint32
- discountAmountnumber<double>DescriptionFormatdouble
- discountCodestringDescription
- discountNamestringDescription
- displayMessagestringDescription
- discountValuenumber<double>DescriptionFormatdouble
- shipmentIdinteger<int32>DescriptionFormatint32
- shippingMethodIdstring<uuid>DescriptionFormatuuid
- shippingMethodNamestringDescription
- shippingTaxnumber<double>DescriptionFormatdouble
- shippingAddressIdstringDescription
- shipmentTrackingNumberstringDescription
- shippingDiscountAmountnumber<double>DescriptionFormatdouble
- shippingSubTotalnumber<double>DescriptionFormatdouble
- shippingTotalnumber<double>DescriptionFormatdouble
- statusstringDescription
- prevStatusstringDescription
- pickListIdinteger<int32>DescriptionFormatint32
- subTotalnumber<double>DescriptionFormatdouble
- warehouseCodestringDescription
- lineItemsLineItemModel[]Description
- lineItemIdinteger<int32>DescriptionFormatint32
- codestringDescription
- displayNamestringDescription
- placedPricenumber<double>DescriptionFormatdouble
- extendedPricenumber<double>DescriptionFormatdouble
- discountedPricenumber<double>DescriptionFormatdouble
- quantitynumber<double>DescriptionFormatdouble
- returnQuantitynumber<double>DescriptionFormatdouble
- inventoryTrackingStatusInventoryTrackingStatus
- isInventoryAllocatedbooleanDescription
- isGiftbooleanDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- lineItemsLineItemModel[]Description
- lineItemIdinteger<int32>DescriptionFormatint32
- codestringDescription
- displayNamestringDescription
- placedPricenumber<double>DescriptionFormatdouble
- extendedPricenumber<double>DescriptionFormatdouble
- discountedPricenumber<double>DescriptionFormatdouble
- quantitynumber<double>DescriptionFormatdouble
- returnQuantitynumber<double>DescriptionFormatdouble
- inventoryTrackingStatusInventoryTrackingStatus
- isInventoryAllocatedbooleanDescription
- isGiftbooleanDescription
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- paymentsPaymentModel[]
- amountnumber<double>Formatdouble
- authorizationCodestring
- billingAddressIdstring
- customerNamestring
- implementationClassstring
- paymentIdinteger<int32>Formatint32
- paymentMethodIdstring<uuid>Formatuuid
- paymentMethodNamestring
- paymentTypeModelPaymentTypeModel
- statusstring
- transactionTypestring
- validationCodestring
- transactionIDstring
- providerTransactionIDstring
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- discountsDiscountModel[]Description
- discountIdinteger<int32>DescriptionFormatint32
- discountAmountnumber<double>DescriptionFormatdouble
- discountCodestringDescription
- discountNamestringDescription
- displayMessagestringDescription
- discountValuenumber<double>DescriptionFormatdouble
- returnCommentstringDescription
- returnTypestringDescription
- returnAuthCodestringDescription
- orderFormIdinteger<int32>DescriptionFormatint32
- namestringDescription
- billingAddressIdstringDescription
- shippingTotalnumber<double>DescriptionFormatdouble
- handlingTotalnumber<double>DescriptionFormatdouble
- taxTotalnumber<double>DescriptionFormatdouble
- discountAmountnumber<double>DescriptionFormatdouble
- subTotalnumber<double>DescriptionFormatdouble
- totalnumber<double>DescriptionFormatdouble
- statusstringDescription
- rmaNumberstringDescription
- authorizedPaymentTotalnumber<double>DescriptionFormatdouble
- capturedPaymentTotalnumber<double>DescriptionFormatdouble
- propertiesPropertyItemModel[]Description
- keystringDescription
- valuestringDescription
- originalOrderFormIdinteger<int32>DescriptionFormatint32
- exchangeOrderGroupIdinteger<int32>DescriptionFormatint32
401
404
curl
curl --request GET \
--url /episerverapi/commerce/orders/{orderGroupId} \
--header 'accept: text/plain'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "text/plain");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("/episerverapi/commerce/orders/{orderGroupId}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("/episerverapi/commerce/orders/{orderGroupId}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "text/plain"
request["content-type"] = "application/json"
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "/episerverapi/commerce/orders/{orderGroupId}"
payload = {}
headers = {
'accept': 'text/plain',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Return the order.
{
"addressId": "",
"affiliateId": "",
"billingCurrency": "",
"customerId": "",
"customerName": "",
"handlingTotal": "",
"instanceId": "",
"marketId": "",
"name": "",
"orderAddresses": [
{
"orderGroupAddressId": "",
"name": "",
"firstName": "",
"lastName": "",
"organization": "",
"line1": "",
"line2": "",
"city": "",
"state": "",
"countryCode": "",
"countryName": "",
"postalCode": "",
"regionCode": "",
"regionName": "",
"daytimePhoneNumber": "",
"eveningPhoneNumber": "",
"faxNumber": "",
"email": "",
"properties": [
{
"key": "",
"value": ""
}
]
}
],
"orderForms": [
{
"shipments": [
{
"discountsModel": [
{
"discountId": "",
"discountAmount": "",
"discountCode": "",
"discountName": "",
"displayMessage": "",
"discountValue": ""
}
],
"shipmentId": "",
"shippingMethodId": "",
"shippingMethodName": "",
"shippingTax": "",
"shippingAddressId": "",
"shipmentTrackingNumber": "",
"shippingDiscountAmount": "",
"shippingSubTotal": "",
"shippingTotal": "",
"status": "",
"prevStatus": "",
"pickListId": "",
"subTotal": "",
"warehouseCode": "",
"lineItems": [
{
"lineItemId": "",
"code": "",
"displayName": "",
"placedPrice": "",
"extendedPrice": "",
"discountedPrice": "",
"quantity": "",
"returnQuantity": "",
"inventoryTrackingStatus": 0,
"isInventoryAllocated": false,
"isGift": false,
"properties": [
{
"key": "",
"value": ""
}
]
}
],
"properties": [
{
"key": "",
"value": ""
}
]
}
],
"lineItems": [
{
"lineItemId": "",
"code": "",
"displayName": "",
"placedPrice": "",
"extendedPrice": "",
"discountedPrice": "",
"quantity": "",
"returnQuantity": "",
"inventoryTrackingStatus": 0,
"isInventoryAllocated": false,
"isGift": false,
"properties": [
{
"key": "",
"value": ""
}
]
}
],
"payments": [
{
"amount": "",
"authorizationCode": "",
"billingAddressId": "",
"customerName": "",
"implementationClass": "",
"paymentId": "",
"paymentMethodId": "",
"paymentMethodName": "",
"paymentTypeModel": 0,
"status": "",
"transactionType": "",
"validationCode": "",
"transactionID": "",
"providerTransactionID": "",
"properties": [
{
"key": "",
"value": ""
}
]
}
],
"discounts": [
{
"discountId": "",
"discountAmount": "",
"discountCode": "",
"discountName": "",
"displayMessage": "",
"discountValue": ""
}
],
"returnComment": "",
"returnType": "",
"returnAuthCode": "",
"orderFormId": "",
"name": "",
"billingAddressId": "",
"shippingTotal": "",
"handlingTotal": "",
"taxTotal": "",
"discountAmount": "",
"subTotal": "",
"total": "",
"status": "",
"rmaNumber": "",
"authorizedPaymentTotal": "",
"capturedPaymentTotal": "",
"properties": [
{
"key": "",
"value": ""
}
]
}
],
"orderGroupId": "",
"orderNotes": [
{
"orderNoteId": "",
"created": "",
"customerId": "",
"detail": "",
"title": "",
"type": "",
"lineItemId": ""
}
],
"owner": "",
"ownerOrg": "",
"providerId": "",
"shippingTotal": "",
"status": "",
"subTotal": "",
"taxTotal": "",
"total": "",
"modified": "",
"created": "",
"properties": [
{
"key": "",
"value": ""
}
],
"orderNumber": "",
"returnForms": [
{
"shipments": [
{
"discountsModel": [
{
"discountId": "",
"discountAmount": "",
"discountCode": "",
"discountName": "",
"displayMessage": "",
"discountValue": ""
}
],
"shipmentId": "",
"shippingMethodId": "",
"shippingMethodName": "",
"shippingTax": "",
"shippingAddressId": "",
"shipmentTrackingNumber": "",
"shippingDiscountAmount": "",
"shippingSubTotal": "",
"shippingTotal": "",
"status": "",
"prevStatus": "",
"pickListId": "",
"subTotal": "",
"warehouseCode": "",
"lineItems": [
{
"lineItemId": "",
"code": "",
"displayName": "",
"placedPrice": "",
"extendedPrice": "",
"discountedPrice": "",
"quantity": "",
"returnQuantity": "",
"inventoryTrackingStatus": 0,
"isInventoryAllocated": false,
"isGift": false,
"properties": [
{
"key": "",
"value": ""
}
]
}
],
"properties": [
{
"key": "",
"value": ""
}
]
}
],
"lineItems": [
{
"lineItemId": "",
"code": "",
"displayName": "",
"placedPrice": "",
"extendedPrice": "",
"discountedPrice": "",
"quantity": "",
"returnQuantity": "",
"inventoryTrackingStatus": 0,
"isInventoryAllocated": false,
"isGift": false,
"properties": [
{
"key": "",
"value": ""
}
]
}
],
"payments": [
{
"amount": "",
"authorizationCode": "",
"billingAddressId": "",
"customerName": "",
"implementationClass": "",
"paymentId": "",
"paymentMethodId": "",
"paymentMethodName": "",
"paymentTypeModel": 0,
"status": "",
"transactionType": "",
"validationCode": "",
"transactionID": "",
"providerTransactionID": "",
"properties": [
{
"key": "",
"value": ""
}
]
}
],
"discounts": [
{
"discountId": "",
"discountAmount": "",
"discountCode": "",
"discountName": "",
"displayMessage": "",
"discountValue": ""
}
],
"returnComment": "",
"returnType": "",
"returnAuthCode": "",
"orderFormId": "",
"name": "",
"billingAddressId": "",
"shippingTotal": "",
"handlingTotal": "",
"taxTotal": "",
"discountAmount": "",
"subTotal": "",
"total": "",
"status": "",
"rmaNumber": "",
"authorizedPaymentTotal": "",
"capturedPaymentTotal": "",
"properties": [
{
"key": "",
"value": ""
}
],
"originalOrderFormId": "",
"exchangeOrderGroupId": ""
}
]
}401
// If user does not have enough permission for this request.
404
// If order does not exist.