Tham chiếu chung

Mô hình dữ liệu

Các đối tượng dùng chung trong yêu cầu, phản hồi và webhook.

Xem Markdown

ErrorResponse

ErrorResponsePhản hồi lỗi nghiệp vụ hoặc lỗi yêu cầu
successbooleanbắt buộc

Trạng thái thành công

Giá trịfalse
messagestring

Thông báo lỗi dễ đọc

errorstring

Tên lỗi ổn định dành cho máy xử lý, nếu có

error_codeinteger

Mã lỗi dành cho máy xử lý, nếu có

message_codeinteger

Mã thông báo nghiệp vụ POS, nếu có

permissionstring

Quyền bắt buộc khi truy cập bị từ chối

OrderMessage

OrderMessageTin nhắn đã render trong hội thoại liên kết với đơn hàng. Các thuộc tính có thể không xuất hiện khi chỉ định `fields[]`.
idstring

Mã tin nhắn

typestringnull

Loại tin nhắn theo nền tảng, ví dụ INBOX hoặc COMMENT

messagestring

Nội dung tin nhắn đã render, có thể chứa HTML

original_messagestringnull

Nội dung tin nhắn gốc trước khi render

message_tagsarray<object>

Metadata mở rộng của các thực thể được phát hiện trong tin nhắn

fromobject

Thông tin người gửi có thể mở rộng do nền tảng nhắn tin cung cấp

seenboolean

Tin nhắn đã được xem hay chưa

can_likeboolean

Trang có thể thích tin nhắn hay không

user_likesboolean

Trang đã thích tin nhắn hay chưa

like_countintegernull

Số lượt thích

can_commentboolean

Trang có thể bình luận vào tin nhắn hay không

comment_countintegernull

Số lượng phản hồi

Order

OrderThông tin đơn hàng
idinteger

Mã đơn hàng

system_idinteger

Mã hệ thống

shop_idinteger

Mã cửa hàng

inserted_atstring · date-time

Thời điểm tạo đơn

updated_atstring · date-time

Thời điểm cập nhật đơn

statusinteger

Trạng thái đơn hàng

Giá trị0Mới17Chờ xác nhận11Chờ hàng12Chờ in13Đã in20Đã đặt hàng1Đã xác nhận8Đang đóng hàng9Chờ chuyển hàng2Đã gửi hàng3Đã nhận16Đã thu tiền4Đang hoàn15Hoàn một phần5Đã hoàn6Đã hủy7Đã xóa
status_namestring

Tên trạng thái đơn hàng

bill_full_namestring

Tên khách hàng

bill_phone_numberstring

SĐT khách hàng

bill_emailstring

Email khách hàng

conversation_idstring

Mã hội thoại

page_idstring

Mã Facebook page

OrderInfo

OrderInfo
idinteger

Mã đơn hàng

system_idinteger

Mã hệ thống

shop_idinteger

Mã cửa hàng

inserted_atstring · date-time

Thời điểm tạo đơn

updated_atstring · date-time

Thời điểm cập nhật đơn

statusinteger

Trạng thái đơn hàng

Giá trị0Mới17Chờ xác nhận11Chờ hàng12Chờ in13Đã in20Đã đặt hàng1Đã xác nhận8Đang đóng hàng9Chờ chuyển hàng2Đã gửi hàng3Đã nhận16Đã thu tiền4Đang hoàn15Hoàn một phần5Đã hoàn6Đã hủy7Đã xóa
status_namestring

Tên trạng thái đơn hàng

bill_full_namestring

Tên khách hàng

bill_phone_numberstring

SĐT khách hàng

bill_emailstring

Email khách hàng

conversation_idstring

Mã hội thoại

page_idstring

Mã Facebook page

EInvoice

EInvoiceThông tin hóa đơn điện tử
actual_shipping_feeinteger

Phí vận chuyển

adjust_amountintegercó thể null

Phần trăm giảm trên doanh thu

