Inbound | POST | /orders/search

Summary Copy to clipboard

This API can be used to search store orders of some location and event type eg PICKING_DONE, PACKED, etc.

Description

This API can be used to search the orders of a store based on these parameters:
i) locationCode ii) eventTypes

Request

{
  "locationCode": "loc1",
  "minId": 123,
  "batchSize": 500,
  "eventTypes": [
    "OUTWARD_ORDER_COMPLETE"
  ]
}

Store Order Event Type

{
    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,
    ACCEPTED,
    REJECTED,
    PARTIALLY_ACCEPTED,
    PICKING_STARTED,
    PICKING_COMPLETED,
    PACKED
}

Parameter Name	Data Type	Description	Mandatory
`locationCode`	String	Location code of the warehouse in which we are searching the orders	yes
`minId`	String	Minimum event id greater than which the event (particularly for orders) will be searched	yes
`batchSize`	String	Max results the caller want, default value is 5000	no
`eventTypes`	String[]	The type of events for which orders in store can be searched(find the list of valid event types above)	yes

Response

{
  "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
`searchStoreOrderDataList`	Object[]	List of store order data returned from search
`searchStoreOrderDataList.eventId`	Long	Id for store events, it can be used, to update the minId of next call
`searchStoreOrderDataList.locationCode`	String	Location code of this order
`searchStoreOrderDataList.eventTime`	String	Last updated time of this order when it was moved to this event type
`searchStoreOrderDataList`.`eventType`	String	Event type of this order
`searchStoreOrderDataList`.`channelOrderId`	String	channel order id of this order
`searchStoreOrderDataList`.`channelId`	String	channel id of the channel of this order

Search Store Orders (Beta) (New API)