Skip to main content

Pickpack – Reject

Reject pickpack orders and mark them as failed without recalculating freight.

Endpoint​

POST /v1/pickpack/reject

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 reject.
Non-empty array. Maximum 100 orders per request.
Expand for item fields.
order_idrequired
string
Target order ID.
Numeric string.
Example: 3550646
typerequired
string
Reject type.
Example: OTHERS
Expand for supported values.
Supported values:
ValueDescription
OUT_OF_STOCKReject due to out of stock.
OTHERSReject for other reasons.
reject_reason
string
Reject reason.
Required when type is OTHERS.
Example: Parcel damaged
shipment_detail
json-string
Shipment detail
Required when type is OUT_OF_STOCK.
Expand for fields.
parcel_listrequired
json-string
Array of parcels with declaration mapping.
Required when type is OUT_OF_STOCK.
Non-empty array.
Expand for item fields.
declaration_listrequired
json-string
Array of declaration identifiers for items to reject.
Required when type is OUT_OF_STOCK.
Non-empty array.
Expand for item fields.
skurequired
string
SKU identifier.
Required when type is OUT_OF_STOCK.
Example: ABC-001
bar_code_eidrequired
string
Barcode EID identifier.
Required when type is OUT_OF_STOCK.
Example: BC-EID-001

Example request​

curl -X POST "${API_URL}/v1/pickpack/reject" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "orders": [
      {
        "order_id": "3550646",
        "type": "OTHERS",
        "reject_reason": "Parcel damaged"
      },
      {
        "order_id": "3550647",
        "type": "OUT_OF_STOCK",
        "shipment_detail": {
          "parcel_list": [
            {
              "declaration_list": [
                {
                  "sku": "ABC-001",
                  "bar_code_eid": "BC-EID-001"
                }
              ]
            }
          ]
        }
      }
    ]
  }'

Responses​

200 Success​

200 Success

Response schema: application/json
data
json-string
Pickpack reject response wrapper.
Expand for fields.
orders
json-string
Array of orders successfully rejected.
Expand for item fields.
order_id
string
Order ID.
Example: 3550646
status
string
Updated pickpack status code.
Example: PICKPACK_REJECTED
type
string
Reject type.
Example: OTHERS
reject_reason
string
Reject reason.
Example: Parcel damaged
shipment_detail
json-string
Shipment details
Expand for fields.
parcel_list
json-string
Parcel list mapping.
Expand for item fields.
declaration_list
json-string
Declaration mapping list.
Expand for item fields.
sku
string
SKU identifier.
Example: ABC-001
bar_code_eid
string
Barcode EID identifier.
Example: BC-EID-001

Response sample

{
  "data": {
    "orders": [
      {
        "order_id": "3550646",
        "status": "PICKPACK_REJECTED",
        "type": "OTHERS",
        "reject_reason": "Parcel damaged"
      },
      {
        "order_id": "3550647",
        "status": "PICKPACK_REJECTED",
        "type": "OUT_OF_STOCK",
        "reject_reason": "",
        "shipment_detail": {
          "parcel_list": [
            {
              "declaration_list": [
                {
                  "sku": "ABC-001",
                  "bar_code_eid": "BC-EID-001"
                }
              ]
            }
          ]
        }
      }
    ]
  }
}

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[].declaration_list
message
string
Human-readable message.
Example: Provided declaration_list contains sku or bar_code_eid not found in this order

Response sample

{
  "error": {
    "code": "400000",
    "code_reason": "BAD_REQUEST",
    "message": "Bad Request",
    "error_trace": [
      {
        "field": "orders[0].shipment_detail.parcel_list[].declaration_list",
        "message": "Provided declaration_list contains sku/bar_code_eid not found in this order: sku=ABC-001, bar_code_eid=BC-EID-001"
      }
    ]
  }
}

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