adjustment_criteriaintegercó thể null

Tiêu chí điều chỉnh

Giá trị1Điều chỉnh số lượng2Điều chỉnh đơn giá3Điều chỉnh thuế suất4Điều chỉnh tiền thuế
adjustment_typeintegercó thể null

Loại điều chỉnh

Giá trị1Điều chỉnh tăng2Điều chỉnh giảm3Thông tin
allocation_discountsarray<object>

Phân bổ chiết khấu

allocation_typeinteger

Loại phân bổ

Giá trị1Theo đơn giá2Tùy chỉnh
bank_account_numberstringcó thể null

Số tài khoản ngân hàng

bank_namestringcó thể null

Tên ngân hàng

budget_unit_codestringcó thể null

Mã đơn vị ngân sách

buyer_not_get_invoiceboolean

Người mua không nhận hóa đơn

creatorobjectcó thể null

Thông tin người tạo

discountinteger

Giảm giá chung

ShippingAddress

ShippingAddressĐịa chỉ giao hàng
addressstringcó thể null

Địa chỉ. Khi tạo đơn qua API, nếu có address nhưng province_id để trống, hệ thống sẽ tự động phân tích địa chỉ dạng văn bản này để điền province_id, district_id và commune_id. Bỏ qua tự động điền nếu địa chỉ thuộc Thái Lan (mã quốc gia 66) hoặc không xác định được phường/xã từ nội dung.

commnue_namestringcó thể null

Tên phường/xã

commune_idstringcó thể null

Mã phường/xã

country_codestringcó thể null

Mã quốc gia

district_idstringcó thể null

Mã quận/huyện

district_namestringcó thể null

Tên quận/huyện

full_addressstringcó thể null

Địa chỉ đầy đủ

full_namestringcó thể null

Họ và tên

new_full_addressstringcó thể null

Địa chỉ đầy đủ mới

new_province_idstringcó thể null

Mã tỉnh/thành mới

phone_numberstringcó thể null

Số điện thoại

post_codestringcó thể null

Mã bưu điện

province_idstringcó thể null

Mã tỉnh/thành

province_namestringcó thể null

Tên tỉnh/thành

render_typestringcó thể null

Loại hiển thị

ReturnOrder

ReturnOrderThông tin đơn hàng đổi trả
idinteger

Mã đơn hàng đổi trả

display_idinteger

Mã hiển thị

bill_full_namestring

Tên khách hàng

bill_phone_numberstring

SĐT khách hàng

creator_idstring

Mã người tạo

custom_idstring

Mã tùy chỉnh

discountinteger

Tổng giảm giá

discount_from_order_to_returnedinteger

Giảm giá từ đơn hàng gốc

inserted_atstring · date-time

Thời điểm tạo

updated_atstring · date-time

Thời điểm cập nhật

order_idinteger

Mã đơn hàng

order_id_to_returnedinteger

Mã đơn hàng cần trả

Shop

ShopThông tin cửa hàng
avatar_urlstring

Link hình đại diện

namestring

Tên cửa hàng

currencystring

Mã tiền tệ của cửa hàng, ví dụ VND

idinteger

Mã cửa hàng

preferred_shopintegernull

Thứ tự ưu tiên cửa hàng của người dùng. Giá trị nhỏ hơn có độ ưu tiên cao hơn

pagesarray<object>

Thông tin pages được gộp trong shop

link_post_marketerarray<object>

Thông tin liên kết bài viết / nguồn đơn / TK QC với marketer

Warehouse

WarehouseThông tin kho hàng
idstring

Mã kho hàng

namestring

Tên kho hàng

addressstring

Địa chỉ chi tiết kho hàng(số nhà, đường, ...)

full_addressstring

Địa chỉ đầy đủ kho hàng

phone_numberstring

Số điện thoại kho hàng

province_idstring

Mã tỉnh thành phố. Với kho Việt Nam dùng địa chỉ mới (2 cấp, sau sáp nhập), đây là mã tỉnh mới (vd 84_VN102)

