Skip to main content

Pickpack – Get Pending Orders

Retrieve pickpack orders that are waiting for packaging confirmation.

Endpoint​

GET /v1/pickpack/get

Request​

Header Parameters​

ParameterTypeRequiredExampleDescription
AuthorizationstringYesBearer YOUR_ACCESS_TOKENBearer access token used for authentication.
Content-TypestringYesapplication/jsonRequest body content type.

Query Parameters​

FieldTypeRequiredDescription
order_idstringNoFilter by a specific order ID (numeric string).
customer_eidstringNoFilter by Customer ID (numeric string).
request_start_datestringNoFilter orders created on/after this date (YYYY-MM-DD).
request_end_datestringNoFilter orders created on/before this date (YYYY-MM-DD).
statusstringNoPickpack status code filter; supports comma-separated list (defaults to PICKPACK_PENDING_CONFIRM). See status table.
pagestringNoPage number (numeric string), minimum 1 (default 1).
limitstringNoPage size (numeric string) between 1 and 1000 (default 100).

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.
Example: PICKPACK_PENDING_CONFIRM
tracking_number
string
Tracking number when created.
Example: SF123456789
courier_company
string
Courier display name. Empty when unavailable.
Example: SF Express
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",
        "tracking_number": "SF123456789",
        "courier_company": "SF Express",
        "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"
  }
}