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

Boxme API

Get Stock Available

POST

https://s.boxme.asia/api/v2.1/sellers/products/get_stock/

Last modified:2024-08-05 06:18:31

Get stock detail by batch SKU. Limit access 20 sku.
Rate limit: 1rps/IP

Request

Header Params

Content-Type

string

required

Example:

application/json

Authorization

string

optional

Example:

Token {{API_TOKEN}}

Body Params application/json

seller_skus

array[string]

required

Example

{
  "seller_skus": [
    "TEST-0002"
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://s.boxme.asia/api/v2.1/sellers/products/get_stock/' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "seller_skus": [
    "TEST-0002"
  ]
}'

Responses

🟢200Success

application/json

Body

data

object

required

inventory

array [object {11}]

required

error

boolean

required

error_code

string

required

messages

string

required

request_id

string

required

Example

{
  "data": {
    "inventory": [
      {
        "bsin": "BSN33152905437334",
        "seller_sku": "KIEN_TEST_1",
        "total_stock_quantity": 100,
        "total_awaiting_quantity": 0,
        "total_reserved_quantity": 0,
        "total_available_quantity": 100,
        "total_incoming_quantity": 0,
        "total_damaged_stock_quantity": 0,
        "total_damaged_awaiting_quantity": 0,
        "total_damaged_available_quantity": 0,
        "warehouse_inventory": [
          {
            "pickup_id": 345185,
            "stock_quantity": 100,
            "awaiting_quantity": 0,
            "reserved_quantity": 0,
            "available_quantity": 100,
            "incoming_quantity": 0,
            "damaged_stock_quantity": 0,
            "damaged_awaiting_quantity": 0,
            "damaged_available_quantity": 0,
            "damaged_details": [
              {
                "condition_level": "D3",
                "stock_quantity": 20,
                "awaiting_quantity": 0,
                "available_quantity": 20
              },
              {
                "condition_level": "D2",
                "stock_quantity": 50,
                "awaiting_quantity": 3,
                "available_quantity": 47
              }
            ]
          }
        ]
      }
    ]
  },
  "error": false,
  "error_code": "",
  "messages": "",
  "request_id": "65c19fb30bd0a63e993144f2"
}

Modified at 2024-08-05 06:18:31

Update Product

Reserved Stock