Order Service

Download OpenAPI specification:Download

E-mail: documentation@emporix.com

Create an order from cart.

Key Features:

Create orders with products that have indicative prices (e.g. price is only known after an item has been weighed)
Create and retrieve own orders, and update order statuses by customers (on the storefront)
Create, retrieve, delete, and update orders by tenant's employees (through Emporix Management Dashboard or by using a third-party application)
Show order history
Convert historic orders into current order

Key Benefits:

Built for high volume / throughput
Never let a customer not place an order
Make it easy for your customers to order from last order
Make order queues, virtual waiting queues a thing of the past
Benefit from automatic / elastic scaling to cope easily with peak order volume

Orders (tenant-managed)

Retrieving orders

Retrieves tenant's orders for administrative purposes. To be used by tenant's employees.

Required scopes

order.order_read

SecurityOAuth2

Request

path Parameters

tenant

required

string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

query Parameters

sort	string The list of comma-separated properties used to sort the results. By default, the column values are sorted in ascending order. Can either be in the form of fieldName or fieldName:asc,fieldName:desc. If you want to sort by localized attributes, you must use the following form: fieldName.language or fieldName.language:asc,fieldName.language:desc.
pageNumber	integer >= 1 Default: 1 The page number to be retrieved where the size of the pages must be specified by the pageSize parameter. The number of the first page is 1.
pageSize	integer >= 1 Default: 16 The number of documents being retrieved on the page.
q	string A standard query parameter is used to search for specific values. Searching for an item by string property: `q=currency:USD` where `currency` is the name of string field and `USD` is its required value. Searching for items by number-based property: Searching for items with specific value: `q=tax.total.amount:20` Searching for items with value greater than: `q=tax.total.amount:>20` Searching for items with value lower than: `q=tax.total.amount:<20` Searching for items with value greater or equal than: `q=tax.total.amount:>=20` Searching for items with value lower or equal than: `q=tax.total.amount:<=20` Searching for items with within a range of values: `q=tax.total.amount:(>=10 AND <=20)` where `tax.total.amount` is name of number-based field and `20` is it's querying value. Searching for items by date property. All numer-based property queries are valid also for dates. In that case the date should be placed within double quotes: `q=created:(>="2021-05-18T07:27:27.455Z" AND <"2021-05-20T07:27:27.455Z")` Searching for items by boolean value: `q=customer.mixins.generalAttributes.invoiceNotDeliveryAddress:true` where `customer.mixins.generalAttributes.invoiceNotDeliveryAddress` is a name of boolean field and 'true' is it`s required value. Searching for items with non existing or empty property: `q=billingAddress.contactPhone:null` where `billingAddress.contactPhone` is a name of fields that has value `null`. Searching for items with existing property: `q=mixin:exists` where `mixin` is a name of field that has `non null` value. Searching for items by multiple specific values: `q=id:(order_id1,order_id2)` where `id` is name of field and strings within a bracket are it's required value. Searching for items by multiple fields: `q=id:order_id1 status:COMPLETED` where `id` and `status` are the names of fields. All documents that contain given values of these fields are returned. Multiple fields separated by space can be specified. Multiple values for each field can be also specified in a format presented above. Example: q=currency:USD
fields	string A list of comma-separated fields names of the Order. If the field is empty then full order is returned. Otherwise, only the indicated fields will be populated in a response.

Responses

200

The request was successful. List of orders with details are returned.

400

Request was syntactically incorrect. Any details will be provided within the response payload.

403

Access forbidden. The caller is not allowed to access this resource.

500

Some server side error occurred.

get/{tenant}/salesorders

Request samples

Response samples

application/json

[{"id": "orderId123456",
"metadata": {"mixins": {"additionalCode": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/example-schema.json"
}
},
"mixins": {"additionalCode": {"code": "DFG-334-98330-X"
}
},
"created": "2014-03-31T10:18:21.134Z",
"completed": "2014-04-15T10:18:21.134Z",
"status": "COMPLETED",
"siteCode": "Germany",
"countryCode": "DE",
"deliveryWindowId": "5d230f973f05e303d5c30dba",
"orderCycle": "2014-04-12T14:00:00.000Z",
"channel": {"name": "Pinterest",
"source": "https://www.pinterest.com/pin/123456"
},
"entries": [{"id": "5c13ccdbba93e00008b8d274",
"amount": 2,
"orderedAmount": 2,
"originalAmount": 450,
"originalPrice": 450,
"unitPrice": 420,
"totalPrice": 840,
"authorizedAmount": 840,
"link": "https://api.emporix.io/product/mytenant/products/5c13ccdbba93e00008b8d274",
"product": {"description": "A mug you've always wanted !",
"name": "Mug",
"sku": "mug-product",
"published": true,
"images": [{"id": "media123456",
"url": "https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"
}
]
}
},
{"id": "1234547",
"amount": 5,
"orderedAmount": 5,
"originalAmount": 250,
"originalPrice": 450,
"unitPrice": 240,
"totalPrice": 1200,
"authorizedAmount": 1200,
"product": {"metadata": {"mixins": {"color": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/color_v1.json"
}
},
"description": "A Shirt you've always wanted !",
"name": "Shirt",
"sku": "shirt-product",
"published": true,
"images": [{"id": "media1234567",
"url": "https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"
}
],
"mixins": {"color": {"red": 234,
"green": 231,
"blue": 123
}
}
}
}
],
"discounts": [{"code": "SUMMER_SALE",
"name": "Summer Sale 10% off everything",
"amount": 204,
"currency": "USD",
"discountRate": 10,
"sequenceId": 1,
"link": {"id": "B2TD3JM",
"type": "y-coupon",
"url": "https://api.emporix.io/coupon/mytenant/coupons/ENG2OC"
}
}
],
"customer": {"id": "C1234567890",
"title": "Dr.",
"name": "Example Buyer",
"firstName": "Example",
"lastName": "Buyer",
"email": "noreply@emporix.com",
"company": "emporix"
},
"billingAddress": {"contactName": "Example Buyer",
"street": "Nymphenburger Str.",
"streetNumber": "86",
"city": "Munich",
"state": "Bavaria",
"country": "Germany",
"zipCode": "132 45",
"contactPhone": "+49 1111 222 333"
},
"shippingAddress": {"contactName": "Joe Smith",
"companyName": "Cargo Services Airfreight",
"street": "Cheng Xiang Zhen Guan Tang Lu",
"streetNumber": "1031",
"extraLine1": "No. 2058",
"extraLine2": "Suzhou City",
"zipCode": "201202",
"city": "Taicang City",
"state": "Jiangsu Province",
"country": "CN",
"contactPhone": "+86 182 9349 4663",
"metadata": {"mixins": {"secondaryContactPhone": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/contact-number.json"
}
},
"mixins": {"secondaryContactPhone": {"number": "+86 334 0033 9934"
}
}
},
"subTotalPrice": 1881,
"totalPrice": 2041,
"totalAuthorizedAmount": 2041,
"currency": "USD",
"payments": [{"status": "SUCCESS",
"method": "STRIPE",
"paymentResponse": "",
"paidAmount": 2041,
"currency": "USD"
}
],
"tax": {"total": {"amount": 150,
"currency": "USD",
"inclusive": false
},
"lines": [{"amount": 150,
"currency": "USD",
"code": "VAT",
"name": "Regular VAT",
"rate": 10,
"taxable": 1500,
"sequenceId": 1,
"inclusive": false
}
]
},
"shipping": {"total": {"amount": 11.9,
"currency": "USD"
},
"lines": [{"amount": 10,
"currency": "USD",
"code": "dhlstd",
"name": "DHL Standard",
"localizedName": {"en": "DHL Standard",
"de": "DHL Standard"
},
"tax": {"total": {"amount": 1.9,
"currency": "USD",
"inclusive": false
},
"rate": 19
}
}
]
},
"shipments": [{"trackingNumber": "123987456",
"carrier": "UPS",
"shippedDate": "2016-06-25T16:22:52.966Z",
"expectDeliveryOn": "2016-06-27"
}
]
},
{"id": "orderId123457",
"created": "2015-02-11T03:12:33.345Z",
"status": "CREATED",
"deliveryWindowId": "5d230f973f05e303d5c30dba",
"siteCode": "Germany",
"countryCode": "DE",
"channel": {"name": "Twitter",
"source": "https://twitter.com/emporix/status/707599225782214656"
},
"entries": [{"metadata": {"mixins": {"additionalCode": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/example-schema.json"
}
},
"id": "5c13ccdbba93e00008b8d274",
"amount": 1,
"unitPrice": 420,
"totalPrice": 420,
"authorizedAmount": 420,
"link": "https://api.emporix.io/product/mytenant/products/5c13ccdbba93e00008b8d274",
"product": {"description": "A mug you've always wanted !",
"name": "Mug",
"sku": "mug-product",
"published": true,
"images": [{"id": "media123456",
"url": "https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"
}
]
},
"mixins": {"additionalCode": {"code": "ABC"
}
}
}
],
"customer": {"id": "C1234567890",
"title": "Dr.",
"name": "Example Buyer",
"firstName": "Example",
"lastName": "Buyer",
"email": "noreply@emporix.com",
"company": "emporix",
"metadata": {"mixins": {"work_phone": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/contact-number.json"
}
},
"mixins": {"work_phone": {"number": "+86 334 0033 9934"
}
}
},
"billingAddress": {"contactName": "Example Buyer",
"street": "Nymphenburger Str.",
"streetNumber": "86",
"city": "Munich",
"state": "Bavaria",
"country": "DE",
"zipCode": "132 45",
"contactPhone": "+49 1111 222 333"
},
"shippingAddress": {"contactName": "Joe Smith",
"companyName": "Cargo Services Airfreight",
"street": "Cheng Xiang Zhen Guan Tang Lu",
"streetNumber": "1031",
"extraLine1": "No. 2058",
"extraLine2": "Suzhou City",
"zipCode": "201202",
"city": "Taicang City",
"state": "Jiangsu Province",
"country": "CN",
"contactPhone": "+86 182 9349 4663",
"metadata": {"mixins": {"secondaryContactPhone": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/contact-number.json"
}
},
"mixins": {"secondaryContactPhone": {"number": "+86 334 0033 9934"
}
}
},
"totalPrice": 420,
"totalAuthorizedAmount": 420,
"currency": "USD",
"quoteId": "Q10000160"
}
]

Creating a new order

Creates an order by the tenant's employee, on behalf of a customer.

Note: The entries.originalAmount is DEPRECATED. Use the entries.originalPrice field instead.

Required scopes

order.order_create

SecurityOAuth2

Request

path Parameters

tenant

required

string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

Request Body schema: application/json

status	string (orderStatus) Status of the order. Supported order statuses are `IN_CHECKOUT`, `CREATED`, `CONFIRMED`, `DECLINED`, `SHIPPED`, `COMPLETED`'. Customers can only change the order status from `CREATED` to `DECLINED`. Enum: "IN_CHECKOUT" "CREATED" "CONFIRMED" "DECLINED" "SHIPPED" "COMPLETED"
	Array of objects (Order entry) Ordered item list.
	Array of objects (Discount) Discount list.
	object (Customer) Customer data.
siteCode	string Site’s unique identifier. A site is a specific shop.
countryCode	string Two-letter country code, compliant with the ISO 3166 standard.
	object (Adress) Customer's address.
	object (Adress) Customer's address.
	Array of objects (Payment) Payment list.
	object (Shipping) Shipping details.
	object (Tax) Tax details.
