Skip to end of banner
Go to start of banner

Search Store Orders (Beta) (New API)

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

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 seaching the orders

yes

minId

String

TO BE UPDATED

yes

batchSize

String

TO BE UPDATED

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

TO BE UPDATED

searchStoreOrderDataList.locationCode

String

location code of this order

searchStoreOrderDataList.eventTime

String

TO BE UPDATED

searchStoreOrderDataList.eventType

String

 

searchStoreOrderDataList.channelOrderId

String

channel order id of this order

searchStoreOrderDataList.channelId

String

channel id of the channel of this order

  • No labels