Skip to main content

Cancel Pickup

Cancel an active pickup for an international order.

Endpoint​

POST /v1/pickup/cancel

Request​

Header Parameters​

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

Request Body Schema​

application/json
order_idrequired
string
Numeric order identifier.
Digits only (0–9).
Example: 3570983

Example Request Body​

{
  "order_id": "3570983"
}

Example request​

curl -X POST "${API_URL}/v1/pickup/cancel" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"order_id": "3570983"}'

Responses​

200 Success​

200 Success

Response schema: application/json
data.pickup
object
Pickup that was cancelled.
Expand for fields.
pickup_id
string
Pickup reference ID that was cancelled.
Example: 29214E4A37E
status
string
Pickup status.
data.orders
object
Order that was reset.
Expand for fields.
order_id
string
Order ID.
Example: 3570983
status
string
New order status after cancelled.
data.message
string
Informational message.

Response sample

{
  "data": {
    "pickup": {
      "pickup_id": "29214E4A37E",
      "status": "CANCELLED"
    },
    "orders": {
      "order_id": "3570983",
      "status": "READY_TO_SHIP"
    },
    "message": "OK"
  }
}

400 Bad Request​

400 Bad Request

Response schema: application/json
code
string
Error code.
Example: 400000
code_reason
string
Error reason.
Example: BAD_REQUEST
message
string
Human-readable message.
Example: Bad Request
error_trace
array
List of validation errors
field
string
Request field that failed.
message
string
Human-readable message.

Response sample

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

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

Response sample

{
  "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
Machine-readable error reason.
Example: API_ERROR
message
string
Human-readable message.
Example: Api Error, please contact customer service

Response sample

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