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

Boxme API

Update Document

PUT

https://s.boxme.asia/api/v2/orders/{tracking_number}/update_document/

Last modified:2025-02-10 04:55:52

Request

Path Params

tracking_number

string

required

Header Params

Content-Type

string

optional

Example:

application/json

Authorization

string

optional

Example:

Token {{API_TOKEN}}

Body Params application/json

documents

array [object {4}]

required

document_name

string

required

Doc name like invoice, po, shipping label

quantity

integer

required

Copy

>= 1<= 3

Default:

url

string <uri>

required

Require pdf, png type.

type

enum<string>

required

Allowed values:

invoicepolabelotherbillx80

Example

{
  "documents": [
    {
      "document_name": "test.jpg",
      "quantity": 1,
      "url": "https://doccument.com/test.jpg"
    },
    {
      "document_name": "test2.pdf",
      "quantity": 2,
      "url": "https://doccument.com/test.pdf"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://s.boxme.asia/api/v2/orders//update_document/' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "documents": [
        {
            "document_name": "test.jpg",
            "quantity": 1,
            "url": "https://doccument.com/test.jpg"
        },
        {
            "document_name": "test2.pdf",
            "quantity": 2,
            "url": "https://doccument.com/test.pdf"
        }
    ]
}'

Responses

🟢200OK

application/json

Body

data

object

required

tracking_code

string

required

error

boolean

required

error_code

string

required

messages

string

required

request_id

string

required

Example

{
  "data": {
    "tracking_code": "string"
  },
  "error": true,
  "error_code": "string",
  "messages": "string",
  "request_id": "string"
}

Modified at 2025-02-10 04:55:52

Create B2B Order

Request Cancel Delivery Order