Warehouse API

Warehouse inbound and outbound task management.

Endpoints Overview

Endpoint	Method	Description
/api/v1/warehouse/inbound/submit	POST	Submit inbound task
/api/v1/warehouse/inbound/repush	POST	Re-push inbound task
/api/v1/warehouse/inbound/list	POST	Get inbound task list
/api/v1/warehouse/outbound/submit	POST	Submit outbound task
/api/v1/warehouse/outbound/repush	POST	Re-push outbound task
/api/v1/warehouse/sorting/list	POST	Get sorting/outbound task list

---

Submit Inbound Task

Submit a new warehouse inbound (storage) task.

Request

Endpoint: POST /api/v1/warehouse/inbound/submit

Headers:

• Content-Type: application/json
• Authorization: appToken {token}

Request Body:

{
  "request_id": "inbound_001",
  "warehouse_id": "WH_001",
  "income_type": 1,
  "transit_warehouse_code": "TRANSIT_WH_01",
  "sm_code": "SM_CODE",
  "pickup_address_id": "12345",
  "eta_date": "2025-03-15 10:00:00",
  "reference_no": "REF_12345",
  "verify": true,
  "inbound_task_items": [
    {
      "sku": "SKU001",
      "quantity": 100,
      "batch_number": "BATCH001"
    }
  ],
  "inbound_task_parcels": [
    {
      "parcel_number": 1,
      "weight": 10.5,
      "length": 30,
      "width": 20,
      "height": 15
    }
  ]
}

Field Description

Field	Type	Required	Description
request_id	string	Yes	Unique request ID
warehouse_id	string	Yes	Warehouse ID
income_type	int	Yes	Income type: 1 = Transit
transit_warehouse_code	string	Conditional	Transit warehouse code
sm_code	string	Conditional	Shipping method code
pickup_address_id	string	Conditional	Pickup address ID
eta_date	string	No	Estimated arrival date
reference_no	string	Yes	Reference number
verify	bool	No	Auto-verify task
inbound_task_items	object[]	Yes	Items to inbound
inbound_task_parcels	object[]	Yes	Parcels information

---

Inbound Task List

Get paginated list of inbound tasks.

Request

Endpoint: POST /api/v1/warehouse/inbound/list

{
  "pageNumber": 1,
  "pageSize": 20,
  "progress": "transit"
}

---

Inbound Task Re-push

Manually re-push inbound task to third-party platform.

Request

Endpoint: POST /api/v1/warehouse/inbound/repush

{
  "id": 123
}

---

Submit Outbound Task

Submit a new warehouse outbound (sorting) task.

Request

Endpoint: POST /api/v1/warehouse/outbound/submit

Request Body:

{
  "request_id": "outbound_001",
  "warehouse_id": "WH_001",
  "receipt_address_id": "12345",
  "reference_no": "OUT_REF_001",
  "verify": true,
  "parcels": [
    {
      "tracking_number": "TN123456",
      "weight": 2.5,
      "length": 30,
      "width": 20,
      "height": 10,
      "consignee": {
        "name": "John Doe",
        "phone": "+1234567890",
        "address": "123 Main St"
      }
    }
  ],
  "cod_amount": {
    "amount": 50.00,
    "currency": "USD"
  },
  "insurance_value": {
    "amount": 100.00,
    "currency": "USD"
  },
  "tax": {
    "amount": 5.00,
    "currency": "USD"
  }
}

Field Description

Field	Type	Required	Description
request_id	string	Yes	Unique request ID
warehouse_id	string	Yes	Warehouse ID
receipt_address_id	string	Yes	Receipt address ID
reference_no	string	Yes	Reference number
verify	bool	No	Auto-verify task
parcels	object[]	Yes	Parcel list
cod_amount	object	No	Cash on delivery amount
insurance_value	object	No	Insurance value
tax	object	No	Tax amount
other_payment	object	No	Other payment
pro_amount	object	No	Professional fee
transport_fee	object	No	Transport fee
valuation_fee	object	No	Valuation fee

---

Outbound Task List

Get paginated list of outbound tasks.

Request

Endpoint: POST /api/v1/warehouse/sorting/list

{
  "pageNumber": 1,
  "pageSize": 20,
  "progress": "verified"
}

---

Outbound Task Re-push

Manually re-push outbound task to third-party platform.

Request

Endpoint: POST /api/v1/warehouse/outbound/repush

{
  "id": 123
}

---

Task Progress Status

Status	Description
draft	Draft status
pending	Waiting for processing
transit	In transit
verified	Verified/Approved
pushed	Successfully pushed
error	Push failed

---

Error Codes

Code	Description
the income_type is required	Income type missing
the request_id is exist	Duplicate request ID
please do not repeat submit the same task in a short time	Duplicate submission
the item is not exist	Task not found
the item is not waiting for pushed	Task cannot be repushed