Data models

Success status

Human-readable error message

Stable machine-readable error name, when provided

Machine-readable error code, when provided

POS business message code, when provided

Required permission, when access is denied

Message identifier

Platform-specific message type, such as INBOX or COMMENT

Rendered message content, which may contain HTML

Original message text before rendering

Extensible metadata for entities detected in the message

Extensible sender information supplied by the messaging platform

Whether the message has been seen

Whether the page can like the message

Whether the page has liked the message

Number of likes

Whether the page can comment on the message

Number of replies

Order ID

System ID

Shop ID

Order creation time

Order update time

Order status

Order status name

Customer name

Phone number of customer

Customer email

Conversation ID

Facebook page ID

Order ID

System ID

Shop ID

Order creation time

Order update time

Order status

Order status name

Customer name

Phone number of customer

Customer email

Conversation ID

Facebook page ID

Shipping fee

Percentage reduction on revenue

Adjustment criteria

Adjustment type

Allocation discounts

Allocation type

Bank account number

Bank name

Budget unit code

Buyer not get invoice

Creator information

General discount amount

Street address. When creating an order via API, if address is provided but province_id is left empty, the system automatically parses this free-text address to fill in province_id, district_id and commune_id. Auto-fill is skipped when the parsed location is in Thailand (country code 66) or when no commune can be resolved from the text.

Commune name

Commune ID

Country code

District ID

District name

Full address

Full name

New full address

New province ID

Phone number

Post code

Province ID

Province name

Render type

Return order ID

Display ID

Customer name

Phone number of customer

Creator ID

Custom ID

Discount total

Discount from order to returned

Created at

Updated at

Order ID

Order ID to returned

Avatar image link

Shop name

Shop currency code, for example VND

Shop ID

User-specific preferred shop rank. Lower values have higher priority

Pages information in shop

Information of link post / source / AD account with marketer

Warehouse ID

Warehouse name

Warehouse address

Warehouse full address

Warehouse phone number

Province ID. For a Viet Nam warehouse using the new (2-level, post-merger) address, this is the new province ID (e.g. 84_VN102)

District ID. Always null for a Viet Nam warehouse using the new address (no district level)

Commune ID. For a Viet Nam warehouse using the new address, this is the new commune ID (e.g. 84_VN10236)

Country code

Shop ID

Allow create order

Custom ID

Affiliate shop ID

Affiliate warehouse name

Variation-warehouse record ID

Variation ID

Warehouse ID

Shop ID

Sellable quantity. May include incoming/waiting stock depending on shop settings.

remain_quantity clamped to be non-negative (max(0, remain_quantity)).

Quantity physically on hand in the warehouse.

Total quantity recorded at this warehouse.

Quantity tied up in orders that are awaiting stock (orders placed but waiting for goods to arrive). (Field name keeps the legacy waitt- spelling.)

Quantity reserved by pending purchase orders.

Quantity currently being transferred out.

Quantity pending transfer (not yet shipped between warehouses).

Length

Width

Height

Currency code (ISO 4217)

Retail price in this currency. Requests accept a number; responses return it as a string.

Variation ID

Variation fields

Variation images

Imported price

Variation retail price

Counter price

Retail prices by currency (for shops using multiple currencies). If sent, the list is saved as is, so include every currency you want to keep. If omitted while retail_price is sent and the shop uses multiple currencies, the price of the shop's default currency is synced from retail_price.

Variation weight

Variation size (dimensions)

Variation barcode

Variation custom ID

Store cake status variation

Product name

Product weight

Measure group ID

Product type. product: Product (default). accessory: Accessory, comes with orders, has no retail price (retail price is reset to 0) and is not counted in sold quantity reports. service: Service, inventory is not managed. LOT: Product with expiry date, inventory is managed by lot and a lot must be chosen when importing or exporting stock (requires the shop to enable lot management).

Category IDs

Internal note

Product note

Product attributes

Product tags

Product custom ID

Store cake status

Product variations

Customer ID

Full name

Gender

Email addresses

Phone numbers

Customer's linked pages

Date of birth

Reward point

Discount based on level

Customer tags

Block customer

Assigned employee ID

Product ID on eCommerce platform

Linked product ID

Linked product name

Marketplace ID

Marketplace shop name

Product name on eCommerce platform

Product price

Product SKU

Product variations

Warehouse name

Transaction ID

Transaction ID

Transaction name

Note

Amount of money

Status

Locked

