Basic information
GET /{shopId}/orders/{orderId}
Returns information for a single order identified by the provided order ID.
Authorisation
OAuth 2.0 Token required with scopes:
orders_read
URI parameters
| Name | Type | Description |
|---|---|---|
shopId |
string |
The unique identifier of the shop. Required:
true
Example:
DemoShop
|
orderId |
string |
Required:
true
|
Query parameters
| Name | Type | Description |
|---|---|---|
locale |
string |
Represents the language code according to ISO 639-1 and the country code according to ISO 3166-1. If not provided, the shop’s default language is used. We recommend to always send this parameter with your request. If the default language had been changed in the administration, it might take up to 1 day until this change affects the shop. Required:
false
Example:
en_US
|
Response attributes
| Name | Type | Description |
|---|---|---|
|
object of order |
Response
HTTP 200
Media type application/json
{
"orderId": "5639C509-092F-7704-77D3-D5809AB321D8",
"orderNumber": "ORD151104/1033",
"creationDate": "2015-11-04T08:42:49.000Z",
"customerId": "56389403-55BC-176C-5343-D5809AB3A579",
"customerNumber": "1028",
"locale": "de_DE",
"currencyId": "EUR",
"taxModel": "GROSS",
"grandTotal": "250.94",
"totalBeforeTax": "250.94",
"totalTax": "0",
"customerComment": null,
"internalNote": null,
"billingAddress": {
"company": "Boehm-Jacobs",
"salutation": null,
"firstName": "Walter",
"lastName": "Ankunding",
"street": "Barrows Mountain 8",
"streetDetails": null,
"zipCode": "89708-4738",
"city": "Lunaview",
"state": null,
"country": null,
"title": null,
"vatId": null,
"birthday": "1975-11-08",
"emailAddress": "Ankunding@bj.com",
"addressExtension": "1.Floor",
"bankAccountHolder": "Walter Ankunding",
"bankAccountNumber": "UK2677379838510",
"bankName": "Lunaview Bank",
"bankSortCode": "XXLUNBB",
"businessEmailAddress": "Ankunding@bj.com",
"businessPhoneNumber": "0045099906567",
"department": null,
"displayName": null,
"doorCode": null,
"faxNumber": "0045099906568",
"fiscalCode": null,
"gender": "MALE",
"jobTitle": "Manager",
"middleName": null,
"mobilePhoneNumber": "0045099906567",
"phoneNumber": "0045099906567",
"privateEmailAddress": null,
"privatePhoneNumber": null,
"websiteUrl": "http://bj.com"
},
"shippingAddress": null,
"shippingData": {
"shippingMethod": {
"id": "5171DD86-C077-0726-C448-AC14145F9026",
"name": "Standard delivery"
},
"price": {
"taxType": "GROSS",
"formatted": "7.32 €",
"amount": 7.32,
"currency": "EUR"
},
"taxes": [
{
"taxClass": {
"taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
"name": "regular",
"percentage": 0
},
"price": {
"taxType": "NONE",
"formatted": "0.00 €",
"amount": 0,
"currency": "EUR"
}
}
]
},
"paymentData": {
"paymentMethod": {
"id": "5171DD86-0714-8E9B-B079-AC14145F900F",
"name": "Payment in advance",
"providerName": null,
"additionalData": null
},
"transactionId": null,
"price": {
"taxType": "GROSS",
"formatted": "0.00 €",
"amount": 0,
"currency": "EUR"
},
"status": null,
"taxes": null
},
"viewedOn": "2015-11-03T14:48:50.000Z",
"rejectedOn": null,
"inProcessOn": null,
"pendingOn": null,
"readyForDispatchOn": null,
"partiallyDispatchedOn": null,
"dispatchedOn": null,
"deliveredOn": null,
"partiallyInvoicedOn": null,
"invoicedOn": null,
"partiallyPaidOn": null,
"paidOn": null,
"returnedOn": null,
"closedOn": null,
"archivedOn": null,
"lineItemContainer": {
"grandTotal": {
"taxType": "GROSS",
"formatted": "196.05 €",
"amount": 196.05,
"currency": "EUR"
},
"totalBeforeTax": {
"taxType": "NET",
"formatted": "196.05 €",
"amount": 196.05,
"currency": "EUR"
},
"totalTax": {
"taxType": "NONE",
"formatted": "0.00 €",
"amount": 0,
"currency": "EUR"
},
"lineItemsSubTotal": {
"taxType": "GROSS",
"formatted": "225.98 €",
"amount": 225.98,
"currency": "EUR"
},
"productLineItems": [
{
"lineItemId": "5638C3FC-9451-9B16-DEB1-D5809AB37761",
"sku": "HP-001-0006",
"name": "Dr.Boom - Red Bass",
"productId": "54EAF9A4-37D7-159F-3307-0A0C05E6CFE7",
"quantity": {
"amount": 1,
"unit": "piece(s)"
},
"lineItemPrice": {
"taxType": "GROSS",
"formatted": "199.99 €",
"amount": 199.99,
"currency": "EUR"
},
"singleItemPrice": {
"taxType": "GROSS",
"formatted": "199.99 €",
"amount": 199.99,
"currency": "EUR"
},
"lineItemCouponDiscount": {
"taxType": "GROSS",
"formatted": "1.70 €",
"amount": 1.7,
"currency": "EUR"
},
"images": [
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/EE97/FD85/1B66/9962/AC14/145F/A540/001-headphone-blue_h.jpg",
"classifier": "HotDeal",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/EE97/FD85/1B66/9962/AC14/145F/A540/001-headphone-blue.jpg",
"classifier": "Large",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/EE97/FD85/1B66/9962/AC14/145F/A540/001-headphone-blue_m.jpg",
"classifier": "Medium",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/EE97/FD85/1B66/9962/AC14/145F/A540/001-headphone-blue_s.jpg",
"classifier": "Small",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/EE97/FD85/1B66/9962/AC14/145F/A540/001-headphone-blue_xs.jpg",
"classifier": "Thumbnail",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
}
],
"links": [
{
"rel": "product",
"href": "https://pm.epages.com/rs/shops/apidocu/products/54EAF9A4-37D7-159F-3307-0A0C05E6CFE7"
},
{
"rel": "taxClass",
"href": "https://pm.epages.com/rs/shops/apidocu/tax-classes/5446685F-A8AF-0E18-9B4F-D5809AB30FBF"
}
],
"variationString": "Colour: blue",
"essentialFeatures": null,
"taxClass": {
"taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
"name": "regular",
"percentage": 0
},
"deliveryWeight": {
"amount": 250,
"unit": "g"
}
},
{
"lineItemId": "5638C3FD-9C4D-84EC-2DF0-D5809AB37714",
"sku": "HP-002-00",
"name": "Connection cable",
"productId": "54EF20B5-33A2-E55F-213B-0A0C05E62C6B",
"quantity": {
"amount": 1,
"unit": "piece(s)"
},
"lineItemPrice": {
"taxType": "GROSS",
"formatted": "25.99 €",
"amount": 25.99,
"currency": "EUR"
},
"singleItemPrice": {
"taxType": "GROSS",
"formatted": "25.99 €",
"amount": 25.99,
"currency": "EUR"
},
"images": [
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F901/9AE1/CAC6/00D8/AC14/145F/A463/007-acce-b_h.jpg",
"classifier": "HotDeal",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F901/9AE1/CAC6/00D8/AC14/145F/A463/007-acce-b.jpg",
"classifier": "Large",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F901/9AE1/CAC6/00D8/AC14/145F/A463/007-acce-b_m.jpg",
"classifier": "Medium",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F901/9AE1/CAC6/00D8/AC14/145F/A463/007-acce-b_s.jpg",
"classifier": "Small",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/F901/9AE1/CAC6/00D8/AC14/145F/A463/007-acce-b_xs.jpg",
"classifier": "Thumbnail",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
}
],
"links": [
{
"rel": "product",
"href": "https://pm.epages.com/rs/shops/apidocu/products/54EF20B5-33A2-E55F-213B-0A0C05E62C6B"
},
{
"rel": "taxClass",
"href": "https://pm.epages.com/rs/shops/apidocu/tax-classes/5446685F-A8AF-0E18-9B4F-D5809AB30FBF"
}
],
"variationString": "Colour: blue",
"essentialFeatures": null,
"taxClass": {
"taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
"name": "regular",
"percentage": 0
},
"deliveryWeight": {
"amount": 20,
"unit": "g"
}
}
],
"couponLineItem": null,
"shippingPrice": {
"taxType": "GROSS",
"formatted": "7.32 €",
"amount": 7.32,
"currency": "EUR"
},
"deposits": [],
"ecoParticipations": [],
"shippingOptions": [],
"basketDiscount": {
"links": []
}
},
"links": [
{
"rel": "self",
"href": "https://pm.epages.com/rs/shops/apidocu/orders/5638C3E4-03B6-9023-DE5B-D5809AB3777D"
},
{
"rel": "customer",
"href": "https://pm.epages.com/rs/shops/apidocu/customers/5638A1B2-0580-CA34-5DB3-D5809AB3A51C"
},
{
"rel": "shipping-method",
"href": "https://pm.epages.com/rs/shops/apidocu/shipping-methods/5171DD86-C077-0726-C448-AC14145F9026"
}
]
}