district_idstringcó thể null

Mã quận huyện. Luôn null với kho Việt Nam dùng địa chỉ mới (không còn cấp huyện)

commune_idstringcó thể null

Mã phường xã. Với kho Việt Nam dùng địa chỉ mới, đây là mã phường xã mới (vd 84_VN10236)

country_codestring

Mã quốc gia

shop_idinteger

Mã cửa hàng

allow_create_orderboolean

Kho hàng có thể tạo đơn hàng

custom_idstring

Mã tuỳ chỉnh kho hàng

affiliate_shop_idinteger

Mã cửa hàng liên kết

affiliate_warehousestring

Tên kho hàng liên kết

VariationWarehouse

VariationWarehouseChi tiết tồn kho của một mẫu mã tại từng kho.
idstring

Mã bản ghi tồn kho (variation_warehouse)

variation_idstring

Mã mẫu mã

warehouse_idstring

Mã kho

shop_idinteger

Mã shop

remain_quantityinteger

Số lượng có thể bán. Có thể đã cộng hàng đang về/chờ tùy cấu hình shop.

available_quantityinteger

remain_quantity đã chặn không âm (max(0, remain_quantity)).

actual_remain_quantityinteger

Số lượng thực tế đang có trong kho.

total_quantityinteger

Tổng số lượng ghi nhận tại kho.

waitting_quantityinteger

Số lượng nằm trong các đơn đang chờ hàng. (Tên field giữ cách viết cũ waitt-.)

pending_quantityinteger

Số lượng bị giữ bởi phiếu nhập đang chờ.

transfer_quantityinteger

Số lượng đang chuyển đi.

pending_transfer_quantityinteger

Số lượng chờ chuyển kho (chưa xuất đi).

VariationSize

VariationSizeKích thước mẫu mã
lengthinteger

Chiều dài

widthinteger

Chiều rộng

heightinteger

Chiều cao

RetailPriceByCurrency

RetailPriceByCurrencyGiá bán của mẫu mã theo 1 loại tiền tệ
currencystringbắt buộc

Mã tiền tệ (ISO 4217)

Ví dụ: "USD"
retailPriceByCurrencynumberstringbắt buộc

Giá bán theo tiền tệ này. Request truyền dạng số; response trả về dạng chuỗi.

Ví dụ: 100

Variation

VariationThông tin mẫu mã sản phẩm
idstring

Mã mẫu mã

fieldsarray<object>

Thông tin thuộc tính mẫu mã

imagesarray<string · uri>

Link hình ảnh mẫu mã

last_imported_priceinteger

Giá nhập

retail_priceinteger

Giá bán mẫu mã

price_at_counterinteger

Giá tại quầy

retail_price_by_currencyarray<RetailPriceByCurrency>

Giá bán theo từng loại tiền tệ (dùng cho shop bật đa tiền tệ). Khi truyền, danh sách sẽ được lưu nguyên như gửi lên, vì vậy cần truyền đầy đủ các loại tiền tệ muốn giữ. Nếu không truyền nhưng có retail_price và shop bật đa tiền tệ, giá của tiền tệ mặc định của shop sẽ được đồng bộ theo retail_price.

weightinteger

Khối lượng mẫu mã

sizeVariationSize

Kích thước mẫu mã

barcodestring

Mã barcode mẫu mã

custom_idstring

Mã tuỳ chỉnh mẫu mã

is_hiddenboolean

Trạng thái StoreCake is_hidden = true -> Ẩn, is_hidden = false -> Hiện

Product

ProductThông tin sản phẩm
namestringbắt buộc

Tên sản phẩm

weightintegerbắt buộc

Trọng lượng sản phẩm

measure_group_idinteger

Mã nhóm đơn vị tính

Ví dụ: 58
typestring