Is canceled

Financial accounting

Paying off debts to suppliers

Payment method

Transaction tags

Debt ID

Debt ID

Debt name

Description

Status

Debt type (0: Debt must pay / 1: Debt must collect)

Total amount to be paid / Total amount to be collected

Paid amount / Collected amount

Currency

Shop ID

Customer ID

Customer information

Project ID

Project image URL

Created timestamp

Project name

Child source orders of project

Shop ID

Updated timestamp

Source order ID

Source order image URL

Created timestamp

Source order name

Child source orders

Parent source order ID

Project ID

Shop ID

Updated timestamp

Custom source order ID

Link source ID

Product category information

Success status

Brand ID

Brand name

Brand description

Display ID

Shop ID

Created time

Updated time

Purchase ID

Purchase ID

Status

Time import

Total quantity

Total remain quantity

Total purchase price

Total remain price

Note

Warehouse ID

Supplier products ID

Supplier information

Export ID

Export ID

Export status

Type of export

Total quantity

Total export price

Note

Warehouse ID

Supplier products ID

Tag IDs

List of products

Export images

Transfer ID

Transfer ID

Status

From warehouse ID

From warehouse name

To warehouse ID

To warehouse name

Total quantity

Shipping fee

Note

List of products

Transfer images

Stocktaking ID

Stocktaking ID

Status

Warehouse ID

Stocktaking by

Category ID / Supplier products ID / Brand ID

Stocktaking at

Processing percentage

Note

List of products

Shop ID

Creator ID

Inserted at

Updated at

Updated status at

Lot ID

Lot code

Expiry date (UTC)

Manufacturing date (UTC)

Created at

Updated at

Product of the lot (variations are not included)

Variations of the product linked to this lot

Product ID

Product name

Product type, always LOT for expiry-date products

Product custom ID

Product display ID

Product image URL

Store cake status

Allow selling with negative stock

Internal note

Product note (HTML)

Measure group ID

Brand ID

ID

Call later and remind ID

Called at / Process at

Need call at / Need process at

Notice information

Order ID

Order ID

Status

Notification type

Process staff

Creator information

Phone number

Voucher ID

Voucher ID

Voucher name

Voucher type

Voucher start time

Voucher end time

Voucher promo code information

Is free shipping

Is activated

Is used

Customer tags

Shop ID

Creator ID

Inserted at

Updated at

Promotion ID

Promotion display ID

Promotion name

Promotion type

Start time

End time

Warehouse IDs

Customer tags

Order sources

Promotion group

Is activated

Is variation

Creator information

End time of the livestream session

Finisher information

Livestream session ID

Created date

Livestream session name (campaign)

Origin post ID

List of post IDs

List of inventory sync warehouse IDs

Shop ID

Start time of the livestream session

Total number of comments

Total number of customers

Order creation warehouse ID

List of items

Page number

Page size

Success status

Total entries

Total pages

Success status

Response data

Success status

Order ID or code used to trigger the call

Whether the callee picked up

Digits the callee pressed (null if none)

Success status

List of ad accounts

Current page number

Number of records per page

Total number of ad accounts

Total number of pages

Success status

List of campaigns

Aggregated performance metrics across all campaigns

Current page number

Number of records per page

Total number of campaigns

Total number of pages

Success status

List of ad sets

Aggregated performance metrics across all ad sets

Current page number

Number of records per page

Total number of ad sets

Total number of pages

Success status

List of ads

Aggregated performance metrics across all ads

Current page number

Number of records per page

Total number of ads

Total number of pages

Internal session ID. Use it for the system_id filter

Session code shown on the shop screen

Code set by the shop or the marketplace (e.g. statement ID)

Shipping partner ID on Pancake system

Session type. Very old sessions without a type are returned as all

Note

Total COD according to the carrier statement

Total shipping fee according to the carrier statement

Total COD according to POS orders

Payment time of the session

Payment status

User who created the session

User ID

User name. Null when the user was deleted from the system

Internal order ID (system_id of the order)

Order ID shown on the shop (id of the order)

Custom order code set by the shop

Tracking code from the shipping partner

Viettel Post order number

Order status at the time the order was added to the session. Same values as status of the order

Reconciliation result of the order in this session

Reason when the order could not be reconciled

COD amount according to the shipping partner. Null when this session does not reconcile COD for the order

Shipping fee according to the shipping partner

COD amount of the order on POS

Currency of the order

Reconciliation time of the order