Order in Store
Order in Store records can only be created by the Imagine POS , these are then for 3rd party eCommerce providers to pick up and send the goods out.
What you can do with Order in Store
The Imagine API lets you do the following with the Order in Store resource. More detailed versions of these general actions may be available here https://postman.k3imagine.com
Retrieves a list of order in stores by web shop Id
Update order in store line status
Order in Store Properties
|
orderNo |
"orderNo": "TEST003" A unique order reference number for the order,usually this is the 3rd party order number. |
|
orderReference |
"orderReference": "123456"" A unique order reference number. |
|
receiveAddress |
"receiveAddress": "Somewhere Road" The address the goods shoud be delivered to |
|
returnAddress * |
"returnAddress": "Some Street" The return address for the order |
|
orderedOn |
"orderedOn": "2019-05-03T10:37:34.737Z" The date the order was placed |
|
pickedUpOn |
"pickedUpOn": "2019-05-03T10:37:34.737Z" The date the order was picked up on |
|
isPaid |
"isPaid": false Whether the order is paid |
|
shopId |
"shopId": 3 The Imagine ShopId the stock will be reserved against |
|
webshopId |
"webshopId": 1 Identifier for the web shop integrated. |
|
firstname |
"firstName": "Joe"00" Customer First Name |
|
lastName |
"lastName": "Smith" Customer Last Name |
|
|
"email": "[email protected]" Customer Email Address |
|
phoneNo |
"phoneNo":"" Customers Phone Number |
|
orderType |
"orderType": "ClickAndCollect" The type of order . |
|
webOrderLines |
"webOrderLines": [ { "id": 3074, "status": 2, "modifiedOn": "2019-08-08T15:20:10.4432416Z", "salesPrice": 10.0, "effectiveSalesPrice": 20.0, "discountAmount": 0.0, "deliveryNo": "", "notes": "string", "quantity": 1.0, "vatAmount": 0.0, "vatPercent": 20.0, "barcode": "0200000003678" } ] A list of order lines. The barcode is an optional field. Any barcodes matched to an Imagine item will have the stock unreserved upon updating the line status to 'Delivered' |
Endpoints
Get all Order in Store records by Web Shop
GET https://publicapi.k3imagine.com/api/v1.0/OrderInStore/webshops/1
Response: 200
Update order in store line status
PUT https://publicapi.k3imagine.com/api/v1.0/OrderInStore/c2e1fc09-eebc-4616-a275-506cce9eac96/linestatus
Response: 200