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

Order Pack

PUT

https://s.boxme.asia/api/v2/orders/fulfill/pack/

Last modified:2025-02-20 03:08:26

Use this API to confirm order ready to pack.
Seller Shipping/Platform Shipping: Seller arranges their own shipping, and upload a tracking number and courier.
Boxme Shipping: Do not call this API.

Request

Header Params

Content-Type

string

optional

Example:

application/json

Authorization

string

optional

Example:

Token {{API_TOKEN}}

Body Params application/json

tracking_number

string

required

Boxme tracking number

self_shipment

object

required

courier_tracking_code

string

required

Courier tracking code

courier_name

string

required

Courier name. Refer to API Get Courier List

org_courier_name

string

optional

Original Courier name on Marketplace.

handover_method

string

required

pickup/dropoff

Default:

pickup

Examples:

pickupdropoff

shipping_label

string <uri>

optional

Shipping label 10x15cm. Allow pdf, png

fulfill_type

string | null

optional

Default:

standard

Examples:

nowprioritystandard

fulfill_sla_time

integer

required

SLA based on marketplace requirement

store_created_time

integer

required

Time the order created on the sales channel

Example

{
  "tracking_number": "BM889493738484",
  "self_shipment": {
    "courier_tracking_code": "JNT45453434343",
    "courier_name": "GHN"
  },
  "handover_method": "pickup",
  "shipping_label": "https://storage.googleapis.com/boxme-cloud/label/2023/11/OWRhYTNmODUtMGViNS00NjYwLWFlYWYtMmRjOGQzYzg3YWFh_gfw.png",
  "fulfill_type": null,
  "fulfill_sla_time": 0,
  "store_created_time": 0
}

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/fulfill/pack/' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tracking_number": "BM889493738484",
    "self_shipment": {
        "courier_tracking_code": "JNT45453434343",
        "courier_name": "GHN"
    },
    "handover_method": "pickup",
    "shipping_label": "https://storage.googleapis.com/boxme-cloud/label/2023/11/OWRhYTNmODUtMGViNS00NjYwLWFlYWYtMmRjOGQzYzg3YWFh_gfw.png",
    "fulfill_type": null,
    "fulfill_sla_time": 0,
    "store_created_time": 0
}'

Responses

🟢200Success

application/json

Body

data

object

required

label_url

string

required

Shipping URL

tracking_number

string

required

Boxme Tracking number

courier_name

string

required

Courier Name

service_code

string

required

Boxme Service Code

error

boolean

required

error_code

string

required

messages

string

required

request_id

integer

required

total

integer

required

Example

{
  "data": {
    "label_url": "https://s.boxme.asia/api/v1/orders/awb-label/MzEwZWNmYTktYWY1Zi00OTM2LTk4M2EtYmE2MGM5YmYxN2Ez",
    "tracking_number": "BM65221104356",
    "courier_name": "J&T Express",
    "service_code": "BM_DBS"
  },
  "error": false,
  "error_code": "",
  "messages": "Update pack order successfully.",
  "request_id": 1703485822,
  "total": 0
}

Modified at 2025-02-20 03:08:26

Get Packed Items

Get B2B Pickup TimeSlot