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

Boxme API

Create Returns Order

POST

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

Last modified:2024-04-05 09:21:49

Use API to create a Returns order to boxme warehouse.

Request

Path Params

tracking_number

string

required

Example:

BMxxxxxxx

Header Params

Content-Type

string

optional

Example:

application/json

Authorization

string

optional

Example:

Token {{API_TOKEN}}

Body Params application/json

pickup_id

integer

required

return_note

string

required

reason_code

string

required

courier_tracking_number

string

required

Courier tracking number show on shipping label

origin_order_number

string

required

Origin order number

combine_id

string

optional

Unique number to consolidate multiple dropship order return.

order_list

array[string]

optional

List of Return order number generate by platform

return_order_number

string

required

Return order number generate by platform

waiting_confirmation

boolean

required

items

array [object {2}]

required

quantity

integer

required

seller_sku

string

required

Example

{
  "pickup_id": 341740,
  "return_note": "// return reason ",
  "reason_code": "OTHER",
  "courier_tracking_number": "xxx",
  "origin_order_number": "xxx",
  "waiting_confirmation": false,
  "items": [
    {
      "return_note": "// return reason ",
      "quantity": 1,
      "sku": "8809625241353"
    },
    {
      "return_note": "// return reason ",
      "quantity": 1,
      "sku": "8809625241353"
    }
  ]
}

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/rma/create/BMxxxxxxx/' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "pickup_id" : 341740,
  "return_note" : "// return reason ",
  "reason_code" : "OTHER", 
  "courier_tracking_number" : "xxx", 
  "origin_order_number" : "xxx", 
  "waiting_confirmation": false,
  "items" : [
   {
    "return_note" : "// return reason ",
    "quantity" : 1,
    "sku" : "8809625241353"
   },
   {
    "return_note" : "// return reason ",
    "quantity" : 1,
    "sku" : "8809625241353"
   }
  ]
}'

Responses

🟢200Success

application/json

Body

data

object

required

return_tracking_number

string

required

Boxme return tracking number

error

boolean

required

error_code

string

required

messages

string

required

request_id

string

required

Example

{
  "data": {
    "return_tracking_number": "",
    "order_number": ""
  },
  "error": true,
  "error_code": "string",
  "messages": "string",
  "request_id": 0
}

Modified at 2024-04-05 09:21:49

Returns Flow

Get Returns Order