Inbound | POST | /store-orders/search
Summary Copy to clipboard
This API allows the POS system to fetch order details.
The POS system can fetch orders of different statuses from SFS. The useful order statuses are
ACCEPTED,PARTIALLY_ACCEPTED,PICKING_STARTED, andPICKING_COMPLETED.This feature helps users quickly filter and locate orders that require attention. Users can do billing in POS based on order status.
...
This API can be used to search the orders of a store based on these parameters:i)
locationCode
...
eventTypes
Request
| Code Block | ||
|---|---|---|
| ||
{
"locationCode": "loc1",
"minId": 123,
"batchSize": 500,
"eventTypes": [
"OUTWARD_ORDER_COMPLETE"
]
} |
...
Possible Event
...
Types
OUTWARD_ORDER_COMPLETE
...
OUTWARD_ORDER_CANCEL
...
OUTWARD_ORDER_PARTIAL_CANCEL
...
OUTWARD_ORDER_CREATE
...
OUTWARD_ORDER_DELIVER
...
SUBORDER_CREATE
...
SUBORDER_COMPLETE
...
SUBORDER_CANCEL
...
SUBORDER_DELIVER
...
SUBORDER_PARTIAL_CANCEL
...
PICK_LIST_RELEASE
...
PICK_LIST_UPDATED
...
ACCEPTEDREJECTEDPARTIALLY_ACCEPTEDPICKING_STARTEDPICKING_COMPLETEDPACKED
Parameter Name | Data Type | Description | Mandatory |
| String | Location code of the warehouse in which we are searching the orders |
Yes | ||
| String | Minimum event id greater than which the event (particularly for orders) will be searched |
Yes | ||
| String | Max results the caller want, default value is 5000 |
No | ||
| String[] | The type of events for which orders in store can be searched(find the list of valid event types above) |
Yes |
Response
| Code Block | ||
|---|---|---|
| ||
{
"searchStoreOrderDataList": [
{
"eventId": 123,
"locationCode": "loc1",
"eventTime": "2023-04-24T05:55:35+05:30",
"eventType": "PICKING_COMPLETED",
"channelOrderId": "ch_id1",
"channelId": "ch1"
}
]
} |
Parameter Name | Data Type | Description |
| Object[] | List of store order data returned from search |
| Long | Id for store events, it can be used, to update the minId of next call |
| String | Location code of this order |
| String | Last updated time of this order when it was moved to this event type |
| String | Event type of this order |
| String | channel order id of this order |
| String | channel id of the channel of this order |