Pickpack – Get Pending Orders

Retrieve pickpack orders that are waiting for packaging confirmation.

Endpoint

GET /v1/pickpack/get

Request

Header Parameters

---

Parameter	Type	Required	Example	Description
Authorization	string	Yes	Bearer YOUR_ACCESS_TOKEN	Bearer access token used for authentication.
Content-Type	string	Yes	application/json	Request body content type.

---

Query Parameters

Field	Type	Required	Description
order_id	string	No	Filter by a specific order ID (numeric string).
customer_eid	string	No	Filter by Customer ID (numeric string).
request_start_date	string	No	Filter orders created on/after this date (YYYY-MM-DD).
request_end_date	string	No	Filter orders created on/before this date (YYYY-MM-DD).
status	string	No	Pickpack status code filter; supports comma-separated list (defaults to PICKPACK_PENDING_CONFIRM). Available values: PICKPACK_PENDING_CONFIRM, PICKPACK_CONFIRMED, PICKPACK_READY_TO_SHIPMENT, PICKPACK_CANCELLED, PICKPACK_REJECTED.
page	string	No	Page number (numeric string), minimum 1 (default 1).
limit	string	No	Page size (numeric string) between 1 and 1000 (default 100).

Status options (status)

Value	Description
PICKPACK_PENDING_CONFIRM	Waiting for packaging confirmation.
PICKPACK_CONFIRMED	Packaging confirmed.
PICKPACK_READY_TO_SHIPMENT	Ready for shipment / pickup arranged.
PICKPACK_CANCELLED	Pickpack request cancelled.
PICKPACK_REJECTED	Pickpack request rejected.

Example request

curl -X GET "${API_URL}/v1/pickpack/get?customer_eid=123&page=1&limit=20&status=PICKPACK_PENDING_CONFIRM,PICKPACK_CONFIRMED" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json"

Responses

200 Success

200 Success

Response schema: application/json

data

json-string

Pickpack response wrapper.

Expand for fields.

orders

json-string

Array of pickpack order records.

Expand for item fields.

order_id

string

Order ID.

Example: 3550646

customer_eid

string

Customer ID.

Example: 1234567890

status

string

Pickpack status code.

Common values: PICKPACK_PENDING_CONFIRM, PICKPACK_CONFIRMED, PICKPACK_READY_TO_SHIPMENT, PICKPACK_CANCELLED, PICKPACK_REJECTED.

Example: PICKPACK_PENDING_CONFIRM

is_require_repack

string

Whether this order requires re-pack.

Values: Y or N.

Example: N

reject_type

string

Reject type when order is rejected.

Expand for values.

Supported values:

Value	Description
OUT_OF_STOCK	Rejected due to out of stock.
OTHERS	Other reject reason.

reject_reason

string

Reject reason text.

Example: Insufficient stock

tracking_number

string

Tracking number when created.

Example: SF123456789

courier_company

string

Courier display name. Empty when unavailable.

Example: SF Express

pickup_detail

json-string

Pickup information. For PICKPACK_READY_TO_SHIPMENT, includes pickup_number and document-required flag; otherwise empty object.

Expand for fields.

pickup_number

string

Pickup reference number.

Example: PU240910001

is_pickup_document_required

string

Whether pickup-related document must be provided.

Values: Y or N.

Example: Y

shipment_detail

json-string

Shipment details.

Expand for fields.

parcel_total

string

Total parcel count.

Example: 1

request_datetime

string

Pickpack request time

Example: 2024-02-01 10:12:20

update_datetime

string

Pickpack update time.

Example: 2024-02-01 10:20:00

pagination

json-string

Pagination information.

Expand for fields.

page

string

Current page.

Example: 1

limit

string

Page size.

Example: 20

total

string

Total matching records.

Example: 1

Response sample

{
  "data": {
    "orders": [
      {
        "order_id": "3550646",
        "customer_eid": "1234567890",
        "status": "PICKPACK_PENDING_CONFIRM",
        "is_require_repack": "N",
        "reject_type": "",
        "reject_reason": "",
        "tracking_number": "SF123456789",
        "courier_company": "SF Express",
        "pickup_detail": {},
        "shipment_detail": { "parcel_total": "1" },
        "request_datetime": "2024-02-01 10:12:20",
        "update_datetime": "2024-02-01 10:20:00"
      }
    ],
    "pagination": { "page": "1", "limit": "20", "total": "1" }
  }
}

Response sample (status: PICKPACK_READY_TO_SHIPMENT)

{
  "data": {
    "orders": [
      {
        "order_id": "3550647",
        "customer_eid": "1234567890",
        "status": "PICKPACK_READY_TO_SHIPMENT",
        "is_require_repack": "Y",
        "reject_type": "",
        "reject_reason": "",
        "tracking_number": "SF987654321",
        "courier_company": "SF Express",
        "pickup_detail": {
          "pickup_number": "PU240910001",
          "is_pickup_document_required": "Y"
        },
        "shipment_detail": { "parcel_total": "1" },
        "request_datetime": "2024-02-01 10:12:20",
        "update_datetime": "2024-02-01 10:20:00"
      }
    ],
    "pagination": { "page": "1", "limit": "20", "total": "1" }
  }
}

400 Bad Request

400 Bad Request

Response schema: application/json

error.code

string

Error code.

Example: 400000

error.code_reason

string

Error reason.

Example: BAD_REQUEST

error.message

string

Human-readable message.

Example: Bad Request

error.error_trace

array

List of validation errors.

Expand for fields.

field

string

Request field that failed.

Example: request_start_date

message

string

Human-readable message.

Example: request_start_date must be in YYYY-MM-DD format

Response sample

{
  "error": {
    "code": "400000",
    "code_reason": "BAD_REQUEST",
    "message": "Bad Request",
    "error_trace": [
      {
        "field": "request_start_date",
        "message": "request_start_date must be in YYYY-MM-DD format"
      }
    ]
  }
}

401 Unauthorized

401 Unauthorized

Response schema: application/json

code

string

Error code.

Example: 401000

code_reason

string

Error reason.

Example: UNAUTHORIZED

message

string

Human-readable message.

Example: Unauthorized

{
  "error": {
    "code": "401000",
    "code_reason": "UNAUTHORIZED",
    "message": "Unauthorized"
  }
}

403 Forbidden

403 Forbidden

Response schema: application/json

error

json-string

Access forbidden for this resource.

404 Not Found

404 Not Found

Response schema: application/json

error

json-string

Resource or endpoint not found.

500 Failure

500 Failure

Response schema: application/json

code

string

Error code.

Example: 500999

code_reason

string

Error reason.

Example: API_ERROR

message

string

Human-readable message.

Example: Api Error, please contact customer service

{
  "error": {
    "code": "500999",
    "code_reason": "API_ERROR",
    "message": "Api Error, please contact customer service"
  }
}