Loại hình sản phẩm. product: Sản phẩm (mặc định). accessory: Phụ kiện, đi kèm đơn hàng, không có giá bán (giá bán được đưa về 0) và không tính vào số lượng hàng bán được trong báo cáo. service: Dịch vụ, không cần quản lý tồn kho. LOT: Sản phẩm có HSD, quản lý tồn kho theo lô hạn sử dụng, bắt buộc chọn lô khi nhập/xuất kho (shop cần bật quản lý lô).

Giá trị"product""accessory""service""LOT"
Ví dụ: "product"
category_idsarray<integer>

Danh sách mã danh mục

notestring

Ghi chú nội bộ

note_productstring

Ghi chú sản phẩm

product_attributesarray<object>

Thuộc tính sản phẩm

tagsarray<integer>

Thẻ sản phẩm

custom_idstring

Mã tùy chỉnh sản phẩm

is_publishedboolean

Trạng thái Store cake

variationsarray<Variation>

Danh sách mẫu mã

Customer

CustomerThông tin khách hàng
idstring

Mã khách hàng

namestring

Họ tên đầy đủ

genderstring

Giới tính

emailsarray<string>

Danh sách email

phone_numbersarray<string>

Danh sách số điện thoại

pages_customersarray<object>

Danh sách page khách hàng

date_of_birthstring · date

Ngày sinh

reward_pointnumber

Điểm thưởng

is_discount_by_levelboolean

Giảm giá theo cấp độ

tagsarray<string>

Thẻ khách hàng

is_blockboolean

Chặn khách hàng

assigned_user_idstring

Mã nhân viên được phân công

eCommerceProduct

eCommerceProductThông tin sản phẩm trên sàn thương mại điện tử
idstring

Mã sản phẩm trên sàn

Ví dụ: "46152996242"
linked_product_custom_idstring

Mã sản phẩm liên kết

Ví dụ: "ANPR"
linked_product_namestring

Tên sản phẩm liên kết

Ví dụ: "Áo nam Pari đẹp thời trang"
marketplace_idstring

Mã sàn thương mại điện tử

Ví dụ: "-3"
marketplace_shop_namestring

Tên shop trên sàn thương mại điện tử

Ví dụ: "Vũ Sơn shop"
namestring

Tên sản phẩm trên sàn thương mại điện tử

Ví dụ: "Áo nam Pari đẹp thời trang"
priceinteger

Giá sản phẩm

Ví dụ: 0
skustring

Mã SKU sản phẩm

Ví dụ: "ANPR"
variationsarray<object>

Danh sách mẫu mã sản phẩm

warehousestring

Tên kho hàng

Ví dụ: "Kho HN"

Transaction

TransactionThông tin thu chi
idstring

Mã thu chi

display_idstring

Mã thu chi

namestring

Tên giao dịch

notestring

Ghi chú

amountinteger

Số tiền

statusinteger

Trạng thái

Giá trị-1Tất cả trạng thái0Mới1Có hiệu lực2Đã hủy3Đã xóa
is_lockedboolean

Khóa

is_canceledboolean

Đã hủy

is_accountingboolean

Kế toán tài chính

payment_debts_to_suppliersboolean

Trả nợ nhà cung cấp

paymentsarray<string>

Phương thức thanh toán

tag_idsarray<string>

Thẻ giao dịch

Debt

DebtThông tin công nợ
idstring

Mã công nợ

display_idinteger

Mã công nợ

name_debtstring

Tên công nợ

descriptionstring

Mô tả

statusinteger

Trạng thái

Giá trị-1Tất cả trạng thái0Chưa giao dịch / Thanh toán một phần1Đã giao dịch2Đã hủy
typeinteger

Loại công nợ (0: Công nợ phải trả / 1: Công nợ phải thu)

money_must_pay_or_collectinteger

Tổng số tiền phải trả / Tổng số tiền phải thu

money_payed_or_collectedinteger

Số tiền đã trả / Số tiền đã thu

currencystring

Tiền tệ

shop_idinteger

Mã shop

shop_customer_idstring

Mã khách hàng

