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

Boxme API

Create Product

POST

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

Last modified:2025-03-20 05:47:40

Use this API to create a single new product.
Rate limit: 1rps/IP

Request

Header Params

Authorization

string

required

Example:

Token {{API_TOKEN}}

Content-Type

string

optional

Example:

application/json

Body Params application/json

name

string

required

Product name

<= 255 characters

seller_sku

string

required

SKU

barcode_manufacturer

string

required

Manufacture barcode, separate by commas

category_id

integer

required

Product category. Refer to Category API

brand

string

optional

Brand name.

Default:

Non-brand

description

string

required

Product description

price

number

required

Listed price

sale_price

number

required

Retail price (RSP)

wholesale_price

number

required

Wholesale price (B2B)

is_digital

boolean

required

Physical product. Default is false

min_quantity

integer

required

Threshold number

warehouse_condition

integer

required

Normal, 2. Aircond

pack_with_bubble

boolean

required

Require bubble wrap

pack_material

integer

required

weight

integer

required

Item weight (grams)

volume

string

required

Item volume. LxWxH

images

array[string]

optional

Product Images: https://imag.png

manage_by_serial_number

boolean

required

Product require aftersale service by serial number.

managed_by_gs1

boolean

required

Product use GS1 to manage product information. It is global standard

require_expire

boolean

required

Product require manage exp.

outbound_strategy

string

required

FIFO, FEFO, LIFO

shelf_life

integer

required

Shelf life. Exp:12,18,36 months

expiry_threshold

integer

required

Expire time threshold (day).

min_inbound_shelf_life

integer

required

Min inbound expire time (day)

is_fragile

boolean

required

Fragile item

use_shredded_paper

boolean

required

batch_control

boolean

required

Batch LOT control

uom

string

required

PAC, PC, SET, PAIR, BOX

protective_packaging_inbound

boolean

required

Require prepack before inbound

allow_breakdown

boolean

required

Allow automate breakdown

Example

{
  "name": "Sản Phẩm 01",
  "seller_sku": "SP00012001",
  "barcode_manufacturer": "WH23454808",
  "category_id": 3,
  "brand": "Test Brand",
  "description": "Enter when there is a QC request for the product before warehouse entry.",
  "price": 1000000,
  "sale_price": 1200000,
  "wholesale_price": 0,
  "is_digital": false,
  "min_quantity": 1,
  "warehouse_condition": 1,
  "pack_with_bubble": false,
  "pack_material": 2,
  "weight": 3000,
  "volume": "27x36x11",
  "images": [],
  "manage_by_serial_number": false,
  "managed_by_gs1": false,
  "require_expire": true,
  "outbound_strategy": "FEFO",
  "shelf_life": 12,
  "expiry_threshold": 3,
  "min_inbound_shelf_life": 6,
  "is_fragile": true,
  "use_shredded_paper": true,
  "batch_control": false,
  "uom": "PC",
  "protective_packaging_inbound": false,
  "allow_breakdown": false
}

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/create/' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Sản Phẩm 01",
    "seller_sku": "SP00012001",
    "barcode_manufacturer": "WH23454808",
    "category_id": 3,
    "brand": "Test Brand",
    "description": "Enter when there is a QC request for the product before warehouse entry.",
    "price": 1000000,
    "sale_price": 1200000,
    "wholesale_price": 0,
    "is_digital": false,
    "min_quantity": 1,
    "warehouse_condition": 1,
    "pack_with_bubble": false,
    "pack_material": 2,
    "weight": 3000,
    "volume": "27x36x11",
    "images": [],
    "manage_by_serial_number": false,
    "managed_by_gs1": false,
    "require_expire": true,
    "outbound_strategy": "FEFO",
    "shelf_life": 12,
    "expiry_threshold": 3,
    "min_inbound_shelf_life": 6,
    "is_fragile": true,
    "use_shredded_paper": true,
    "batch_control": false,
    "uom": "PC",
    "protective_packaging_inbound": false,
    "allow_breakdown": false
}'

Responses

🟢200Success

application/json

Body

data

object

required

bsin

string

required

error

boolean

required

error_code

string

required

messages

string

required

request_id

string

required

Example

{
  "data": {
    "bsin": "BSN83477384388434"
  },
  "error": false,
  "error_code": "",
  "messages": "",
  "request_id": 1703470457
}

🟠400Bad Request

Modified at 2025-03-20 05:47:40

Product API Overview

Get Category Tree