Update Product - Boxme API

Use this API to update attributes or SKUs of an existing product.
If the product has been approved by Boxme, you can only update some basic information, and the product may be re-approved by the operations team. New information will only be available when the operations team re-approves your product.

Request

Path Params

bsin

string

required

Example:

BSN33152982758216

Header Params

Content-Type

string

optional

Example:

application/json

Authorization

string

optional

Example:

Token {{API_TOKEN}}

Body Params application/json

name

string

optional

Product name. Can be edit before create ASN

seller_sku

string

optional

SKU. It can be edited after the product is approved.

barcode_manufacturer

string

optional

Manufacture barcode, separate by commas

category_id

integer

optional

Product category. Refer to Category API. It can be edited after the product is approved.

brand

string

optional

Product's brand. It can be edited after the product is approved.

description

string

optional

Product description. It can be edited after the product is approved

price

integer

optional

Listed price. It can be edited after the product is approved

sale_price

integer

optional

Retail price. It can be edited after the product is approved

wholesale_price

integer

optional

Wholesale price. It can be edited after the product is approved

is_digital

boolean

optional

Physical product. Default is false

Default:

false

min_quantity

integer

optional

Threshold number. It can be edited after the product is approved

warehouse_condition

integer

optional

Normal, 2. Aircond

pack_with_bubble

boolean

optional

Packaging require bubble wrap

Default:

false

pack_material

integer

optional

weight

integer

optional

Item weight.

volume

string

optional

Item volume.

images

array[string]

optional

manage_by_serial_number

boolean

optional

Product require aftersale service by serial number.

Default:

false

managed_by_gs1

boolean

optional

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

Default:

false

require_expire

boolean

optional

Product require manage exp.

Default:

false

outbound_strategy

string

optional

FIFO, FEFO, LIFO

shelf_life

integer

optional

Shelf life. Exp:12,18,36 months

expiry_threshold

integer

optional

Expire time threshold month.

min_inbound_shelf_life

integer | null

optional

Min inbound expire time (month)

is_fragile

boolean

optional

Fragile item

Default:

false

use_shredded_paper

boolean

optional

Default:

false

batch_control

boolean

optional

Batch LOT control

Default:

false

uom

string

optional

PAC, PC, SET, PAIR,

Default:

Examples:

PCSETPAIRPAC

protective_packaging_inbound

boolean

optional

Require prepack before inbound

Default:

false

allow_breakdown

boolean

optional

Allow automate breakdown

Example

{
    "seller_sku":"SKU012132",
    "category_id": 1,
    "brand": "No Band",
    "price": 100000,
    "sale_price": 120000,
    "wholesale_price": 80000
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

data

object

required

bsin

string

required

Boxme's Product ID.

name

string

required

Product Name

seller_sku

string

required

Seller SKU

barcode_manufacturer

string

required

category_id

integer

required

Refer to Product Category

brand

string

required

Brand name

description

string

required

Product description

price

integer

required

sale_price

integer

required

wholesale_price

integer

required

is_digital

boolean

required

min_quantity

integer

required

warehouse_condition

integer

required

pack_with_bubble

boolean

required

pack_material

integer

required

weight

integer

required

volume

string

required

images

array[string]

required

manage_by_serial_number

boolean

required

managed_by_gs1

boolean

required

require_expire

boolean

required

outbound_strategy

string

required

shelf_life

integer

required

expiry_threshold

integer

required

min_inbound_shelf_life

integer

required

is_fragile

boolean

required

use_shredded_paper

boolean

required

batch_control

boolean

required

uom

string

required

Refer to product UOM

protective_packaging_inbound

boolean

required

allow_breakdown

boolean

required

active

boolean

required

approve

boolean

required

error

boolean

required

error_code

string

required

messages

string

required

request_id

string

required

Example

{
    "data": {
        "bsin": "BSN33152982758216",
        "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.",
        "sale_price": 1200000,
        "price": 1000000,
        "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": true,
        "active": true,
        "approve": true
    },
    "error": false,
    "error_code": "",
    "messages": "",
    "request_id": ""
}