We announce the release of a new API version aimed at providing convenience for our partners using the service.

Boxme API

Request Cancel Delivery Order

Developing

POST

https://s.boxme.asia/api/v2/orders/cancel-delivery/{tracking_number}/

Last modified:2024-08-19 06:21:38

Request cancel delivery after order shipped. The API limited a specific sellers.

Request

Path Params

tracking_number

string

required

Boxme tracking number

Header Params

Authorization

string

optional

Example:

Token {{API_TOKEN}}

Content-Type

string

optional

Example:

application/json

Body Params application/json

reason_code

enum<string>

required

Allowed values:

CANCEL_BY_CUSTOMERCANCEL_BY_MARKETPLACECANCEL_BY_SELLEROTHER

Example

{
  "reason_code": "CANCEL_BY_CUSTOMER"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://s.boxme.asia/api/v2/orders/cancel-delivery//' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200Success

application/json

Body

data

null

required

Object data response

error

boolean

required

Default:

false

error_code

string

Error code distinguishing reasons

required

messages

string

required

request_id

string

Request ID to get api call log.

required

Example

{
  "data": null,
  "error": false,
  "error_code": "",
  "messages": "",
  "request_id": "1704262964"
}

Modified at 2024-08-19 06:21:38

Update Document

Cancel Order