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

Available Stock Change Push

POST

https://s.boxme.asia/webhook-url

Last modified:2024-08-10 04:23:21

This hook is used for self-managed inventory OMS systems, deducting inventory immediately when orders are successfully transferred to the Boxme system. The available stock quantity will be considered as inventory on the OMS.

Request

Header Params

Content-Type

string

optional

Example:

application/json

Authorization

string

optional

Example:

Body Params application/json

country

string

required

seller_id

integer

required

event_type

string

required

data

object

required

bsin

string

required

seller_sku

string

required

condition_level

string

required

stock_quantity

integer

required

awaiting_quantity

integer

required

reserved_quantity

integer

required

prepack_quantity

integer

required

available_quantity

integer

required

incoming_quantity

integer

required

adjust

integer

required

pickup_id

integer

required

refer_code

string

required

refer_type

string

required

note

string

required

update_time

integer

required

request_id

string

required

timestamp

integer

required

Example

{
  "country": "VN",
  "seller_id": 331529,
  "event_type": "product.stock.change",
  "data": {
    "pickup_id": 409223,
    "bsin": "BSN33152982996791",
    "seller_sku": "TEST-0005",
    "condition_level": "A",
    "stock_quantity": 20,
    "adjust": 1,
    "awaiting_quantity": 2,
    "reversed_quantity": 10,
    "available_quantity": 8,
    "incoming_quantity": 100,
    "refer_type": "inbound",
    "refer_code": "SM-VN-331529-54200124",
    "note": "Putaway-SM-VN-331529-54200124",
    "update_time": 1696301501
  },
  "request_id": "657405ca5e492f3c6f4dd838",
  "timestamp": 1702102474
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://s.boxme.asia/webhook-url' \
--header 'Authorization: {{WEBHOOK_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "country": "VN",
    "seller_id": 331529,
    "event_type": "product.stock.change",
    "data": {
        "pickup_id": 409223,
        "bsin": "BSN33152982996791",
        "seller_sku": "TEST-0005",
        "condition_level": "A",
        "stock_quantity": 20,
        "adjust": 1,
        "awaiting_quantity": 2,
        "reversed_quantity": 10,
        "available_quantity": 8,
        "incoming_quantity": 100, 
        "refer_type": "inbound",
        "refer_code": "SM-VN-331529-54200124",
        "note": "Putaway-SM-VN-331529-54200124",
        "update_time": 1696301501
    },
    "request_id": "657405ca5e492f3c6f4dd838",
    "timestamp": 1702102474
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-08-10 04:23:21

Shipment (ASN) Status Push

Inventory Change Push