shop_customerobject

Thông tin khách hàng

Project

ProjectThông tin dự án
idinteger

Mã dự án

imagestring · uricó thể null

URL hình ảnh dự án

inserted_atstring · date-time

Thời điểm tạo

namestring

Tên dự án

nodesarray<ProjectNode>

Danh sách nguồn đơn hàng thuộc dự án

shop_idinteger

Mã shop

updated_atstring · date-time

Thời điểm cập nhật

ProjectNode

ProjectNodeThông tin nút dự án
idinteger

Mã nguồn đơn hàng

imagestring · uricó thể null

URL hình ảnh nguồn đơn hàng

inserted_atstring · date-time

Thời điểm tạo

namestring

Tên nguồn đơn hàng

nodesarray<ProjectNode>

Danh sách nguồn đơn hàng con

parent_idintegercó thể null

Mã nguồn đơn hàng cha

project_idintegercó thể null

Mã dự án

shop_idinteger

Mã shop

updated_atstring · date-time

Thời điểm cập nhật

custom_idstringcó thể null

Mã tùy chỉnh nguồn đơn hàng

link_source_idintegercó thể null

Mã nguồn liên kết

Category

Category
dataobject

Thông tin danh mục sản phẩm

successboolean

Trạng thái thành công

Brand

BrandThông tin thương hiệu sản phẩm
idstring · uuid

Mã thương hiệu

namestring

Tên thương hiệu

descriptionstringcó thể null

Mô tả thương hiệu

display_idinteger

Mã hiển thị

shop_idinteger

Mã shop

inserted_atstring · date-time

Thời gian tạo

updated_atstring · date-time

Thời gian cập nhật

Purchase

PurchaseThông tin phiếu nhập kho
idstring

Mã phiếu nhập kho

display_idinteger

Mã phiếu nhập kho

statusinteger

Trạng thái

Giá trị-2Tất cả trạng thái-1Mới0Đã xác nhận1Đã nhập hàng2Đã hủy
time_importstring · date-time

Thời gian nhập hàng

total_quantityinteger

Tổng số lượng

total_remain_quantityinteger

Tổng số lượng tồn

total_priceinteger

Tổng giá trị nhập kho

total_remain_priceinteger

Tổng giá trị tồn

notestring

Ghi chú

warehouse_idstring

Mã kho

supplier_products_idinteger

Mã nhà cung cấp

supplierobject

Thông tin nhà cung cấp

Export

ExportThông tin phiếu xuất kho
idstring

Mã phiếu xuất kho

display_idinteger

Mã phiếu xuất kho

statusinteger

Trạng thái phiếu xuất

Giá trị0Mới (type 0) / Xuất hàng lỗi (type 1)1Hoàn tất (type 0) / Xuất bỏ (type 1)2Đã hủy
typeinteger

Loại phiếu xuất kho

Giá trị0Phiếu xuất thường1Xuất hàng lỗi
totalinteger

Tổng số lượng

total_priceinteger

Tổng giá trị xuất kho

notestring

Ghi chú

warehouse_idstring

Mã kho

supplier_products_idinteger

Mã nhà cung cấp

tagsarray<integer>

Danh sách mã thẻ

export_itemsarray<object>

Danh sách sản phẩm

imagesarray<string · uri>

Link hình ảnh phiếu xuất kho

WarehouseTransfer

WarehouseTransferThông tin chuyển kho
idstring

Mã chuyển kho

display_idinteger

Mã chuyển kho

statusinteger

Trạng thái

Giá trị0Chờ chuyển hàng1Đang chuyển hàng2Hoàn tất
from_warehouse_idstring

Mã kho đi

from_warehouse_namestring

Tên kho đi

to_warehouse_idstring

Mã kho đến

to_warehouse_namestring

Tên kho đến

total_quantityinteger

Tổng số lượng

shipping_feeinteger

Phí vận chuyển

notestring

Ghi chú

itemsarray<object>

