Basic information
POST /{shopId}/carts/{cartId}/order
Creates an order that is valid at the time of cart creation. It won’t be validated again while processing the actual request. Billing address has to be available in the cart before creating an order. The request body for this REST call remains empty.
Authorisation
OAuth 2.0 Token required with scopes:
orders_write
URI parameters
| Name | Type | Description |
|---|---|---|
shopId |
string |
The unique identifier of the shop. Required:
true
Example:
DemoShop
|
cartId |
string |
The unique identifier of the cart. Required:
true
Example:
5858FD17-147C-661C-9C33-D5809AB3C8BA
|
Response attributes
| Name | Type | Description |
|---|---|---|
|
object of order |
Response
HTTP 201
Media type application/json
{
"orderId": "5858FBC0-3CFA-AEEE-D837-D5809AB3C89F",
"orderNumber": "ORD161220/1039",
"creationDate": "2016-12-20T09:37:04.000Z",
"customerId": "5858FBC0-7B98-69BB-7A2E-D5809AB3C8BF",
"customerNumber": "1035",
"locale": "de_DE",
"currencyId": "EUR",
"taxModel": "GROSS",
"grandTotal": "10.37",
"totalBeforeTax": "8.71",
"totalTax": "1.66",
"customerComment": null,
"internalNote": null,
"billingAddress": {
"company": null,
"salutation": null,
"firstName": "Doris",
"lastName": "Daisy",
"street": "Daisy Road 2",
"streetDetails": null,
"zipCode": "87956",
"city": "Daisyland",
"state": null,
"country": "DE",
"title": null,
"vatId": null,
"birthday": null,
"addressExtension": "1.Floor",
"bankAccountHolder": "Doris Daisy",
"bankAccountNumber": "UA1567379838510",
"bankName": "Daisyland Bank",
"bankSortCode": "XXDAISBB",
"businessEmailAddress": "daisy@land.com",
"businessPhoneNumber": "0065099906543",
"department": null,
"displayName": null,
"doorCode": null,
"faxNumber": "0065099906545",
"fiscalCode": null,
"gender": "FEMALE",
"jobTitle": "Business Manager",
"middleName": null,
"mobilePhoneNumber": "0012066876500",
"phoneNumber": "0012066876500",
"privateEmailAddress": null,
"privatePhoneNumber": null,
"websiteUrl": "http://land.com",
"emailAddress": "daisy@land.com"
},
"shippingAddress": null,
"shippingData": {
"shippingMethod": {
"id": "5171DD86-C077-0726-C448-AC14145F9026",
"name": "Standardzustellung"
},
"price": {
"taxType": "GROSS",
"formatted": "10.37 €",
"amount": 10.37,
"currency": "EUR"
},
"taxes": [
{
"taxClass": {
"taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
"name": "standard",
"percentage": 19.0
},
"price": {
"taxType": "NONE",
"formatted": "1,66 €",
"amount": 1.66,
"currency": "EUR"
}
}
]
},
"paymentData": {
"paymentMethod": {
"id": "5171DD89-6DE5-E758-E046-AC14145F9009",
"name": "PayPal",
"providerName": "PayPal",
"additionalData": null
},
"transactionId": "7PM024488F971832G",
"price": {
"taxType": "GROSS",
"formatted": "0.00 €",
"amount": 0,
"currency": "EUR"
},
"status": null,
"taxes": null
},
"viewedOn": null,
"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": "10.37 €",
"amount": 10.37,
"currency": "EUR"
},
"totalBeforeTax": {
"taxType": "NET",
"formatted": "8.71 €",
"amount": 8.71,
"currency": "EUR"
},
"totalTax": {
"taxType": "NONE",
"formatted": "1.66 €",
"amount": 1.66,
"currency": "EUR"
},
"lineItemsSubTotal": {
"taxType": "GROSS",
"formatted": "25.98 €",
"amount": 25.98,
"currency": "EUR"
},
"productLineItems": [
{
"lineItemId": "5858EDE0-6E6D-DBC6-A97B-D5809AB37DD9",
"sku": "Acc-001",
"name": "Connector 6.3 mm",
"productId": "54E72E1F-746A-8B6E-8E41-0A0C05E64669",
"quantity": {
"amount": 2,
"unit": "yd³"
},
"lineItemPrice": {
"taxType": "GROSS",
"formatted": "25.98 €",
"amount": 25.98,
"currency": "EUR"
},
"singleItemPrice": {
"taxType": "GROSS",
"formatted": "12.99 €",
"amount": 12.99,
"currency": "EUR"
},
"lineItemCouponDiscount": {
"taxType": "GROSS",
"formatted": "1.70 €",
"amount": 1.7,
"currency": "EUR"
},
"images": [
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_h.jpg",
"classifier": "HotDeal",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6.jpg",
"classifier": "Large",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_m.jpg",
"classifier": "Medium",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_s.jpg",
"classifier": "Small",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
},
{
"url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_xs.jpg",
"classifier": "Thumbnail",
"isZoomEnabled": false,
"width": 0,
"height": 0,
"fileSize": 0
}
],
"additionalInformation": {
"bulkPriceInfo": [
{
"quantity": {
"amount": 1,
"unit": "piece(s)"
},
"price": {
"taxType": "GROSS",
"formatted": "9.00 €",
"amount": 9,
"currency": "EUR"
},
"basePrice": null,
"priceSavings": {
"percent": {
"formatted": "10 %",
"percentage": 10.0
},
"regularBulkPrice": {
"taxType": "GROSS",
"formatted": "10.00 €",
"amount": 10,
"currency": "EUR"
}
}
}
]
},
"links": [
{
"rel": "product",
"href": "https://pm.epages.com/api/products/54E72E1F-746A-8B6E-8E41-0A0C05E64669"
},
{
"rel": "taxClass",
"href": "https://pm.epages.com/api/tax-classes/5446685F-A8AF-0E18-9B4F-D5809AB30FBF"
}
],
"variationString": null,
"essentialFeatures": null,
"taxClass": {
"taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
"name": "standard",
"percentage": 19.0
},
"deliveryWeight": {
"amount": 100,
"unit": "oz"
},
"energyLabelsString": "C",
"energyLabelsMaxEfficiencyString": "A+++",
"energyLabelSourceFile": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/Products/be_40401/label-1-9dee85f24e1.png",
"productDataSheetSourceFile": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/Products/be_40401/data.pdf"
}
],
"couponLineItem": {
"couponLineItemId": "5858F55B-0C82-4C2C-A435-D5809AB3C878",
"lineItemPrice": {
"taxType": "NONE",
"formatted": "-25.98 €",
"amount": -25.98,
"currency": "EUR"
}
},
"shippingPrice": {
"taxType": "GROSS",
"formatted": "10.37 €",
"amount": 10.37,
"currency": "EUR"
},
"deposits": [],
"ecoParticipations": [],
"shippingOptions": [],
"basketDiscount": {
"links": []
}
},
"links": [
{
"rel": "self",
"href": "https://pm.epages.com/rs/shops/apidocu/orders/5858FBC0-3CFA-AEEE-D837-D5809AB3C89F"
},
{
"rel": "customer",
"href": "https://pm.epages.com/rs/shops/apidocu/customers/5858FBC0-7B98-69BB-7A2E-D5809AB3C8BF"
},
{
"rel": "shipping-method",
"href": "https://pm.epages.com/rs/shops/apidocu/shipping-methods/5171DD86-C077-0726-C448-AC14145F9026"
}
]
}