Skip to main content

Pickpack – Submit Confirmation

Confirm pickpack orders.

Endpoint​

POST /v1/pickpack/confirm

Request​

Header Parameters​

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

Request Body Schema​

application/json
ordersrequired
json-string
Array of orders to confirm.
Non-empty array. Maximum 100 orders per request.
Expand for item fields.
order_idrequired
string
Target order ID.
Numeric string. Order must be at pickpack_status PICKPACK_PENDING_CONFIRM.
Example: 3550646
shipment_detailrequired
json-string
Container for updated parcel list.
Expand for fields.
parcel_listrequired
json-string
Array of parcels with final dimensions and weights.
Non-empty array. Each entry replaces the original dimensions and weights.
Expand for item fields.
lengthrequired
string
Length in cm.
Positive numeric string.
Example: 23
widthrequired
string
Width in cm.
Positive numeric string.
Example: 14
heightrequired
string
Height in cm.
Positive numeric string.
Example: 10
act_weightrequired
string
Actual weight in kg.
Positive numeric string.
Example: 0.52
declare_value
string
Declared value override.
Numeric string. Defaults to existing value when not provided.
Example: 100.00
insurance_fee
string
Insurance fee override.
Numeric string.
Example: 0
item_remarks
string
Remark per parcel.
Example: Handle with care
item_description
string
Description per parcel.
Example: Apparel

Example request​

curl -X POST "${API_URL}/v1/pickpack/confirm" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "orders": [
      {
        "order_id": "3550646",
        "shipment_detail": {
          "parcel_list": [
            {
              "length": "23",
              "width": "14",
              "height": "10",
              "act_weight": "0.52"
            }
          ]
        }
      }
    ]
  }'

Responses​

200 Success​

200 Success

Response schema: application/json
data
json-string
Pickpack confirm response wrapper.
Expand for fields.
orders
json-string
Array of orders successfully confirmed.
Expand for item fields.
order_id
string
Order ID.
Example: 3550646
status
string
Updated pickpack status code.
Example: PICKPACK_CONFIRMED
new_quote_price
string
Latest quote price after recalculation.
Example: 32.10
shipment_detail
json-string
Shipment detail saved during confirmation.
Expand for fields.
parcel_list
json-string
Parcel data saved during confirmation.
Expand for item fields.
length
string
Length in cm.
Example: 23
width
string
Width in cm.
Example: 14
height
string
Height in cm.
Example: 10
act_weight
string
Actual weight in kg.
Example: 0.52

Note
Errors stop the entire request. None of the remaining orders are processed.

Response sample

{
  "data": {
    "orders": [
      {
        "order_id": "3550646",
        "status": "PICKPACK_CONFIRMED",
        "new_quote_price": "32.10",
        "shipment_detail": {
          "parcel_list": [
            {
              "length": "23",
              "width": "14",
              "height": "10",
              "act_weight": "0.52"
            }
          ]
        }
      }
    ]
  }
}

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: orders[0].shipment_detail.parcel_list[0].act_weight
message
string
Human-readable message.
Example: orders[0].shipment_detail.parcel_list[0].act_weight is required and must be a positive number

Response sample

{
  "error": {
    "code": "400000",
    "code_reason": "BAD_REQUEST",
    "message": "Bad Request",
    "error_trace": [
      {
        "field": "orders[0].shipment_detail.parcel_list[0].act_weight",
        "message": "orders[0].shipment_detail.parcel_list[0].act_weight is required and must be a positive number"
      }
    ]
  }
}

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