Danh sách sản phẩm

imagesarray<string · uri>

Link hình ảnh chuyển kho

Stocktaking

StocktakingThông tin kiểm hàng
idstring

Mã phiếu kiểm

display_idinteger

Mã phiếu kiểm

statusinteger

Trạng thái

Giá trị-2Tất cả trạng thái-1Đang tạo0Đang kiểm hàng1Đã kiểm hàng2Đã hủy
warehouse_idstring

Mã kho

stocktaking_bystring

Kiểm hàng theo

stocktaking_by_valuearray<string>

Danh sách mã danh mục / nhà cung cấp / thương hiệu

stocktaking_atstring · date-time

Kiểm hàng lúc

progressinteger

Phần trăm xử lý

notestring

Ghi chú

itemsarray<object>

Danh sách sản phẩm

shop_idinteger

Mã shop

creator_idstring

Mã người tạo

inserted_atstring · date-time

Thời điểm tạo

updated_atstring · date-time

Thời điểm cập nhật

updated_status_atstring · date-time

Thời điểm cập nhật trạng thái

LotProduct

LotProductLô hạn sử dụng của sản phẩm
idstring

ID lô

custom_idstring

Mã lô

expire_datestring · date-time

Hạn sử dụng (UTC)

manufacturing_datestring · date-time

Ngày sản xuất (UTC)

inserted_atstring · date-time

Thời điểm tạo

updated_atstring · date-time

Thời điểm cập nhật

productLotProductInfo

Sản phẩm của lô (không kèm danh sách mẫu mã)

lot_variationsarray<object>

Các mẫu mã của sản phẩm được gắn với lô

LotProductInfo

LotProductInfoSản phẩm của lô (không kèm danh sách mẫu mã)
idstring

Mã sản phẩm

namestring

Tên sản phẩm

typestring

Loại hình sản phẩm, luôn là LOT với sản phẩm có HSD

Ví dụ: "LOT"
custom_idstringcó thể null

Mã tùy chỉnh sản phẩm

display_idinteger

ID hiển thị sản phẩm

imagestringcó thể null

Link ảnh sản phẩm

is_publishedbooleancó thể null

Trạng thái Store cake

is_sell_negativebooleancó thể null

Cho phép bán âm

notestringcó thể null

Ghi chú nội bộ

note_productstring

Ghi chú sản phẩm (HTML)

measure_group_idintegercó thể null

Mã nhóm đơn vị tính

brand_idstringcó thể null

Mã thương hiệu

CallLater

CallLaterThông tin hẹn gọi & nhắc nhở
idstring

Mã

display_idinteger

Mã hẹn gọi & nhắc nhở

called_atstring · date-time

Thời điểm gọi / Thời điểm xử lý

needs_call_atstring · date-time

Thời điểm cần gọi / Thời điểm cần xử lý

notice_createdstring

Thông tin thông báo

order_display_idstring

Mã đơn hàng

order_idinteger

Mã đơn hàng

statusinteger

Trạng thái

Giá trị-1Tất cả trạng thái0Chưa xử lý3Đang gọi / Đang xử lý1Đã xử lý2Không nghe máy / Không thành công7Đã xóa
typestring

Loại thông báo

need_notify_usersarray<string>

Nhân viên xử lý

creatorobject

Thông tin người tạo

phone_numberstring

Số điện thoại

Voucher

VoucherThông tin mã giảm giá
idstring

Mã giảm giá

display_idinteger

Mã giảm giá

namestring

Tên mã giảm giá

typestring

Loại mã giảm giá

start_timestring · date-time

Thời điểm bắt đầu

end_timestring · date-time

Thời điểm kết thúc

promo_code_infoobject

Thông tin mã giảm giá

is_free_shippingboolean

Miễn phí vận chuyển

is_activatedboolean

Kích hoạt

is_usedboolean

Đã sử dụng

customer_tagsarray<string>

Thẻ khách hàng

shop_idinteger

Mã shop

