Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Inbound | POST  | /orders/search

...

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

 

Request

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

...

Parameter Name

Data Type

Description

Mandatory

locationCode

String

Location code of the warehouse in which we are seaching the orders

yes

minId

StringTO BE UPDATED

Minimum event id greater than which the event (particularly for orders) will be searched

yes

batchSize

StringTO BE UPDATED

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

Code Block
languagejson
{
  "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 List of store order data returned from search

searchStoreOrderDataList.eventId

LongTO BE UPDATED

Id for store events, it can be used, to update the minId of next call

searchStoreOrderDataList.locationCode

String

location Location code of this order

searchStoreOrderDataList.eventTime

StringTO BE UPDATED

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