Skip to main content

Pickpack – Get Order Detail

Retrieve a single pickpack order details

Endpoint​

GET /v1/pickpack/detail

Request​

Header Parameters​

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

Query / Path Parameters​

FieldTypeRequiredDescription
order_idintYes (unless using path)Order ID. If omitted from query, you can use /v1/pickpack/detail/{order_id}.

Example request​

curl -X GET "${API_URL}/v1/pickpack/detail?order_id=3550646" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json"

Responses​

200 Success​

200 Success

Response schema: application/json
data
json-string
Pickpack detail response wrapper.
Expand for fields.
order
json-string
Single pickpack order with parcel snapshot and related documents.
Expand for fields.
order_id
string
Order ID.
Example: 3550646
customer_eid
string
Customer ID.
Example: 1234567890
status
string
Pickpack status code.
Example: PICKPACK_PENDING_CONFIRM
reject_type
string
Reject type when order is rejected.
Expand for values.
Supported values:
ValueDescription
OUT_OF_STOCKRejected due to out of stock.
OTHERSOther reject reason.
reject_reason
string
Reject reason.
tracking_number
string
Tracking number when created.
Example: SF123456789
courier_company
string
Courier display name.
Example: SF Express
shipment_detail
json-string
Parcel dimensions, weights, and declaration lines.
Expand for fields.
parcel_list
json-string
Array of parcel snapshots.
Expand for item fields.
tracking_number
string
Parcel-level tracking number from the matched order item.
Example: SF123456789
length
string
Parcel length (stringified).
Example: 23
width
string
Parcel width (stringified).
Example: 14
height
string
Parcel height (stringified).
Example: 10
act_weight
string
Actual weight (stringified).
Example: 0.5
declaration_list
json-string
Declaration lines per parcel, built from app_tbl_declare by item_id (includes SKU).
Expand for fields.
custom_declare_fulldesc
string
Item description. Empty when unavailable.
Example: Shirt
custom_qty
string
Quantity (stringified).
Example: 2
custom_single_price
string
Unit price (stringified).
Example: 12.5
custom_hscode
string
HS code. Empty when unavailable.
Example: 610910
custom_unit
string
Unit. Empty when unavailable.
Example: PCS
custom_single_weight
string
Single weight (stringified). Empty when unavailable.
Example: 0.2
custom_origin
string
Country of origin. Empty when unavailable.
Example: CN
currency
string
Currency. Empty when unavailable.
Example: USD
custom_with_battery
string
Battery flag. Empty when unavailable.
Example: N
battery_type
string
Battery type. Empty when unavailable.
battery_location
string
Battery location. Empty when unavailable.
sku
string
SKU. Empty when unavailable.
Example: SKU-123
bar_code_eid
string
Barcode EID. Empty when unavailable.
Example: BARCODE-001
related_documents
json-string
Related documents (base64 PDF).
Expand for fields.
format
string
File format. Always pdf.
Example: pdf
encoding
string
Encoding. Always base64.
Example: base64
content
string
Base64 content of related documents.
Example: JVBERi0xLjQKJ... (truncated)
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

Response sample

{
  "data": {
    "order": {
      "order_id": "3550646",
      "customer_eid": "1234567890",
      "status": "PICKPACK_PENDING_CONFIRM",
      "reject_type": "",
      "reject_reason": "",
      "tracking_number": "SF123456789",
      "courier_company": "SF Express",
      "shipment_detail": {
        "parcel_list": [
          {
            "tracking_number": "SF123456789",
            "length": "23",
            "width": "14",
            "height": "10",
            "act_weight": "0.5",
            "declaration_list": [
              {
                "custom_declare_fulldesc": "Shirt",
                "custom_qty": "2",
                "custom_single_price": "12.5",
                "custom_hscode": "610910",
                "custom_unit": "PCS",
                "custom_single_weight": "0.2",
                "custom_origin": "CN",
                "currency": "USD",
                "custom_with_battery": "N",
                "battery_type": "",
                "battery_location": "",
                "sku": "SKU-123",
                "bar_code_eid": "BARCODE-001"
              }
            ]
          }
        ]
      },
      "related_documents": {
        "format": "pdf",
        "encoding": "base64",
        "content": "JVBERi0xLjQKJ..."
      },
      "request_datetime": "2024-02-01 10:12:20",
      "update_datetime": "2024-02-01 10:20:00"
    }
  }
}

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: order_id
message
string
Human-readable message.
Example: order_id is required

Response sample

{
  "error": {
    "code": "400000",
    "code_reason": "BAD_REQUEST",
    "message": "Bad Request",
    "error_trace": [
      {
        "field": "order_id",
        "message": "order_id is required"
      }
    ]
  }
}

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"
  }
}