creator_idstring

Mã người tạo

inserted_atstring · date-time

Thời điểm tạo

updated_atstring · date-time

Thời điểm cập nhật

Promotion

PromotionThông tin khuyến mãi
idstring

Mã khuyến mãi

display_idstring

Mã hiển thị khuyến mãi

namestring

Tên khuyến mãi

typestring

Loại khuyến mãi

start_timestring · date-time

Thời điểm bắt đầu

end_timestring · date-time

Thời điểm kết thúc

warehouse_idsarray<string>

Danh sách mã kho

customer_tagsarray<string>

Thẻ khách hàng

order_sourcesarray<object>

Nguồn đơn hàng

group_namestring

Nhóm khuyến mãi

is_activatedboolean

Đã kích hoạt

is_variationboolean

Khuyến mãi theo mẫu mã

LivestreamManager

LivestreamManagerThông tin phiên livestream
creatorobject

Thông tin người tạo

end_timestring

Thời gian kết thúc phiên livestream

finisherobject

Thông tin người kết thúc

idstring

Mã phiên livestream

inserted_atstring

Ngày tạo

namestring

Tên phiên livestream (chiến dịch)

origin_post_idstring

Mã bài viết gốc

post_idsarray<string>

Danh sách bài viết

remain_warehouse_idsarray<string>

Danh sách mã kho đồng bộ tồn

shop_idinteger

Mã shop

start_timestring

Thời gian bắt đầu phiên livestream

total_commentsinteger

Tổng số bình luận

total_customersinteger

Tổng số khách hàng

warehouse_idstring

Mã kho tạo đơn

PaginatedResponse

PaginatedResponsePhản hồi phân trang
dataarray<any>

Danh sách mục

page_numberinteger

Số trang

page_sizeinteger

Kích thước trang

successboolean

Trạng thái thành công

total_entriesinteger

Tổng số bản ghi

total_pagesinteger

Tổng số trang

SimpleResponse

SimpleResponsePhản hồi đơn giản với trạng thái thành công
successboolean

Trạng thái thành công

DataResponse

DataResponsePhản hồi với dữ liệu và trạng thái thành công
dataany

Dữ liệu phản hồi

successboolean

Trạng thái thành công

WebhookOrderResponse

WebhookOrderResponsePhản hồi webhook khi webhook_types bao gồm orders

WebhookCustomerResponse

WebhookCustomerResponsePhản hồi webhook khi webhook_types bao gồm customers

WebhookProductResponse

WebhookProductResponsePhản hồi webhook khi webhook_types bao gồm products
dataobject

WebhookInventoryResponse

WebhookInventoryResponsePhản hồi webhook khi webhook_types bao gồm variations_warehouses
dataobject

WebhookAutoCallResponse

WebhookAutoCallResponseKết quả Auto Voice được gửi một lần tới webhook URL đã cấu hình. Trả về HTTP 200 để xác nhận đã nhận.
typestring
Ví dụ: "auto_call"
shop_idinteger
Ví dụ: 4
order_idstring

Mã đơn hàng đã kích hoạt cuộc gọi

Ví dụ: "1418"
phone_numberstring
Ví dụ: "0973667874"
answeredboolean

Khách có nghe máy hay không

Ví dụ: true
dtmfstringcó thể null

Phím khách bấm (null nếu không)

Ví dụ: "1"

AdAccount

AdAccountDanh sách tài khoản quảng cáo
successboolean

Trạng thái thành công

dataarray<object>

Danh sách tài khoản quảng cáo

page_numberinteger

Trang hiện tại

page_sizeinteger

Số bản ghi mỗi trang

total_entriesinteger

Tổng số tài khoản quảng cáo

total_pagesinteger

Tổng số trang

CampaignListResponse

CampaignListResponse
successboolean

Trạng thái thành công

dataarray<object>

Danh sách chiến dịch

summaryobject

Tổng hợp chỉ số hiệu suất của tất cả chiến dịch

