Sales Order Entry API Queries
Placing an order via the API is made up of two stages:
- salesOrderGetQuote - Submitting a request for a Quote with your desired product variants and quantities. The API returns a Quote ID along with the pricing information and any eventual stock changes.
- salesOrderAcceptQuote - The quote is accepted using the Quote ID returned in the previous request.
salesOrderGetQuote
The products in the order are split into Lines which share the same product/colour/assortment, price, and delivery date. Prices and discounts are then determined on a line-by-line basis.
Below is an example of placing an order for Collection. In the image, the top-left corner is all the data from the quote you would like to retrieve. The bottom-left corner is the request (your order). The right-hand size is the response with your requested data.
Errors
The following errors can be returned:
|
Collection orders are (currently) not permitted |
You have requested an order for Collection but these are currently disabled in our system. |
|
Earliest collection/delivery date is currently XXX. Supply an empty RequestedDeliveryDate for it to be set automatically. |
The RequestedDeliveryDate supplied is early. If you would like it to be set automatically to as soon as possible, leave this field blank. |
|
Please supply an existing DeliveryAddressID or a new Delivery Address |
You have requested an order for delivery without supplying a Delivery Address ID or the details of a new delivery address. |
|
DeliveryAddress not found |
You have requested an order for delivery but the supplied Delivery Address ID was not found. Please request your delivery address ID described in our Contact Data section. |
|
EAN13 barcode not found: XXX |
You have requested a product variant (identified by EAN13 barcodes) which is not found. |
|
Product not found: XXX |
You have requested a product which is not found (this will be an error on our side). |
|
Empty quote |
You have not requested any products, or all requested products are out of stock. |
salesOrderAcceptQuote
This query simply accepts the QuoteID returned in the previous salesOrderGetQuote response. If the order is accepted, the Web Order ID will be returned for your reference.
Errors
The following errors can be returned:
|
Quote not found with ID: XXX |
No quote could be found with the supplied ID |
|
Access denied to this quote |
The quote was found but belongs to a different client. |
|
Not an API basket |
The quote is for a website basket instead of an API quote. |
|
This quote's validity has expired |
The quote has expired automatically after 30 days. |
|
This quote has already been confirmed. |
salesOrderAcceptQuote has already been executed on this quote. |
Quote validity
The Quote is valid for 30 days, and is equivalent to a Basket on the website. Please note: our pricing may fluctuate every day and is not fixed by this quote.