Inbound Order List Query

3PP could get inbound order status through this API

Request

Header Params

clientKey

string

required

clientKey

vAuthorization

string

required

vAuthorization

Access-Token

string

required

Access-Token

Body Params application/json

apiVersion

string

required

data

object

required

inboundNumberList

object

optional

sellerInboundNumberList

object

optional

startTime

string

required

endTime

string

required

messageId

string

required

timestamp

integer

required

Example

{
  "apiVersion": "string",
  "data": {
    "inboundNumberList": {
      "inboundNumber": "string"
    },
    "sellerInboundNumberList": {
      "sellerInboundNumber": "string"
    },
    "startTime": "string",
    "endTime": "string"
  },
  "messageId": "string",
  "timestamp": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

code

integer <int32>

optional

data

array[object (Response of query inbound order) {10}]

optional

asnList

array[object (ExternalInboundOrderQueryAsnDto) {1}]

optional

Created ASN list

batchList

array[object (Batch number and status of inbound order batch) {2}]

optional

Batch list of this inbound order

bookingNumber

string

optional

Booking number for create ASN

inboundOrderNumber

string

required

Inbound order number

putAwayQty

integer <int32>

optional

SKU quantity that has put away

referenceNumber

string

optional

Reference number send for 3PP

shippingMethod

string

required

Shipping method:OF-Ocean Freight, AF-Air Freight, RF-Rail Freight, TK-Truck EX-Express

skuQty

integer <int32>

optional

SKU quantity in this inbound order

status

string

required

Status of this inbound order: Await Booking, Scheduled, Arrived, Partially put away, Put away, Canceled

warehouseCode

string

required

Code of the warehouse

errors

array[object (CommonVendorResponseErrorMsgDto) {3}]

optional

code

string

optional

string

optional

message

string

optional

message

string

optional

messageId

string

optional

success

boolean

optional

Example

{
  "code": 0,
  "data": [
    {
      "asnList": [
        {
          "asnNumber": "string"
        }
      ],
      "batchList": [
        {
          "batchNumber": "string",
          "status": "string"
        }
      ],
      "bookingNumber": "string",
      "inboundOrderNumber": "string",
      "putAwayQty": 0,
      "referenceNumber": "string",
      "shippingMethod": "string",
      "skuQty": 0,
      "status": "string",
      "warehouseCode": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "id": "string",
      "message": "string"
    }
  ],
  "message": "string",
  "messageId": "string",
  "success": true
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found