page_numberinteger

Trang hiện tại

page_sizeinteger

Số bản ghi mỗi trang

total_entriesinteger

Tổng số chiến dịch

total_pagesinteger

Tổng số trang

AdSetListResponse

AdSetListResponse
successboolean

Trạng thái thành công

dataarray<object>

Danh sách nhóm quảng cáo

summaryobject

Tổng hợp chỉ số hiệu suất của tất cả nhóm quảng cáo

page_numberinteger

Trang hiện tại

page_sizeinteger

Số bản ghi mỗi trang

total_entriesinteger

Tổng số nhóm quảng cáo

total_pagesinteger

Tổng số trang

AdListResponse

AdListResponse
successboolean

Trạng thái thành công

dataarray<object>

Danh sách quảng cáo

summaryobject

Tổng hợp chỉ số hiệu suất của tất cả quảng cáo

page_numberinteger

Trang hiện tại

page_sizeinteger

Số bản ghi mỗi trang

total_entriesinteger

Tổng số quảng cáo

total_pagesinteger

Tổng số trang

Reconciliation

ReconciliationPhiếu đối soát kèm các đơn thuộc phiếu
system_idinteger

Mã nội bộ của phiếu. Dùng cho bộ lọc system_id

display_idinteger

Mã phiếu hiển thị trên màn hình shop

custom_idstringcó thể null

Mã do shop hoặc sàn tự đặt (ví dụ mã sao kê)

partner_idstringcó thể null

ID đơn vị vận chuyển trên hệ thống Pancake

control_typestring

Loại phiếu. Phiếu rất cũ chưa có loại được trả về all

Giá trị"control_cod"Đối soát COD"control_fee"Đối soát phí vận chuyển"all"Đối soát cả COD và phí vận chuyển"merge"Phiếu gộp từ đơn
notestringcó thể null

Ghi chú

excel_codintegercó thể null

Tổng COD theo bảng kê của đơn vị vận chuyển

excel_feeintegercó thể null

Tổng phí vận chuyển theo bảng kê của đơn vị vận chuyển

pos_codintegercó thể null

Tổng COD theo đơn trên POS

paid_atstring · date-timecó thể null

Thời điểm thanh toán phiếu

payment_statusstring

Trạng thái thanh toán

Giá trị"paid"Đã thanh toán"unpaid"Chưa thanh toán
creatoranycó thể null

Người tạo phiếu

ReconciliationUser

ReconciliationUser
idstring · uuid

Mã người dùng

namestringcó thể null

Tên người dùng. Null khi người dùng đã bị xóa khỏi hệ thống

ReconciliationOrder

ReconciliationOrderThông tin đơn trong phiếu đối soát
order_idinteger

Mã nội bộ của đơn hàng (system_id của đơn)

display_idintegercó thể null

Mã đơn hiển thị trên shop (id của đơn)

custom_idstringcó thể null

Mã đơn do shop tự đặt

extend_codestringcó thể null

Mã vận đơn của đơn vị vận chuyển

order_number_vtpstringcó thể null

Mã đơn Viettel Post

order_statusintegercó thể null

Trạng thái đơn tại thời điểm đưa vào phiếu. Cùng giá trị với status của đơn hàng

resultstringcó thể null

Kết quả đối soát của đơn trong phiếu

Giá trị"succeed"Khớp"mismatch"Lệch số tiền"failed"Không đối soát được (không tìm thấy đơn hoặc không hợp lệ)
messagestringcó thể null

Lý do đơn không đối soát được

cod_amountintegercó thể null

Số COD theo đơn vị vận chuyển. Null khi phiếu này không đối soát COD cho đơn

partner_feeintegercó thể null

Phí vận chuyển theo đơn vị vận chuyển

pos_codintegercó thể null

Số COD của đơn trên POS

currencystringcó thể null

Tiền tệ của đơn

reconciliation_atstring · date-timecó thể null

Thời điểm đối soát của đơn