subTotalPrice	number Order sub total price.
totalPrice	number Order total price.
totalAuthorizedAmount	number The authorized amount.
currency	string Three-letter currency code, compliant with the ISO 4217 standard.
orderCycle	string Order cycle date. NOTE This attribute is DEPRECATED, please use the `deliveryWindow.deliveryCycle` attribute
deliveryWindowId	string Delivery window's unique identifier. NOTE This attribute is DEPRECATED, please use the `deliveryWindow.id` attribute
	object (Delivery Window)
	object (Metadata DTO)
mixins	object
	object (Channel)
quoteId	string Identifier of the quote from which the order has been created

Responses

201

The collection resource has been successfully created.

400

Request syntactically incorrect. Any details will be provided within the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

409

Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.

500

Some server side error occurred.

post/{tenant}/salesorders

Request samples

application/json

{"entries": [{"id": "5c336893a981210009900071",
"itemYrn": "urn:yaas:saasag:caasproduct:product:mytenant;5c336893a981210009900071",
"amount": 3,
"orderedAmount": 3,
"effectiveQuantity": 3,
"originalAmount": 34.9,
"originalPrice": 34.9,
"unitPrice": 34.9,
"measurementUnit": {"value": 1,
"unit": "H87"
},
"totalPrice": 104.7,
"authorizedAmount": 104.7,
"product": {"metadata": {"mixins": {"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/v1560527845/schemata/CAAS/productCustomAttributesMixIn-v38.json",
"productBundle": "https://res.cloudinary.com/saas-ag/raw/upload/llproductdata/productBundleMixIn.v5.json",
"salePricesData": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/salePriceData.json"
}
},
"id": "5c336893a981210009900071",
"sku": "A705121365",
"name": "Moët & Chandon Impérial Brut Champagner 0,375 l Flasche",
"description": "Der Moët & Chandon Impérial ist der gelungenste Ausdruck des typischen Stils des Hauses. Ein lebhafter und generöser Champagner, der sich durch seine ausgeprägte Frucht, verführerische Gaumennote sowie durch eine elegante Reife auszeichnet.",
"published": true,
"images": [{"id": "8c135ce0-3c5c-4c86-9052-ba2ad2f761cc",
"url": "https://res.cloudinary.com/saas-ag/image/upload/v1546872983/mytenant/products/8c135ce0-3c5c-4c86-9052-ba2ad2f761cc.jpg",
"stored": false
}
],
"mixins": {"productCustomAttributes": {"activeTab": "CrossSellings",
"brand": "59db24c530d7de000e47ba9c",
"categoryPath": {"categoryLevel1": "getraenke-weine",
"categoryLevel2": "weine",
"prettyName": "moët-chandon-impérial-brut-champagner-0375-l-flasche",
"categoryLevel3": ""
},
"containsAlcohol": true,
"crossSellings": ["5c333885a9812100098ff7c3",
"5c333aa3a9812100098ff821",
"5c33570aa9812100098ffd36",
"5c334d22a9812100098ffb83"
],
"defaultOrderQuantity": 1,
"deposit": 0,
"deposits": ["59d6216289e840000ead05fb"
],
"inStock": true,
"lastModifiedDate": "1546873061413",
"lmiv": {"alcoholConcentration": "12",
"foodBusinessOperator": "<p>Moët Hennessy Deutschland GmbH, Seidlstr. 23, 80335 München<br/></p>"
},
"maxOrderQuantity": 25,
"minOrderQuantity": 1,
"orderUnit": "H87",
"originCountry": "59db258c30d7de000e47bb21",
"originRegion": "Champagne",
"packagingDescription": "Glasflasche",
"packagingGroup": "2_Standard",
"packagingPosition": "1_Unten_unempfindlich",
"packagingUnit": "0,375 l Flasche",
"pricingMeasure": {"unitCode": "H87",
"value": 1
},
"pricingMeasurePrice": 34.9,
"productState": "ok",
"surcharge": "XXnnsv4m3a8BeRnk50YfQA==",
"taxClass": "FULL",
"unitPricingBaseMeasure": {"unitCode": "LTR",
"value": 1
},
"unitPricingMeasure": {"unitCode": "MLT",
"value": 375
},
"cutting": [ ],
"labels": [ ],
"servicePackaging": [ ],
"longDescription": "",
"lmivDescription": "",
"lastModifiedUser": ""
},
"salePricesData": {"salePrices": [{"salePriceAmount": 30.9,
"salePriceEnd": "2020-03-01T23:59:00.000+0000",
"salePriceStart": "2020-02-27T00:00:00.000+0000"
}
]
}
}
},
"price": {"priceId": "5c3368958232760008f1df0b",
"productId": "5c336893a981210009900071",
"yrn": "urn:yaas:hybris:price:price:mytenant;5c3368958232760008f1df0b",
"siteCode": "main",
"currency": "EUR",
"originalAmount": 34.9,
"effectiveAmount": 34.9,
"measurementUnit": {"unitCode": "H87",
"quantity": 1
},
"basePrice": {"effectiveAmount": 93.0666666667,
"originalAmount": 93.0666666667,
"measurementUnit": {"unitCode": "LTR",
"quantity": 1
}
},
"presentationPrice": {"effectiveAmount": 34.9,
"originalAmount": 34.9,
"measurementUnit": {"unitCode": "H87",
"quantity": 1
}
},
"metadata": {"createdAt": "2019-01-07T14:57:42.988Z",
"modifiedAt": "2021-04-08T11:53:18.825Z",
"version": 17
}
},
"totalDiscount": {"currency": "EUR"
},
"metadata": {"mixins": {"cartItemOptions": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/cartItemOptionsMixIn.v2.json",
"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/v1560527845/schemata/CAAS/productCustomAttributesMixIn-v38.json",
"fees": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
}
},
"mixins": {"cartItemOptions": { },
"productCustomAttributes": { },
"fees": {"elements": [{"yrn": "urn:yaas:saasag:fee:fee:mytenant;59d6216289e840000ead05fb",
"taxCode": "ZERO",
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
],
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
}
}
],
"discounts": [ ],
"customer": {"id": "C6193791300",
"name": "Anna Schmit",
"title": "MRS",
"firstName": "Anna",
"lastName": "Schmit",
"email": "anna.schmit@schmit.com",
"metadata": {"mixins": {"generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/customerGeneralAttributesMixIn.v4.json",
"backofficeAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/accountBoMixIn.v3.json",
"payment": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/paymentMixIn.v3.json",
"marketing": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/accountMarketingMixIn.v4.json",
"administration": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/administrativeMixIn.v4.json",
"deliveryOptions": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryOptionsMixIn.v6.json"
}
},
"mixins": {"generalAttributes": {"lastDeliveryAddress": "a2cb0ce944",
"invoiceNotDeliveryAddress": false,
"birthday": "7.7.1972",
"mobilePhone": "608232233",
"contactPhone": "608232233",
"customerType": "private",
"customerNumber": "K701141"
},
"backofficeAttributes": {"country": "DE"
},
"payment": {"paymentType": "paymentByCash",
"paymentCosts": 0,
"paymentByDebit": {"bankAccountOwner": "",
"iban": "",
"bankName": ""
}
},
"marketing": { },
"administration": {"creationDate": "2020-12-08T13:39:45.813Z"
},
"deliveryOptions": {"substituteProduct": true,
"packaging": "Paper",
"hint": "",
"pickup": false,
"pickupAddress": {"id": "Pickup 1",
"street": "Fabrikstr",
"streetNumber": "5.",
"city": "Cham",
"zipCode": "6033",
"companyName": "SaaS test AG",
"country": "DE",
"addressName": "Fabrikstr. 5.",
"description": "test description for multiple pickup points",
"addressTag": "pickupAddress"
}
}
}
},
"siteCode": "main",
"countryCode": "DE",
"billingAddress": {"contactName": "Anna Schmit",
"street": "Maximilianstrasse",
"streetNumber": "55",
"streetAppendix": "",
"zipCode": "70173",
"city": "Stuttgart-Mitte",
"country": "DE",
"metadata": {"mixins": {"customAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/addressMixIn.v4.json"
}
},
"mixins": {"customAttributes": {"title": "MRS",
"firstName": "Anna",
"lastName": "Schmit",
"birthday": "7.7.1972"
}
}
},
"shippingAddress": {"contactName": "Anna Schmit",
"street": "Maximilianstrasse",
"streetNumber": "55",
"streetAppendix": "",
"zipCode": "70173",
"city": "Stuttgart-Mitte",
"country": "DE",
"metadata": {"mixins": {"customAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/addressMixIn.v4.json"
}
},
"mixins": {"customAttributes": {"title": "MRS",
"firstName": "Anna",
"lastName": "Schmit",
"birthday": "7.7.1972"
}
}
},
"payments": [{"status": "PENDING",
"method": "cash-on-delivery",
"paidAmount": 0,
"currency": "EUR"
}
],
"shipping": {"total": {"amount": 20,
"currency": "EUR"
},
"lines": [{"amount": 20,
"currency": "EUR",
"code": "4-more_hours_timeframe",
"tax": {"total": {"amount": 0,
"currency": "USD",
"inclusive": false
},
"rate": 0
},
"shippingTaxCode": "ZERO"
}
]
},
"tax": {"total": {"amount": 0,
"currency": "EUR",
"inclusive": false
}
},
"subTotalPrice": 104.7,
"totalPrice": 124.7,
"totalAuthorizedAmount": 124.7,
"currency": "EUR",
"metadata": {"mixins": {"deliveryTime": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryTimeMixIn.v2.json",
"payment": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/paymentMixIn.v3.json",
"deliveryOptions": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryOptionsMixIn.v6.json",
"generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/orderGeneralAttributesMixIn.v9.json",
"payments": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
},
"version": 1
},
"mixins": {"deliveryTime": {"replace": false,
"deliveryDate": "2021-12-09T12:00:00.000Z",
"deliveryTimeFrom": "15:00",
"deliveryTimeTo": "22:00",
"deliveryCosts": 20,
"pickupSettings": "Fabrikstr. 5.",
"deliveryTimeId": "5b5572a7f19a51001ad55509"
},
"payment": {"paymentType": "paymentByCash",
"paymentCosts": 0,
"paymentByDebit": {"bankAccountOwner": "",
"iban": "",
"bankName": ""
}
},
"deliveryOptions": {"substituteProduct": true,
"packaging": "Paper",
"hint": "",
"pickup": false,
"pickupAddress": {"id": "Pickup 1",
"street": "Fabrikstr",
"streetNumber": "5.",
"city": "Cham",
"zipCode": "6033",
"companyName": "SaaS test AG",
"country": "DE",
"addressName": "Fabrikstr. 5.",
"description": "test description for multiple pickup points",
"addressTag": "pickupAddress"
}
},
"generalAttributes": {"extendedOrderStatus": "10",
"orderType": "CUSTOMER_ORDER",
"customerFirstOrder": false,
"orderNumber": "B7022093"
},
"payments": {"elements": [{"paymentMethodYrn": "urn:yaas:hybris:payments:payment-method:mytenant;cash-on-delivery",
"fees": {"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
},
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
],
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
},
"orderCycle": "2021-12-09T12:00:00.000Z",
"deliveryWindowId": "5b5572a7f19a51001ad55509",
"deliveryWindow": {"id": "5b5572a61cf31a000f31eee4",
"deliveryDate": "2023-06-06",
"slotId": "5678-8756-3321-1234",
"deliveryTimeRange": {"timeFrom": "06:00:00",
"timeTo": "09:00:00"
},
"deliveryCycle": "2021-12-09-11-test"
},
"quoteId": "Q10000160",
"channel": { }
}

Response samples

application/json

{"id": "1234546",
"link": "https://api.emporix.io/order/mytenant/salesorders/1234546"
}

Retrieving the number of orders

Retrieves the number of orders for the specified query and siteCode. To be used by tenant's employees.

Required scopes

order.order_read

SecurityOAuth2

Request

path Parameters

tenant

required

string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

query Parameters

string

A standard query parameter is used to search for specific values.

Searching for an item by string property: q=currency:USD where currency is the name of string field and USD is its required value.
Searching for items by number-based property:
- Searching for items with specific value: q=tax.total.amount:20
- Searching for items with value greater than: q=tax.total.amount:>20
- Searching for items with value lower than: q=tax.total.amount:<20
- Searching for items with value greater or equal than: q=tax.total.amount:>=20
- Searching for items with value lower or equal than: q=tax.total.amount:<=20
- Searching for items with within a range of values: q=tax.total.amount:(>=10 AND <=20)
  where tax.total.amount is name of number-based field and 20 is it's querying value.
Searching for items by date property. All numer-based property queries are valid also for dates. In that case the date should be placed within double quotes: q=created:(>="2021-05-18T07:27:27.455Z" AND <"2021-05-20T07:27:27.455Z")
Searching for items by boolean value: q=customer.mixins.generalAttributes.invoiceNotDeliveryAddress:true where customer.mixins.generalAttributes.invoiceNotDeliveryAddress is a name of boolean field and 'true' is it`s required value.
Searching for items with non existing or empty property: q=billingAddress.contactPhone:null where billingAddress.contactPhone is a name of fields that has value null.
Searching for items with existing property: q=mixin:exists where mixin is a name of field that has non null value.
Searching for items by multiple specific values: q=id:(order_id1,order_id2) where id is name of field and strings within a bracket are it's required value.
Searching for items by multiple fields: q=id:order_id1 status:COMPLETED where id and status are the names of fields. All documents that contain given values of these fields are returned. Multiple fields separated by space can be specified. Multiple values for each field can be also specified in a format presented above.

Example: q=currency:USD

Responses

200

The request was successful. Number of orders returned in header.

400

Request syntactically incorrect. Any details will be provided within the response payload.

403

Access forbidden. The caller is not allowed to access this resource.

500

Some server side error occurred.

head/{tenant}/salesorders

Request samples

Response samples

application/json

{"status": 400,
"message": "There are validation problems, see details section for more information",
"type": "validation_violation",
"details": [{"field": "client-owner",
"message": "must be between 3 and 16 characters",
"type": "invalid_header"
}
]
}

Retrieving a specific order by ID

Retrieves a specific order by order ID. To be used by tenant's employees.

Required scopes

order.order_read

SecurityOAuth2

Request

path Parameters

orderId required	string Unique identifier of an order.
tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ The tenant that the caller is acting upon. Please note that this value is always lowercase.

Responses

200

The request was successful. Given order details are returned.

403

Access forbidden. The caller is not allowed to access this resource.

404

Order does not exist

500

Some server side error occurred.

get/{tenant}/salesorders/{orderId}

Request samples

Response samples

application/json

{"id": "orderId123456",
"metadata": {"mixins": {"additionalCode": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/example-schema.json"
}
},
"mixins": {"additionalCode": {"code": "DFG-334-98330-X"
}
},
"created": "2014-03-31T10:18:21.134Z",
"completed": "2014-04-15T10:18:21.134Z",
"status": "COMPLETED",
"siteCode": "Germany",
"countryCode": "DE",
"deliveryWindowId": "5d230f973f05e303d5c30dba",
"channel": {"name": "Pinterest",
"source": "https://www.pinterest.com/pin/123456"
},
"entries": [{"id": "5c13ccdbba93e00008b8d274",
"amount": 2,
"originalAmount": 450,
"unitPrice": 420,
"totalPrice": 840,
"authorizedAmount": 840,
"link": "https://api.emporix.io/product/mytenant/products/5c13ccdbba93e00008b8d274",
"product": {"description": "A mug you've always wanted !",
"name": "Mug",
"sku": "mug-product",
"published": true,
"images": [{"id": "media123456",
"url": "https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"
}
]
}
},
{"id": "1234547",
"amount": 5,
"originalAmount": 250,
"unitPrice": 240,
"totalPrice": 1200,
"authorizedAmount": 1200,
"product": {"metadata": {"mixins": {"color": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/color_v1.json"
}
},
"description": "A Shirt you've always wanted !",
"name": "Shirt",
"sku": "shirt-product",
"published": true,
"images": [{"id": "media1234567",
"url": "https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"
}
],
"mixins": {"color": {"red": 234,
"green": 231,
"blue": 123
}
}
}
}
],
"discounts": [{"code": "SUMMER_SALE",
"name": "Summer Sale 10% off everything",
"amount": 204,
"currency": "USD",
"discountRate": 10,
"sequenceId": 1,
"link": {"id": "B2TD3JM",
"type": "y-coupon",
"url": "https://api.emporix.io/coupon/mytenant/coupons/ENG2OC"
}
}
],
"customer": {"id": "C1234567890",
"title": "Dr.",
"name": "Example Buyer",
"firstName": "Example",
"lastName": "Buyer",
"email": "noreply@emporix.com",
"company": "emporix"
},
"billingAddress": {"contactName": "Example Buyer",
"street": "Nymphenburger Str.",
"streetNumber": "86",
"city": "Munich",
"state": "Bavaria",
"country": "Germany",
"zipCode": "132 45",
"contactPhone": "+49 1111 222 333"
},
"shippingAddress": {"contactName": "Joe Smith",
"companyName": "Cargo Services Airfreight",
"street": "Cheng Xiang Zhen Guan Tang Lu",
"streetNumber": "1031",
"extraLine1": "No. 2058",
"extraLine2": "Suzhou City",
"zipCode": "201202",
"city": "Taicang City",
"state": "Jiangsu Province",
"country": "CN",
"contactPhone": "+86 182 9349 4663",
"metadata": {"mixins": {"secondaryContactPhone": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/contact-number.json"
}
},
"mixins": {"secondaryContactPhone": {"number": "+86 334 0033 9934"
}
}
},
"subTotalPrice": 1881,
"totalPrice": 2041,
"totalAuthorizedAmount": 2041,
"currency": "USD",
"payments": [{"status": "SUCCESS",
"method": "STRIPE",
"paymentResponse": "",
"paidAmount": 2041,
"currency": "USD"
}
],
"tax": {"total": {"amount": 150,
"currency": "USD",
"inclusive": false
},
"lines": [{"amount": 150,
"currency": "USD",
"code": "VAT",
"name": "Regular VAT",
"rate": 10,
"taxable": 1500,
"sequenceId": 1,
"inclusive": false
}
]
},
"shipping": {"total": {"amount": 11.9,
"currency": "USD"
},
"lines": [{"amount": 10,
"currency": "USD",
"code": "dhlstd",
"name": "DHL Standard",
"localizedName": {"en": "DHL Standard",
"de": "DHL Standard"
},
"tax": {"total": {"amount": 1.9,
"currency": "USD",
"inclusive": false
},
"rate": 19
}
}
]
},
"shipments": [{"trackingNumber": "123987456",
"carrier": "UPS",
"shippedDate": "2016-06-25T16:22:52.966Z",
"expectDeliveryOn": "2016-06-27"
}
],
"quoteId": "Q10000160"
}

Updating an order

Updates an order with the specified order ID. To be used by tenant's employees.

Required scopes

order.order_update
order.order_update_completed - for updating orders with a completed status

SecurityOAuth2

Request

path Parameters

orderId required	string Unique identifier of an order.
tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ The tenant that the caller is acting upon. Please note that this value is always lowercase.

query Parameters

recalculate

boolean

Default: false

Flag that enforces order recalculation. If set to true, the whole order, including the coupon discounts, will be recalculated.

Request Body schema: application/json

status	string (orderStatus) Status of the order. Supported order statuses are `IN_CHECKOUT`, `CREATED`, `CONFIRMED`, `DECLINED`, `SHIPPED`, `COMPLETED`'. Customers can only change the order status from `CREATED` to `DECLINED`. Enum: "IN_CHECKOUT" "CREATED" "CONFIRMED" "DECLINED" "SHIPPED" "COMPLETED"
	Array of objects (Order entry) Ordered item list.
	Array of objects (Discount) Discount list.
	object (Customer) Customer data.
siteCode	string Site’s unique identifier. A site is a specific shop.
countryCode	string Two-letter country code, compliant with the ISO 3166 standard.
	object (Adress) Customer's address.
	object (Adress) Customer's address.
	Array of objects (Payment) Payment list.
	object (Shipping) Shipping details.
	object (Tax) Tax details.
subTotalPrice	number Order sub total price.
totalPrice	number Order total price.
totalAuthorizedAmount	number The authorized amount.
currency	string Three-letter currency code, compliant with the ISO 4217 standard.
orderCycle	string Order cycle date. NOTE This attribute is DEPRECATED, please use the `deliveryWindow.deliveryCycle` attribute
deliveryWindowId	string Delivery window's unique identifier. NOTE This attribute is DEPRECATED, please use the `deliveryWindow.id` attribute
	object (Delivery Window)
	object (Metadata DTO)
mixins	object
	object (Channel)
created	string Order's creation date.
completed	string Order's completion date.
lastStatusChange	string Order last status change date.
	Array of objects (Shipment) Shipment list.

Responses

204

Successful order update

400

Request syntactically incorrect. Any details will be provided within the response payload.

403

Access forbidden. The caller is not allowed to access this resource.

404

Order does not exist

409

Optimistic locking failed. User sends metadata/version attribute which is outdated (someone else updated order in the time user was performing his changes). User should retrieve the latest order data and retry the request.

500

Some server side error occurred.

put/{tenant}/salesorders/{orderId}

Request samples

application/json

{"entries": [{"id": "5c336893a981210009900071",
"itemYrn": "urn:yaas:saasag:caasproduct:product:mytenant;5c336893a981210009900071",
"amount": 3,
"orderedAmount": 3,
"effectiveQuantity": 3,
"originalAmount": 34.9,
"originalPrice": 34.9,
"unitPrice": 34.9,
"measurementUnit": {"value": 1,
"unit": "H87"
},
"totalPrice": 104.7,
"authorizedAmount": 104.7,
"product": {"metadata": {"mixins": {"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/v1560527845/schemata/CAAS/productCustomAttributesMixIn-v38.json",
"productBundle": "https://res.cloudinary.com/saas-ag/raw/upload/llproductdata/productBundleMixIn.v5.json",
"salePricesData": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/salePriceData.json"
}
},
"id": "5c336893a981210009900071",
"sku": "A705121365",
"name": "Moët & Chandon Impérial Brut Champagner 0,375 l Flasche",
"description": "Der Moët & Chandon Impérial ist der gelungenste Ausdruck des typischen Stils des Hauses. Ein lebhafter und generöser Champagner, der sich durch seine ausgeprägte Frucht, verführerische Gaumennote sowie durch eine elegante Reife auszeichnet.",
"published": true,
"images": [{"id": "8c135ce0-3c5c-4c86-9052-ba2ad2f761cc",
"url": "https://res.cloudinary.com/saas-ag/image/upload/v1546872983/mytenant/products/8c135ce0-3c5c-4c86-9052-ba2ad2f761cc.jpg",
"stored": false
}
],
"mixins": {"productCustomAttributes": {"activeTab": "CrossSellings",
"brand": "59db24c530d7de000e47ba9c",
"categoryPath": {"categoryLevel1": "getraenke-weine",
"categoryLevel2": "weine",
"prettyName": "moët-chandon-impérial-brut-champagner-0375-l-flasche",
"categoryLevel3": ""
},
"containsAlcohol": true,
"crossSellings": ["5c333885a9812100098ff7c3",
"5c333aa3a9812100098ff821",
"5c33570aa9812100098ffd36",
"5c334d22a9812100098ffb83"
],
"defaultOrderQuantity": 1,
"deposit": 0,
"deposits": ["59d6216289e840000ead05fb"
],
"inStock": true,
"lastModifiedDate": "1546873061413",
"lmiv": {"alcoholConcentration": "12",
"foodBusinessOperator": "<p>Moët Hennessy Deutschland GmbH, Seidlstr. 23, 80335 München<br/></p>"
},
"maxOrderQuantity": 25,
"minOrderQuantity": 1,
"orderUnit": "H87",
"originCountry": "59db258c30d7de000e47bb21",
"originRegion": "Champagne",
"packagingDescription": "Glasflasche",
"packagingGroup": "2_Standard",
"packagingPosition": "1_Unten_unempfindlich",
"packagingUnit": "0,375 l Flasche",
"pricingMeasure": {"unitCode": "H87",
"value": 1
},
"pricingMeasurePrice": 34.9,
"productState": "ok",
"surcharge": "XXnnsv4m3a8BeRnk50YfQA==",
"taxClass": "FULL",
"unitPricingBaseMeasure": {"unitCode": "LTR",
"value": 1
},
"unitPricingMeasure": {"unitCode": "MLT",
"value": 375
},
"cutting": [ ],
"labels": [ ],
"servicePackaging": [ ],
"longDescription": "",
"lmivDescription": "",
"lastModifiedUser": ""
},
"salePricesData": {"salePrices": [{"salePriceAmount": 30.9,
"salePriceEnd": "2020-03-01T23:59:00.000+0000",
"salePriceStart": "2020-02-27T00:00:00.000+0000"
}
]
}
}
},
"price": {"priceId": "5c3368958232760008f1df0b",
"productId": "5c336893a981210009900071",
"yrn": "urn:yaas:hybris:price:price:mytenant;5c3368958232760008f1df0b",
"siteCode": "main",
"currency": "EUR",
"originalAmount": 34.9,
"effectiveAmount": 34.9,
"measurementUnit": {"unitCode": "H87",
"quantity": 1
},
"basePrice": {"effectiveAmount": 93.0666666667,
"originalAmount": 93.0666666667,
"measurementUnit": {"unitCode": "LTR",
"quantity": 1
}
},
"presentationPrice": {"effectiveAmount": 34.9,
"originalAmount": 34.9,
"measurementUnit": {"unitCode": "H87",
"quantity": 1
}
},
"metadata": {"createdAt": "2019-01-07T14:57:42.988Z",
"modifiedAt": "2021-04-08T11:53:18.825Z",
"version": 17
}
},
"totalDiscount": {"currency": "EUR"
},
"metadata": {"mixins": {"cartItemOptions": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/cartItemOptionsMixIn.v2.json",
"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/v1560527845/schemata/CAAS/productCustomAttributesMixIn-v38.json",
"fees": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
}
},
"mixins": {"cartItemOptions": { },
"productCustomAttributes": { },
"fees": {"elements": [{"yrn": "urn:yaas:saasag:fee:fee:mytenant;59d6216289e840000ead05fb",
"taxCode": "ZERO",
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
],
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
}
}
],
"discounts": [ ],
"customer": {"id": "C6193791300",
"name": "Anna Schmit",
"title": "MRS",
"firstName": "Anna",
"lastName": "Schmit",
"email": "anna.schmit@schmit.com",
"metadata": {"mixins": {"generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/customerGeneralAttributesMixIn.v4.json",
"backofficeAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/accountBoMixIn.v3.json",
"payment": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/paymentMixIn.v3.json",
"marketing": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/accountMarketingMixIn.v4.json",
"administration": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/administrativeMixIn.v4.json",
"deliveryOptions": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryOptionsMixIn.v6.json"
}
},
"mixins": {"generalAttributes": {"lastDeliveryAddress": "a2cb0ce944",
"invoiceNotDeliveryAddress": false,
"birthday": "7.7.1972",
"mobilePhone": "608232233",
"contactPhone": "608232233",
"customerType": "private",
"customerNumber": "K701141"
},
"backofficeAttributes": {"country": "DE"
},
"payment": {"paymentType": "paymentByCash",
"paymentCosts": 0,
"paymentByDebit": {"bankAccountOwner": "",
"iban": "",
"bankName": ""
}
},
"marketing": { },
"administration": {"creationDate": "2020-12-08T13:39:45.813Z"
},
"deliveryOptions": {"substituteProduct": true,
"packaging": "Paper",
"hint": "",
"pickup": false,
"pickupAddress": {"id": "Pickup 1",
"street": "Fabrikstr",
"streetNumber": "5.",
"city": "Cham",
"zipCode": "6033",
"companyName": "SaaS test AG",
"country": "DE",
"addressName": "Fabrikstr. 5.",
"description": "test description for multiple pickup points",
"addressTag": "pickupAddress"
}
}
}
},
"siteCode": "main",
"countryCode": "DE",
"billingAddress": {"contactName": "Anna Schmit",
"street": "Eichendorffweg",
"streetNumber": "5",
"streetAppendix": "",
"zipCode": "70173",
"city": "Stuttgart-Mitte",
"country": "DE",
"metadata": {"mixins": {"customAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/addressMixIn.v4.json"
}
},
"mixins": {"customAttributes": {"title": "MRS",
"firstName": "Anna",
"lastName": "Schmit",
"birthday": "7.7.1972"
}
}
},
"shippingAddress": {"contactName": "Anna Schmit",
"street": "Eichendorffweg",
"streetNumber": "5",
"streetAppendix": "",
"zipCode": "70173",
"city": "Stuttgart-Mitte",
"country": "DE",
"metadata": {"mixins": {"customAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/addressMixIn.v4.json"
}
},
"mixins": {"customAttributes": {"title": "MRS",
"firstName": "Anna",
"lastName": "Schmit",
"birthday": "7.7.1972"
}
}
},
"payments": [{"status": "PENDING",
"method": "cash-on-delivery",
"paidAmount": 0,
"currency": "EUR"
}
],
"shipping": {"total": {"amount": 20,
"currency": "EUR"
},
"lines": [{"amount": 20,
"currency": "EUR",
"code": "4-more_hours_timeframe",
"tax": {"total": {"amount": 0,
"currency": "USD",
"inclusive": false
},
"rate": 0
},
"shippingTaxCode": "ZERO"
}
]
},
"tax": {"total": {"amount": 0,
"currency": "EUR",
"inclusive": false
}
},
"subTotalPrice": 104.7,
"totalPrice": 124.7,
"totalAuthorizedAmount": 124.7,
"currency": "EUR",
"metadata": {"mixins": {"deliveryTime": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryTimeMixIn.v2.json",
"payment": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/paymentMixIn.v3.json",
"deliveryOptions": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryOptionsMixIn.v6.json",
"generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/orderGeneralAttributesMixIn.v9.json",
"payments": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
},
"version": 1
},
"mixins": {"deliveryTime": {"replace": false,
"deliveryDate": "2021-12-09T12:00:00.000Z",
"deliveryTimeFrom": "15:00",
"deliveryTimeTo": "22:00",
"deliveryCosts": 20,
"pickupSettings": "Fabrikstr. 5.",
"deliveryTimeId": "5b5572a7f19a51001ad55509"
},
"payment": {"paymentType": "paymentByCash",
"paymentCosts": 0,
"paymentByDebit": {"bankAccountOwner": "",
"iban": "",
"bankName": ""
}
},
"deliveryOptions": {"substituteProduct": true,
"packaging": "Paper",
"hint": "",
"pickup": false,
"pickupAddress": {"id": "Pickup 1",
"street": "Fabrikstr",
"streetNumber": "5.",
"city": "Cham",
"zipCode": "6033",
"companyName": "SaaS test AG",
"country": "DE",
"addressName": "Fabrikstr. 5.",
"description": "test description for multiple pickup points",
"addressTag": "pickupAddress"
}
},
"generalAttributes": {"extendedOrderStatus": "10",
"orderType": "CUSTOMER_ORDER",
"customerFirstOrder": false,
"orderNumber": "B7022093"
},
"payments": {"elements": [{"paymentMethodYrn": "urn:yaas:hybris:payments:payment-method:mytenant;cash-on-delivery",
"fees": {"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
},
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
],
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
},
"orderCycle": "2021-12-09T12:00:00.000Z",
"deliveryWindowId": "5b5572a7f19a51001ad55509",
"channel": { },
"deliveryWindow": {"id": "5b5572a61cf31a000f31eee4",
"deliveryDate": "2023-06-06",
"slotId": "5678-8756-3321-1234",
"deliveryTimeRange": {"timeFrom": "06:00:00",
"timeTo": "09:00:00"
},
"deliveryCycle": "2021-12-09-12-express"
}
}

Response samples

application/json

{"status": 400,
"message": "There are validation problems, see details section for more information",
"type": "validation_violation",
"details": [{"field": "client-owner",
"message": "must be between 3 and 16 characters",
"type": "invalid_header"
}
]
}

Partially updating an order

Updates partally an order with the specified order ID. To be used by tenant's employees.

Required scopes

order.order_update
order.order_update_completed - for updating orders with a completed status

SecurityOAuth2

Request

path Parameters

orderId required	string Unique identifier of an order.
tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ The tenant that the caller is acting upon. Please note that this value is always lowercase.

query Parameters

recalculate

boolean

Default: false

Flag that enforces order recalculation. If set to true, the whole order, including the coupon discounts, will be recalculated.

Request Body schema: application/json

status	string (orderStatus) Status of the order. Supported order statuses are `IN_CHECKOUT`, `CREATED`, `CONFIRMED`, `DECLINED`, `SHIPPED`, `COMPLETED`'. Customers can only change the order status from `CREATED` to `DECLINED`. Enum: "IN_CHECKOUT" "CREATED" "CONFIRMED" "DECLINED" "SHIPPED" "COMPLETED"
	Array of objects (Order entry) Ordered item list.
	Array of objects (Discount) Discount list.
	object (Customer) Customer data.
siteCode	string Site’s unique identifier. A site is a specific shop.
countryCode	string Two-letter country code, compliant with the ISO 3166 standard.
	object (Adress) Customer's address.
	object (Adress) Customer's address.
	Array of objects (Payment) Payment list.
	object (Shipping) Shipping details.
	object (Tax) Tax details.
subTotalPrice	number Order sub total price.
totalPrice	number Order total price.
totalAuthorizedAmount	number The authorized amount.
currency	string Three-letter currency code, compliant with the ISO 4217 standard.
orderCycle	string Order cycle date. NOTE This attribute is DEPRECATED, please use the `deliveryWindow.deliveryCycle` attribute
deliveryWindowId	string Delivery window's unique identifier. NOTE This attribute is DEPRECATED, please use the `deliveryWindow.id` attribute
	object (Delivery Window)
	object (Metadata DTO)
mixins	object
	object (Channel)
created	string Order's creation date.
completed	string Order's completion date.
lastStatusChange	string Order last status change date.
	Array of objects (Shipment) Shipment list.

Responses

204

Successful order update

400

Request syntactically incorrect. Any details will be provided within the response payload.

403

Access forbidden. The caller is not allowed to access this resource.

404

Order does not exist

409

500

Some server side error occurred.

patch/{tenant}/salesorders/{orderId}

Request samples

application/json

{"entries": [{"id": "5c336893a981210009900071",
"itemYrn": "urn:yaas:saasag:caasproduct:product:mytenant;5c336893a981210009900071",
"amount": 3,
"orderedAmount": 3,
"effectiveQuantity": 3,
"originalAmount": 34.9,
"originalPrice": 34.9,
"unitPrice": 34.9,
"measurementUnit": {"value": 1,
"unit": "H87"
},
"totalPrice": 104.7,
"authorizedAmount": 104.7,
"product": {"metadata": {"mixins": {"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/v1560527845/schemata/CAAS/productCustomAttributesMixIn-v38.json",
"productBundle": "https://res.cloudinary.com/saas-ag/raw/upload/llproductdata/productBundleMixIn.v5.json",
"salePricesData": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/salePriceData.json"
}
},
"id": "5c336893a981210009900071",
"sku": "A705121365",
"name": "Moët & Chandon Impérial Brut Champagner 0,375 l Flasche",
"description": "Der Moët & Chandon Impérial ist der gelungenste Ausdruck des typischen Stils des Hauses. Ein lebhafter und generöser Champagner, der sich durch seine ausgeprägte Frucht, verführerische Gaumennote sowie durch eine elegante Reife auszeichnet.",
"published": true,
"images": [{"id": "8c135ce0-3c5c-4c86-9052-ba2ad2f761cc",
"url": "https://res.cloudinary.com/saas-ag/image/upload/v1546872983/mytenant/products/8c135ce0-3c5c-4c86-9052-ba2ad2f761cc.jpg",
"stored": false
}
],
"mixins": {"productCustomAttributes": {"activeTab": "CrossSellings",
"brand": "59db24c530d7de000e47ba9c",
"categoryPath": {"categoryLevel1": "getraenke-weine",
"categoryLevel2": "weine",
"prettyName": "moët-chandon-impérial-brut-champagner-0375-l-flasche",
"categoryLevel3": ""
},
"containsAlcohol": true,
"crossSellings": ["5c333885a9812100098ff7c3",
"5c333aa3a9812100098ff821",
"5c33570aa9812100098ffd36",
"5c334d22a9812100098ffb83"
],
"defaultOrderQuantity": 1,
"deposit": 0,
"deposits": ["59d6216289e840000ead05fb"
],
"inStock": true,
"lastModifiedDate": "1546873061413",
"lmiv": {"alcoholConcentration": "12",
"foodBusinessOperator": "<p>Moët Hennessy Deutschland GmbH, Seidlstr. 23, 80335 München<br/></p>"
},
"maxOrderQuantity": 25,
"minOrderQuantity": 1,
"orderUnit": "H87",
"originCountry": "59db258c30d7de000e47bb21",
"originRegion": "Champagne",
"packagingDescription": "Glasflasche",
"packagingGroup": "2_Standard",
"packagingPosition": "1_Unten_unempfindlich",
"packagingUnit": "0,375 l Flasche",
"pricingMeasure": {"unitCode": "H87",
"value": 1
},
"pricingMeasurePrice": 34.9,
"productState": "ok",
"surcharge": "XXnnsv4m3a8BeRnk50YfQA==",
"taxClass": "FULL",
"unitPricingBaseMeasure": {"unitCode": "LTR",
"value": 1
},
"unitPricingMeasure": {"unitCode": "MLT",
"value": 375
},
"cutting": [ ],
"labels": [ ],
"servicePackaging": [ ],
"longDescription": "",
"lmivDescription": "",
"lastModifiedUser": ""
},
"salePricesData": {"salePrices": [{"salePriceAmount": 30.9,
"salePriceEnd": "2020-03-01T23:59:00.000+0000",
"salePriceStart": "2020-02-27T00:00:00.000+0000"
}
]
}
}
},
"price": {"priceId": "5c3368958232760008f1df0b",
"productId": "5c336893a981210009900071",
"yrn": "urn:yaas:hybris:price:price:mytenant;5c3368958232760008f1df0b",
"siteCode": "main",
"currency": "EUR",
"originalAmount": 34.9,
"effectiveAmount": 34.9,
"measurementUnit": {"unitCode": "H87",
"quantity": 1
},
"basePrice": {"effectiveAmount": 93.0666666667,
"originalAmount": 93.0666666667,
"measurementUnit": {"unitCode": "LTR",
"quantity": 1
}
},
"presentationPrice": {"effectiveAmount": 34.9,
"originalAmount": 34.9,
"measurementUnit": {"unitCode": "H87",
"quantity": 1
}
},
"metadata": {"createdAt": "2019-01-07T14:57:42.988Z",
"modifiedAt": "2021-04-08T11:53:18.825Z",
"version": 17
}
},
"totalDiscount": {"currency": "EUR"
},
"metadata": {"mixins": {"cartItemOptions": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/cartItemOptionsMixIn.v2.json",
"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/v1560527845/schemata/CAAS/productCustomAttributesMixIn-v38.json",
"fees": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
}
},
"mixins": {"cartItemOptions": { },
"productCustomAttributes": { },
"fees": {"elements": [{"yrn": "urn:yaas:saasag:fee:fee:mytenant;59d6216289e840000ead05fb",
"taxCode": "ZERO",
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
],
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
}
}
],
"discounts": [ ],
"customer": {"id": "C6193791300",
"name": "Anna Schmit",
"title": "MRS",
"firstName": "Anna",
"lastName": "Schmit",
"email": "anna.schmit@schmit.com",
"metadata": {"mixins": {"generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/customerGeneralAttributesMixIn.v4.json",
"backofficeAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/accountBoMixIn.v3.json",
"payment": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/paymentMixIn.v3.json",
"marketing": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/accountMarketingMixIn.v4.json",
"administration": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/administrativeMixIn.v4.json",
"deliveryOptions": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryOptionsMixIn.v6.json"
}
},
"mixins": {"generalAttributes": {"lastDeliveryAddress": "a2cb0ce944",
"invoiceNotDeliveryAddress": false,
"birthday": "7.7.1972",
"mobilePhone": "608232233",
"contactPhone": "608232233",
"customerType": "private",
"customerNumber": "K701141"
},
"backofficeAttributes": {"country": "DE"
},
"payment": {"paymentType": "paymentByCash",
"paymentCosts": 0,
"paymentByDebit": {"bankAccountOwner": "",
"iban": "",
"bankName": ""
}
},
"marketing": { },
"administration": {"creationDate": "2020-12-08T13:39:45.813Z"
},
"deliveryOptions": {"substituteProduct": true,
"packaging": "Paper",
"hint": "",
"pickup": false,
"pickupAddress": {"id": "Pickup 1",
"street": "Fabrikstr",
"streetNumber": "5.",
"city": "Cham",
"zipCode": "6033",
"companyName": "SaaS test AG",
"country": "DE",
"addressName": "Fabrikstr. 5.",
"description": "test description for multiple pickup points",
"addressTag": "pickupAddress"
}
}
}
},
"siteCode": "main",
"countryCode": "DE",
"billingAddress": {"contactName": "Anna Schmit",
"street": "Eichendorffweg",
"streetNumber": "5",
"streetAppendix": "",
"zipCode": "70173",
"city": "Stuttgart-Mitte",
"country": "DE",
"metadata": {"mixins": {"customAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/addressMixIn.v4.json"
}
},
"mixins": {"customAttributes": {"title": "MRS",
"firstName": "Anna",
"lastName": "Schmit",
"birthday": "7.7.1972"
}
}
},
"shippingAddress": {"contactName": "Anna Schmit",
"street": "Eichendorffweg",
"streetNumber": "5",
"streetAppendix": "",
"zipCode": "70173",
"city": "Stuttgart-Mitte",
"country": "DE",
"metadata": {"mixins": {"customAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/addressMixIn.v4.json"
}
},
"mixins": {"customAttributes": {"title": "MRS",
"firstName": "Anna",
"lastName": "Schmit",
"birthday": "7.7.1972"
}
}
},
"payments": [{"status": "PENDING",
"method": "cash-on-delivery",
"paidAmount": 0,
"currency": "EUR"
}
],
"shipping": {"total": {"amount": 20,
"currency": "EUR"
},
"lines": [{"amount": 20,
"currency": "EUR",
"code": "4-more_hours_timeframe",
"tax": {"total": {"amount": 0,
"currency": "USD",
"inclusive": false
},
"rate": 0
},
"shippingTaxCode": "ZERO"
}
]
},
"tax": {"total": {"amount": 0,
"currency": "EUR",
"inclusive": false
}
},
"subTotalPrice": 104.7,
"totalPrice": 124.7,
"totalAuthorizedAmount": 124.7,
"currency": "EUR",
"metadata": {"mixins": {"deliveryTime": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryTimeMixIn.v2.json",
"payment": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/paymentMixIn.v3.json",
"deliveryOptions": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryOptionsMixIn.v6.json",
"generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/orderGeneralAttributesMixIn.v9.json",
"payments": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
},
"version": 1
},
"mixins": {"deliveryTime": {"replace": false,
"deliveryDate": "2021-12-09T12:00:00.000Z",
"deliveryTimeFrom": "15:00",
"deliveryTimeTo": "22:00",
"deliveryCosts": 20,
"pickupSettings": "Fabrikstr. 5.",
"deliveryTimeId": "5b5572a7f19a51001ad55509"
},
"payment": {"paymentType": "paymentByCash",
"paymentCosts": 0,
"paymentByDebit": {"bankAccountOwner": "",
"iban": "",
"bankName": ""
}
},
"deliveryOptions": {"substituteProduct": true,
"packaging": "Paper",
"hint": "",
"pickup": false,
"pickupAddress": {"id": "Pickup 1",
"street": "Fabrikstr",
"streetNumber": "5.",
"city": "Cham",
"zipCode": "6033",
"companyName": "SaaS test AG",
"country": "DE",
"addressName": "Fabrikstr. 5.",
"description": "test description for multiple pickup points",
"addressTag": "pickupAddress"
}
},
"generalAttributes": {"extendedOrderStatus": "10",
"orderType": "CUSTOMER_ORDER",
"customerFirstOrder": false,
"orderNumber": "B7022093"
},
"payments": {"elements": [{"paymentMethodYrn": "urn:yaas:hybris:payments:payment-method:mytenant;cash-on-delivery",
"fees": {"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
},
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
],
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
},
"orderCycle": "2021-12-09T12:00:00.000Z",
"deliveryWindowId": "5b5572a7f19a51001ad55509",
"channel": { },
"deliveryWindow": {"id": "5b5572a61cf31a000f31eee4",
"deliveryDate": "2023-06-06",
"slotId": "5678-8756-3321-1234",
"deliveryTimeRange": {"timeFrom": "06:00:00",
"timeTo": "09:00:00"
},
"deliveryCycle": "2021-12-09-12-express"
}
}

Response samples

application/json

{"status": 400,
"message": "There are validation problems, see details section for more information",
"type": "validation_violation",
"details": [{"field": "client-owner",
"message": "must be between 3 and 16 characters",
"type": "invalid_header"
}
]
}

Deleting an order

Deletes order with the specified ID. To be used by tenant's employees.

Required scopes

order.order_delete

SecurityOAuth2

Request

path Parameters

orderId required	string Unique identifier of an order.
tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ The tenant that the caller is acting upon. Please note that this value is always lowercase.

Responses

204

Successful deletion

400

Request syntactically incorrect. Any details will be provided within the response payload.

403

Access forbidden. The caller is not allowed to access this resource.

404

Order does not exist

500

Some server side error occurred.

delete/{tenant}/salesorders/{orderId}

Request samples

Response samples

application/json

{"status": 400,
"message": "There are validation problems, see details section for more information",
"type": "validation_violation",
"details": [{"field": "client-owner",
"message": "must be between 3 and 16 characters",
"type": "invalid_header"
}
]
}

Retrieving status transitions for an order

Retrieves all possible status transitions for a specific order. To be used by tenant's employees.

Required scopes

order.order_read
order.order_update
order.order_update_completed - for orders with a completed status

SecurityOAuth2

Request

path Parameters

orderId required	string Unique identifier of an order.
tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ The tenant that the caller is acting upon. Please note that this value is always lowercase.

Responses

200

The request was successful. Status transitions for specific order returned.

400

Request syntactically incorrect. Any details will be provided within the response payload.

403

Access forbidden. The caller is not allowed to access this resource.

404

Order does not exist

500

Some server side error occurred.

get/{tenant}/salesorders/{orderId}/transitions

Request samples

Response samples

application/json

[{"status": "CONFIRMED"
}
]

Updating order status

Updates the status of a specific order. To be used by tenant's employees.

Required scopes

order.order_update
order.order_update_completed - for updating orders with a completed status

SecurityOAuth2

Request

path Parameters

orderId required	string Unique identifier of an order.
tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ The tenant that the caller is acting upon. Please note that this value is always lowercase.

Request Body schema: application/json

status

string (orderStatus)

Status of the order. Supported order statuses are IN_CHECKOUT, CREATED, CONFIRMED, DECLINED, SHIPPED, COMPLETED'. Customers can only change the order status from CREATED to DECLINED.

Enum: "IN_CHECKOUT" "CREATED" "CONFIRMED" "DECLINED" "SHIPPED" "COMPLETED"

Responses

204

The request was successful. Order was succesfully updated.

400

Request syntactically incorrect. Any details will be provided within the response payload.

403

Access forbidden. The caller is not allowed to access this resource.

404

Order does not exist

500

Some server side error occurred.

post/{tenant}/salesorders/{orderId}/transitions

Request samples

application/json

{"status": "DECLINED"
}

Response samples

application/json

{"status": 400,
"message": "There are validation problems, see details section for more information",
"type": "validation_violation",
"details": [{"field": "client-owner",
"message": "must be between 3 and 16 characters",
"type": "invalid_header"
}
]
}

Recalculating number of entries

Updates the number of entries in the specific order and recalculates it. To be used by tenant's employees.

Required scopes

order.order_update
order.order_update_completed - for updating orders with a completed status

SecurityOAuth2

Request

path Parameters

orderId required	string Unique identifier of an order.
tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ The tenant that the caller is acting upon. Please note that this value is always lowercase.

Request Body schema: application/json

Array of objects (Order Calculation DTO)

Order recalculation DTO contains a list of entries, where each entry contains entry ID and delivered amount of items.

Responses

200

Order recalculated successfully

400

Bad Request

403

Access forbidden. The caller is not allowed to access this resource.

404

Order does not exist

500

Some server side error occurred.

post/{tenant}/salesorders/{orderId}/calculations

Request samples

application/json

{"entries": [{"entryId": "5c336893a981210009900071",
"deliveredAmount": 10
},
{"entryId": "5c336893a981210009900072",
"deliveredAmount": 1000,
"unit": "GRM"
}
]
}

Response samples

application/json

{"status": 403,
"message": "Not allowed to access this resource",
"type": "insufficient_permissions"
}

Orders (customer-managed)

Retrieving a list of orders

Retrieves a list of orders for a customer. To be used by customers on the storefront.

Required scopes

order.history_view for logged in customers only.

SecurityOAuth2

Request

path Parameters

tenant

required

string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

query Parameters

sort	string The list of comma-separated properties used to sort the results. By default, the column values are sorted in ascending order. Can either be in the form of fieldName or fieldName:asc,fieldName:desc. If you want to sort by localized attributes, you must use the following form: fieldName.language or fieldName.language:asc,fieldName.language:desc.
pageNumber	integer >= 1 Default: 1 The page number to be retrieved where the size of the pages must be specified by the pageSize parameter. The number of the first page is 1.
pageSize	integer >= 1 Default: 16 The number of documents being retrieved on the page.
q	string A standard query parameter is used to search for specific values. Searching for an item by string property: `q=currency:USD` where `currency` is the name of string field and `USD` is its required value. Searching for items by number-based property: Searching for items with specific value: `q=tax.total.amount:20` Searching for items with value greater than: `q=tax.total.amount:>20` Searching for items with value lower than: `q=tax.total.amount:<20` Searching for items with value greater or equal than: `q=tax.total.amount:>=20` Searching for items with value lower or equal than: `q=tax.total.amount:<=20` Searching for items with within a range of values: `q=tax.total.amount:(>=10 AND <=20)` where `tax.total.amount` is name of number-based field and `20` is it's querying value. Searching for items by date property. All numer-based property queries are valid also for dates. In that case the date should be placed within double quotes: `q=created:(>="2021-05-18T07:27:27.455Z" AND <"2021-05-20T07:27:27.455Z")` Searching for items by boolean value: `q=customer.mixins.generalAttributes.invoiceNotDeliveryAddress:true` where `customer.mixins.generalAttributes.invoiceNotDeliveryAddress` is a name of boolean field and 'true' is it`s required value. Searching for items with non existing or empty property: `q=billingAddress.contactPhone:null` where `billingAddress.contactPhone` is a name of fields that has value `null`. Searching for items with existing property: `q=mixin:exists` where `mixin` is a name of field that has `non null` value. Searching for items by multiple specific values: `q=id:(order_id1,order_id2)` where `id` is name of field and strings within a bracket are it's required value. Searching for items by multiple fields: `q=id:order_id1 status:COMPLETED` where `id` and `status` are the names of fields. All documents that contain given values of these fields are returned. Multiple fields separated by space can be specified. Multiple values for each field can be also specified in a format presented above. Example: q=currency:USD
fields	string A list of comma-separated fields names of the Order. If the field is empty then full order is returned. Otherwise, only the indicated fields will be populated in a response.

header Parameters

saas-token

required

string

Token used to identify logged-in users. This token has an expiry date and is signed with a passphrase.

Responses

200

Some server side error occurred.

400

Request was syntactically incorrect. Any details will be provided within the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

500

Some server side error occurred.

get/{tenant}/orders

Request samples

Response samples

application/json

[{"id": "orderId123456",
"metadata": {"mixins": {"additionalCode": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/example-schema.json"
}
},
"mixins": {"additionalCode": {"code": "DFG-334-98330-X"
}
},
"created": "2014-03-31T10:18:21.134Z",
"completed": "2014-04-15T10:18:21.134Z",
"lastStatusChange": "2014-04-15T10:18:21.134Z",
"status": "COMPLETED",
"siteCode": "Germany",
"countryCode": "DE",
"deliveryWindowId": "5d230f973f05e303d5c30dba",
"entries": [{"id": "5c13ccdbba93e00008b8d274",
"amount": 2,
"orderedAmount": 2,
"originalAmount": 450,
"originalPrice": 450,
"unitPrice": 420,
"totalPrice": 840,
"authorizedAmount": 840,
"link": "https://api.emporix.io/product/mytenant/products/5c13ccdbba93e00008b8d274",
"product": {"description": "A mug you've always wanted !",
"name": "Mug",
"sku": "mug-product",
"published": true,
"images": [{"id": "media123456",
"url": "https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"
}
]
}
},
{"id": "1234547",
"amount": 5,
"unitPrice": 240,
"totalPrice": 1200,
"authorizedAmount": 1200,
"product": {"metadata": {"mixins": {"color": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/color_v1.json"
}
},
"description": "A Shirt you've always wanted !",
"name": "Shirt",
"sku": "shirt-product",
"published": true,
"images": [{"id": "media1234567",
"url": "https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"
}
],
"mixins": {"color": {"red": 234,
"green": 231,
"blue": 123
}
}
}
}
],
"discounts": [{"code": "SUMMER_SALE",
"name": "Summer Sale 10% off everything",
"amount": 204,
"currency": "USD",
"discountRate": 10,
"sequenceId": 1,
"link": {"id": "B2TD3JM",
"type": "y-coupon",
"url": "https://api.emporix.io/coupon/mytenant/coupons/ENG2OC"
}
}
],
"customer": {"id": "C1234567890",
"title": "Dr.",
"name": "Example Buyer",
"firstName": "Example",
"lastName": "Buyer",
"email": "noreply@emporix.com",
"company": "emporix"
},
"billingAddress": {"contactName": "Example Buyer",
"street": "Nymphenburger Str.",
"streetNumber": "86",
"city": "Munich",
"state": "Bavaria",
"country": "Germany",
"zipCode": "132 45",
"contactPhone": "+49 1111 222 333"
},
"shippingAddress": {"contactName": "Joe Smith",
"companyName": "Cargo Services Airfreight",
"street": "Cheng Xiang Zhen Guan Tang Lu",
"streetNumber": "1031",
"extraLine1": "No. 2058",
"extraLine2": "Suzhou City",
"zipCode": "201202",
"city": "Taicang City",
"state": "Jiangsu Province",
"country": "CN",
"contactPhone": "+86 182 9349 4663",
"metadata": {"mixins": {"secondaryContactPhone": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/contact-number.json"
}
},
"mixins": {"secondaryContactPhone": {"number": "+86 334 0033 9934"
}
}
},
"subTotalPrice": 1881,
"totalPrice": 2041,
"totalAuthorizedAmount": 2041,
"currency": "USD",
"payments": [{"status": "SUCCESS",
"method": "STRIPE",
"paymentResponse": "",
"paidAmount": 2041,
"currency": "USD"
}
],
"tax": {"total": {"amount": 150,
"currency": "USD",
"inclusive": false
},
"lines": [{"amount": 150,
"currency": "USD",
"code": "VAT",
"name": "Regular VAT",
"rate": 10,
"taxable": 1500,
"sequenceId": 1,
"inclusive": false
}
]
},
"shipping": {"total": {"amount": 11.9,
"currency": "USD"
},
"lines": [{"amount": 10,
"currency": "USD",
"code": "dhlstd",
"name": "DHL Standard",
"localizedName": {"en": "DHL Standard",
"de": "DHL Standard"
},
"tax": {"total": {"amount": 1.9,
"currency": "USD",
"inclusive": false
},
"rate": 19
}
}
]
},
"shipments": [{"trackingNumber": "123987456",
"carrier": "UPS",
"shippedDate": "2016-06-25T16:22:52.966Z",
"expectDeliveryOn": "2016-06-27"
}
]
},
{"id": "orderId123457",
"created": "2015-02-11T03:12:33.345Z",
"status": "CREATED",
"siteCode": "Germany",
"countryCode": "DE",
"deliveryWindowId": "5d230f973f05e303d5c30dba",
"entries": [{"metadata": {"mixins": {"additionalCode": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/example-schema.json"
}
},
"id": "5c13ccdbba93e00008b8d274",
"amount": 1,
"orderedAmount": 1,
"originalAmount": 450,
"originalPrice": 450,
"unitPrice": 420,
"totalPrice": 420,
"authorizedAmount": 420,
"link": "https://api.emporix.io/product/mytenant/products/5c13ccdbba93e00008b8d274",
"product": {"description": "A mug you've always wanted !",
"name": "Mug",
"sku": "mug-product",
"published": true,
"images": [{"id": "media123456",
"url": "https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"
}
]
},
"mixins": {"additionalCode": {"code": "ABC"
}
}
}
],
"customer": {"id": "C1234567890",
"title": "Dr.",
"name": "Example Buyer",
"firstName": "Example",
"lastName": "Buyer",
"email": "noreply@emporix.com",
"company": "emporix",
"metadata": {"mixins": {"work_phone": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/contact-number.json"
}
},
"mixins": {"work_phone": {"number": "+86 334 0033 9934"
}
}
},
"billingAddress": {"contactName": "Example Buyer",
"street": "Nymphenburger Str.",
"streetNumber": "86",
"city": "Munich",
"state": "Bavaria",
"country": "DE",
"zipCode": "132 45",
"contactPhone": "+49 1111 222 333"
},
"shippingAddress": {"contactName": "Joe Smith",
"companyName": "Cargo Services Airfreight",
"street": "Cheng Xiang Zhen Guan Tang Lu",
"streetNumber": "1031",
"extraLine1": "No. 2058",
"extraLine2": "Suzhou City",
"zipCode": "201202",
"city": "Taicang City",
"state": "Jiangsu Province",
"country": "CN",
"contactPhone": "+86 182 9349 4663",
"metadata": {"mixins": {"secondaryContactPhone": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/contact-number.json"
}
},
"mixins": {"secondaryContactPhone": {"number": "+86 334 0033 9934"
}
}
},
"totalPrice": 420,
"totalAuthorizedAmount": 420,
"currency": "USD"
}
]

Creating a new order

Creates an order. To be used by customers on the storefront.

Required scopes

order.order_post

SecurityOAuth2

Request

path Parameters

tenant

required

string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

The tenant that the caller is acting upon.

Please note that this value is always lowercase.

header Parameters

saas-token

required

string

Token used to identify logged-in users. This token has an expiry date and is signed with a passphrase.

Request Body schema: application/json

status	string (orderStatus) Status of the order. Supported order statuses are `IN_CHECKOUT`, `CREATED`, `CONFIRMED`, `DECLINED`, `SHIPPED`, `COMPLETED`'. Customers can only change the order status from `CREATED` to `DECLINED`. Enum: "IN_CHECKOUT" "CREATED" "CONFIRMED" "DECLINED" "SHIPPED" "COMPLETED"
	Array of objects (Order entry) Ordered item list.
	Array of objects (Discount) Discount list.
	object (Customer) Customer data.
siteCode	string Site’s unique identifier. A site is a specific shop.
countryCode	string Two-letter country code, compliant with the ISO 3166 standard.
	object (Adress) Customer's address.
	object (Adress) Customer's address.
	Array of objects (Payment) Payment list.
	object (Shipping) Shipping details.
	object (Tax) Tax details.
subTotalPrice	number Order sub total price.
totalPrice	number Order total price.
totalAuthorizedAmount	number The authorized amount.
currency	string Three-letter currency code, compliant with the ISO 4217 standard.
orderCycle	string Order cycle date. NOTE This attribute is DEPRECATED, please use the `deliveryWindow.deliveryCycle` attribute
deliveryWindowId	string Delivery window's unique identifier. NOTE This attribute is DEPRECATED, please use the `deliveryWindow.id` attribute
	object (Delivery Window)
	object (Metadata DTO)
mixins	object
	object (Channel)

Responses

201

The collection resource has been successfully created.

400

Request syntactically incorrect. Any details will be provided within the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

409

Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.

500

Some server side error occurred.

post/{tenant}/orders

Request samples

application/json

{"entries": [{"id": "5c336893a981210009900071",
"itemYrn": "urn:yaas:saasag:caasproduct:product:mytenant;5c336893a981210009900071",
"amount": 3,
"orderedAmount": 3,
"effectiveQuantity": 3,
"originalAmount": 34.9,
"originalPrice": 34.9,
"unitPrice": 34.9,
"measurementUnit": {"value": 1,
"unit": "H87"
},
"totalPrice": 104.7,
"authorizedAmount": 104.7,
"product": {"metadata": {"mixins": {"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/v1560527845/schemata/CAAS/productCustomAttributesMixIn-v38.json",
"productBundle": "https://res.cloudinary.com/saas-ag/raw/upload/llproductdata/productBundleMixIn.v5.json",
"salePricesData": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/salePriceData.json"
}
},
"id": "5c336893a981210009900071",
"sku": "A705121365",
"name": "Moët & Chandon Impérial Brut Champagner 0,375 l Flasche",
"description": "Der Moët & Chandon Impérial ist der gelungenste Ausdruck des typischen Stils des Hauses. Ein lebhafter und generöser Champagner, der sich durch seine ausgeprägte Frucht, verführerische Gaumennote sowie durch eine elegante Reife auszeichnet.",
"published": true,
"images": [{"id": "8c135ce0-3c5c-4c86-9052-ba2ad2f761cc",
"url": "https://res.cloudinary.com/saas-ag/image/upload/v1546872983/mytenant/products/8c135ce0-3c5c-4c86-9052-ba2ad2f761cc.jpg",
"stored": false
}
],
"mixins": {"productCustomAttributes": {"activeTab": "CrossSellings",
"brand": "59db24c530d7de000e47ba9c",
"categoryPath": {"categoryLevel1": "getraenke-weine",
"categoryLevel2": "weine",
"prettyName": "moët-chandon-impérial-brut-champagner-0375-l-flasche",
"categoryLevel3": ""
},
"containsAlcohol": true,
"crossSellings": ["5c333885a9812100098ff7c3",
"5c333aa3a9812100098ff821",
"5c33570aa9812100098ffd36",
"5c334d22a9812100098ffb83"
],
"defaultOrderQuantity": 1,
"deposit": 0,
"deposits": ["59d6216289e840000ead05fb"
],
"inStock": true,
"lastModifiedDate": "1546873061413",
"lmiv": {"alcoholConcentration": "12",
"foodBusinessOperator": "<p>Moët Hennessy Deutschland GmbH, Seidlstr. 23, 80335 München<br/></p>"
},
"maxOrderQuantity": 25,
"minOrderQuantity": 1,
"orderUnit": "H87",
"originCountry": "59db258c30d7de000e47bb21",
"originRegion": "Champagne",
"packagingDescription": "Glasflasche",
"packagingGroup": "2_Standard",
"packagingPosition": "1_Unten_unempfindlich",
"packagingUnit": "0,375 l Flasche",
"pricingMeasure": {"unitCode": "H87",
"value": 1
},
"pricingMeasurePrice": 34.9,
"productState": "ok",
"surcharge": "XXnnsv4m3a8BeRnk50YfQA==",
"taxClass": "FULL",
"unitPricingBaseMeasure": {"unitCode": "LTR",
"value": 1
},
"unitPricingMeasure": {"unitCode": "MLT",
"value": 375
},
"cutting": [ ],
"labels": [ ],
"servicePackaging": [ ],
"longDescription": "",
"lmivDescription": "",
"lastModifiedUser": ""
},
"salePricesData": {"salePrices": [{"salePriceAmount": 30.9,
"salePriceEnd": "2020-03-01T23:59:00.000+0000",
"salePriceStart": "2020-02-27T00:00:00.000+0000"
}
]
}
}
},
"price": {"priceId": "5c3368958232760008f1df0b",
"productId": "5c336893a981210009900071",
"yrn": "urn:yaas:hybris:price:price:mytenant;5c3368958232760008f1df0b",
"siteCode": "main",
"currency": "EUR",
"originalAmount": 34.9,
"effectiveAmount": 34.9,
"measurementUnit": {"unitCode": "H87",
"quantity": 1
},
"basePrice": {"effectiveAmount": 93.0666666667,
"originalAmount": 93.0666666667,
"measurementUnit": {"unitCode": "LTR",
"quantity": 1
}
},
"presentationPrice": {"effectiveAmount": 34.9,
"originalAmount": 34.9,
"measurementUnit": {"unitCode": "H87",
"quantity": 1
}
},
"metadata": {"createdAt": "2019-01-07T14:57:42.988Z",
"modifiedAt": "2021-04-08T11:53:18.825Z",
"version": 17
}
},
"totalDiscount": {"currency": "EUR"
},
"metadata": {"mixins": {"cartItemOptions": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/cartItemOptionsMixIn.v2.json",
"productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/v1560527845/schemata/CAAS/productCustomAttributesMixIn-v38.json",
"fees": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
}
},
"mixins": {"cartItemOptions": { },
"productCustomAttributes": { },
"fees": {"elements": [{"yrn": "urn:yaas:saasag:fee:fee:mytenant;59d6216289e840000ead05fb",
"taxCode": "ZERO",
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
],
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
}
}
],
"discounts": [ ],
"customer": {"id": "C6193791300",
"name": "Anna Schmit",
"title": "MRS",
"firstName": "Anna",
"lastName": "Schmit",
"email": "anna.schmit@schmit.com",
"metadata": {"mixins": {"generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/customerGeneralAttributesMixIn.v4.json",
"backofficeAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/accountBoMixIn.v3.json",
"payment": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/paymentMixIn.v3.json",
"marketing": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/accountMarketingMixIn.v4.json",
"administration": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/administrativeMixIn.v4.json",
"deliveryOptions": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryOptionsMixIn.v6.json"
}
},
"mixins": {"generalAttributes": {"lastDeliveryAddress": "a2cb0ce944",
"invoiceNotDeliveryAddress": false,
"birthday": "7.7.1972",
"mobilePhone": "608232233",
"contactPhone": "608232233",
"customerType": "private",
"customerNumber": "K701141"
},
"backofficeAttributes": {"country": "DE"
},
"payment": {"paymentType": "paymentByCash",
"paymentCosts": 0,
"paymentByDebit": {"bankAccountOwner": "",
"iban": "",
"bankName": ""
}
},
"marketing": { },
"administration": {"creationDate": "2020-12-08T13:39:45.813Z"
},
"deliveryOptions": {"substituteProduct": true,
"packaging": "Paper",
"hint": "",
"pickup": false,
"pickupAddress": {"id": "Pickup 1",
"street": "Fabrikstr",
"streetNumber": "5.",
"city": "Cham",
"zipCode": "6033",
"companyName": "SaaS test AG",
"country": "DE",
"addressName": "Fabrikstr. 5.",
"description": "test description for multiple pickup points",
"addressTag": "pickupAddress"
}
}
}
},
"siteCode": "main",
"countryCode": "DE",
"billingAddress": {"contactName": "Anna Schmit",
"street": "Maximilianstrasse",
"streetNumber": "55",
"streetAppendix": "",
"zipCode": "70173",
"city": "Stuttgart-Mitte",
"country": "DE",
"metadata": {"mixins": {"customAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/addressMixIn.v4.json"
}
},
"mixins": {"customAttributes": {"title": "MRS",
"firstName": "Anna",
"lastName": "Schmit",
"birthday": "7.7.1972"
}
}
},
"shippingAddress": {"contactName": "Anna Schmit",
"street": "Maximilianstrasse",
"streetNumber": "55",
"streetAppendix": "",
"zipCode": "70173",
"city": "Stuttgart-Mitte",
"country": "DE",
"metadata": {"mixins": {"customAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/addressMixIn.v4.json"
}
},
"mixins": {"customAttributes": {"title": "MRS",
"firstName": "Anna",
"lastName": "Schmit",
"birthday": "7.7.1972"
}
}
},
"payments": [{"status": "PENDING",
"method": "cash-on-delivery",
"paidAmount": 0,
"currency": "EUR"
}
],
"shipping": {"total": {"amount": 20,
"currency": "EUR"
},
"lines": [{"amount": 20,
"currency": "EUR",
"code": "4-more_hours_timeframe",
"tax": {"total": {"amount": 0,
"currency": "USD",
"inclusive": false
},
"rate": 0
},
"shippingTaxCode": "ZERO"
}
]
},
"tax": {"total": {"amount": 0,
"currency": "EUR",
"inclusive": false
}
},
"subTotalPrice": 104.7,
"totalPrice": 124.7,
"totalAuthorizedAmount": 124.7,
"currency": "EUR",
"metadata": {"mixins": {"deliveryTime": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryTimeMixIn.v2.json",
"payment": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/paymentMixIn.v3.json",
"deliveryOptions": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/deliveryOptionsMixIn.v6.json",
"generalAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/orderGeneralAttributesMixIn.v9.json",
"payments": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/fees_checkout-mashup.json"
},
"version": 1
},
"mixins": {"deliveryTime": {"replace": false,
"deliveryDate": "2021-12-09T12:00:00.000Z",
"deliveryTimeFrom": "15:00",
"deliveryTimeTo": "22:00",
"deliveryCosts": 20,
"pickupSettings": "Fabrikstr. 5.",
"deliveryTimeId": "5b5572a7f19a51001ad55509"
},
"payment": {"paymentType": "paymentByCash",
"paymentCosts": 0,
"paymentByDebit": {"bankAccountOwner": "",
"iban": "",
"bankName": ""
}
},
"deliveryOptions": {"substituteProduct": true,
"packaging": "Paper",
"hint": "",
"pickup": false,
"pickupAddress": {"id": "Pickup 1",
"street": "Fabrikstr",
"streetNumber": "5.",
"city": "Cham",
"zipCode": "6033",
"companyName": "SaaS test AG",
"country": "DE",
"addressName": "Fabrikstr. 5.",
"description": "test description for multiple pickup points",
"addressTag": "pickupAddress"
}
},
"generalAttributes": {"extendedOrderStatus": "10",
"orderType": "CUSTOMER_ORDER",
"customerFirstOrder": false,
"orderNumber": "B7022093"
},
"payments": {"elements": [{"paymentMethodYrn": "urn:yaas:hybris:payments:payment-method:mytenant;cash-on-delivery",
"fees": {"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
},
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
],
"total": {"subTotal": 0,
"totalTax": 0,
"total": 0
}
}
},
"orderCycle": "2021-12-09T12:00:00.000Z",
"deliveryWindowId": "5b5572a7f19a51001ad55509",
"channel": { }
}

Response samples

application/json

{"id": "1234546",
"link": "https://api.emporix.io/order/mytenant/salesorders/1234546"
}

Retrieving order details

Retrieves details of an order. To be used by customers on the storefront.

Required scopes

order.history_view for logged in customers only.

SecurityOAuth2

Request

path Parameters

orderId required	string Unique identifier of an order.
tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ The tenant that the caller is acting upon. Please note that this value is always lowercase.

header Parameters

saas-token

required

string

Token used to identify logged-in users. This token has an expiry date and is signed with a passphrase.

Responses

200

The request was successful. Order details are returned.

403

Given authorization scopes are not sufficient and do not match required scopes.

404

Order does not exist

500

Some server side error occurred.

get/{tenant}/orders/{orderId}

Request samples

Response samples

application/json

{"id": "orderId123456",
"metadata": {"mixins": {"additionalCode": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/example-schema.json"
}
},
"mixins": {"additionalCode": {"code": "DFG-334-98330-X"
}
},
"created": "2014-03-31T10:18:21.134Z",
"completed": "2014-04-15T10:18:21.134Z",
"lastStatusChange": "2014-04-15T10:18:21.134Z",
"status": "COMPLETED",
"entries": [{"metadata": {"mixins": {"additionalCode": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/example-schema.json"
}
},
"id": "5c13ccdbba93e00008b8d274",
"amount": 2,
"orderedAmount": 2,
"originalAmount": 450,
"originalPrice": 450,
"unitPrice": 420,
"totalPrice": 840,
"authorizedAmount": 840,
"link": "https://api.emporix.io/product/mytenant/products/5c13ccdbba93e00008b8d274",
"product": {"description": "A mug you've always wanted !",
"name": "Mug",
"sku": "mug-product",
"published": true,
"images": [{"id": "media123456",
"url": "https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"
}
]
}
},
{"id": "1234547",
"amount": 5,
"orderedAmount": 5,
"originalAmount": 250,
"originalPrice": 450,
"unitPrice": 240,
"totalPrice": 1200,
"authorizedAmount": 1200,
"product": {"metadata": {"mixins": {"color": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/color_v1.json"
}
},
"description": "A Shirt you've always wanted !",
"name": "Shirt",
"sku": "shirt-product",
"published": true,
"images": [{"id": "media1234567",
"url": "https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"
}
],
"mixins": {"color": {"red": 234,
"green": 231,
"blue": 123
}
}
}
},
{"id": "1234548",
"amount": 1,
"unitPrice": 45,
"totalPrice": 45,
"authorizedAmount": 45,
"measurementUnit": {"value": 2,
"unit": "kg"
},
"link": "https://api.emporix.io/product/mytenant/products/5c13ccdbba93e00008b8d274",
"product": {"description": "Vegetables you've always wanted !",
"name": "Vegetables",
"sku": "vegetables-product",
"published": true,
"images": [{"id": "media1234548",
"url": "https://res.cloudinary.com/saas-ag/image/upload/55db925ed94e8d92c6b4cfe9_vksjjg.jpg"
}
]
}
}
],
"discounts": [{"code": "SUMMER_SALE",
"name": "Summer Sale 10% off everything",
"amount": 204,
"currency": "USD",
"discountRate": 10,
"sequenceId": 1,
"link": {"id": "B2TD3JM",
"type": "y-coupon",
"url": "https://api.emporix.io/coupon/mytenant/coupons/ENG2OC"
}
}
],
"customer": {"id": "C1234567890",
"title": "Dr.",
"name": "Example Buyer",
"firstName": "Example",
"lastName": "Buyer",
"email": "noreply@emporix.com",
"company": "emporix",
"metadata": {"mixins": {"work_phone": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/contact-number.json"
}
},
"mixins": {"work_phone": {"number": "+86 334 0033 9934"
}
}
},
"siteCode": "Germany",
"countryCode": "DE",
"deliveryWindowId": "5d230f973f05e303d5c30dba",
"billingAddress": {"contactName": "Example Buyer",
"street": "Nymphenburger Str.",
"streetNumber": "86",
"city": "Munich",
"state": "Bavaria",
"country": "DE",
"zipCode": "132 45",
"contactPhone": "+49 1111 222 333"
},
"shippingAddress": {"contactName": "Joe Smith",
"companyName": "Cargo Services Airfreight",
"street": "Cheng Xiang Zhen Guan Tang Lu",
"streetNumber": "1031",
"extraLine1": "No. 2058",
"extraLine2": "Suzhou City",
"zipCode": "201202",
"city": "Taicang City",
"state": "Jiangsu Province",
"country": "CN",
"contactPhone": "+86 182 9349 4663",
"metadata": {"mixins": {"secondaryContactPhone": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/CAAS/contact-number.json"
}
},
"mixins": {"secondaryContactPhone": {"number": "+86 334 0033 9934"
}
}
},
"subTotalPrice": 1881,
"totalPrice": 2041,
"totalAuthorizedAmount": 2041,
"currency": "USD",
"payments": [{"status": "SUCCESS",
"method": "STRIPE",
"paymentResponse": "",
"paidAmount": 2041,
"currency": "USD"
}
],
"tax": {"total": {"amount": 150,
"currency": "USD",
"inclusive": false
},
"lines": [{"amount": 150,
"currency": "USD",
"code": "VAT",
"name": "Regular VAT",
"rate": 10,
"taxable": 1500,
"sequenceId": 1,
"inclusive": false
}
]
},
"shipping": {"total": {"amount": 11.9,
"currency": "USD"
},
"lines": [{"amount": 10,
"currency": "USD",
"code": "dhlstd",
"name": "DHL Standard",
"localizedName": {"en": "DHL Standard",
"de": "DHL Standard"
},
"tax": {"total": {"amount": 1.9,
"currency": "USD",
"inclusive": false
},
"rate": 19
}
}
]
},
"shipments": [{"trackingNumber": "123987456",
"carrier": "UPS",
"shippedDate": "2016-06-25T16:22:52.966Z",
"expectDeliveryOn": "2016-06-27"
}
]
}

Retrieving status transitions for a specific order

Retrieves possible status transitions for a specific order. To be used by customers on the storefront.

Required scopes

order.order_updateascustomer

SecurityOAuth2

Request

path Parameters

orderId required	string Unique identifier of an order.
tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ The tenant that the caller is acting upon. Please note that this value is always lowercase.

header Parameters

saas-token

required

string

Token used to identify logged-in users. This token has an expiry date and is signed with a passphrase.

Responses

200

The request was successful. Status transition for given order returned.

403

Access forbidden. The caller is not allowed to access this resource.

404

Order does not exist

500

Some server side error occurred.

get/{tenant}/orders/{orderId}/transitions

Request samples

Response samples

application/json

[{"status": "CONFIRMED"
}
]

Updating order status

Updates the status of a specific order. To be used by customers on the storefront. Note: Customers can only change the order status from CREATED to DECLINED.

Required scopes

order.order_updateascustomer

SecurityOAuth2

Request

path Parameters

orderId required	string Unique identifier of an order.
tenant required	string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$ The tenant that the caller is acting upon. Please note that this value is always lowercase.

header Parameters

saas-token

required

string

Token used to identify logged-in users. This token has an expiry date and is signed with a passphrase.

Request Body schema: application/json

status

string (orderStatus)

Status of the order. Supported order statuses are IN_CHECKOUT, CREATED, CONFIRMED, DECLINED, SHIPPED, COMPLETED'. Customers can only change the order status from CREATED to DECLINED.

Enum: "IN_CHECKOUT" "CREATED" "CONFIRMED" "DECLINED" "SHIPPED" "COMPLETED"

Responses

204

The transition was successful.

400

Request syntactically incorrect. Any details will be provided within the response payload.

403

Access forbidden. The caller is not allowed to access this resource.

404

Order does not exist

500

Some server side error occurred.

post/{tenant}/orders/{orderId}/transitions

Request samples

application/json

{"status": "DECLINED"
}

Response samples

application/json

{"status": 400,
"message": "There are validation problems, see details section for more information",
"type": "validation_violation",
"details": [{"field": "client-owner",
"message": "must be between 3 and 16 characters",
"type": "invalid_header"
}
]
}