INTRODUCTION

Welcome to the Pancake Pos API! You can use our API to access Pancake Pos API endpoints that can get information about orders in our database.

COMMON CONFIGURATION

ENVIRONMENT

• Production base url: https://pos.pages.fm/api/v1

ACCOUNT AUTHENTICATION

api_key

CREATE API KEY

Go website Setting -> Application
On frame API KEY, click Create

Shop

Shop information

GET /shops?api_key=<api_key> HTTP/1.1

Response

{
  "shops": [
    {
      "avatar_url": "https://statics.pancake.vn/user-content-dev2.pancake.vn/2022/7/6/8678250807b2285e2752ac2cbbf43925f19a677c.jpeg",
      "name": "Shop thời trang",
      "id": 6036602,
      "link_post_marketer": [
        {
          "ad_account_id": null,
          "id": "949f1396-f6fa-45d9-93b6-4c37503a9950",
          "inserted_at": "2025-08-21T03:02:04",
          "marketer": "cee3c05e-5f85-43c4-b27e-889b99c50097",
          "multiple_post": [],
          "multiple_source": [
            {
              "account": "2284322048329488",
              "key": "-1",
              "page_id": "2284322048329488"
            }
          ],
          "shop_id": 6036602,
          "type": "source"
        },
      ],
      "pages": [
        {
          "id": "104438181227821",
          "name": "Quần áo",
          "platform": "facebook",
          "settings": {
            "auto_create_order": true
          },
          "shop_id": 20,
        }
      ]
    }
  ],
  "success": true
}

Response Parameters

Parameter	Type	Description
avatar_url	string	Avatar image link
name	string	Shop name
id	number	Shop id
pages	array	Pages information in shop
link_post_marketer	array	Information of link post / source / AD account with marketer
link_post_marketer[].ad_account_id	string	AD account ID
link_post_marketer[].id	string	Link ID
link_post_marketer[].inserted_at	string	Creation time
link_post_marketer[].marketer	string	Marketer id
link_post_marketer[].multiple_post	array	Post ID
link_post_marketer[].multiple_source	array	Source information
link_post_marketer[].type	string	Type of link (post: "Post", source: "Source", ad_account_id: "AD account")

Address

List of provinces and cities

GET /geo/provinces HTTP/1.1

Response

{
  "data": [
    {
      "id": "101",
      "name": "Hà Nội",
      "name_en": "ha noi",
      "new_id": "84_VN101"
    },
    {
      "id": "701",
      "name": "Hồ Chí Minh",
      "name_en": "ho chi minh",
      "new_id": "84_VN129"
    },
    {
      "id": "221",
      "name": "Bắc Giang",
      "name_en": "bac giang",
      "new_id": "84_VN102"
    },
    {
      "id": "207",
      "name": "Bắc Kạn",
      "name_en": "bac kan",
      "new_id": "84_VN110"
    },
    {
      "id": "821",
      "name": "Bạc Liêu",
      "name_en": "bac lieu",
      "new_id": "84_VN134"
    },
    ...
  ]
}

HTTP Request

GET /geo/provinces

Query Parameters

Parameter	Required	Type	Default	Description
country_code	true	string	84	Country code (for example, Vietnam country code is 84)
is_new	false	boolean	false	New province (for country Viet Nam)
all	false	boolean	false	All provinces including old and new (for country Viet Nam)

Response Parameters

Parameter	Type	Description
id	string	Province ID
name	string	Province name
name_en	string	English name
new_id	string	New province ID (for country Viet Nam)

List of districts

GET /geo/districts HTTP/1.1

Response

{
  "data": [
    {
      "id": "10101",
      "name": "Quận Ba Đình",
      "name_en": "ba dinh",
      "province_id": "101"
    },
    {
      "id": "10129",
      "name": "Huyện Ba Vì",
      "name_en": "ba vi",
      "province_id": "101"
    },
    {
      "id": "10155",
      "name": "Quận Bắc Từ Liêm",
      "name_en": "bac tu liem",
      "province_id": "101"
    },
    {
      "id": "10113",
      "name": "Quận Cầu Giấy",
      "name_en": "cau giay",
      "province_id": "101"
    },
    ...
  ]
}

HTTP Request

GET /geo/districts

Query Parameters

Parameter	Required	Type	Default	Description
province_id	true	string		Province id of districts you want to retrieve. Get province id in api GET /geo/provinces

Parameter	Type	Description
id	string	District ID
name	string	District name
name_en	string	English name
province_id	string	Province ID

List of communes

GET /geo/communes HTTP/1.1

Response

{
  "data": [
    {
      "district_id": "10101",
      "id": "1010115",
      "name": "Phường Cống Vị",
      "name_en": "cong vi",
      "new_id": null,
      "postcode": null,
      "province_id": "101"
    },
    {
      "district_id": "10101",
      "id": "1010109",
      "name": "Phường Điện Biên",
      "name_en": "dien bien",
      "new_id": null,
      "postcode": null,
      "province_id": "101"
    },
    {
      "district_id": "10101",
      "id": "1010113",
      "name": "Phường Đội Cấn",
      "name_en": "doi can",
      "new_id": null,
      "postcode": null,
      "province_id": "101"
    },
    ...
  ]
}

HTTP Request

GET /geo/communes

Query Parameters

Parameter	Required	Type	Default	Description
district_id	true	string		District id of communes you want to retrieve. Get district id in api GET /geo/districts
province_id	true	string		Province id of communes you want to retrieve. Get province id in api GET /geo/provinces

Response Parameters

Parameter	Type	Description
id	string	Commune/Ward ID
name	string	Commune/Ward name
name_en	string	English name
new_id	string	New commune/ward ID (for country Viet Nam)
district_id	string	District ID
province_id	string	Province ID
postcode	string	Postal code list

Order

List of orders

GET /shops/<SHOP_ID>/orders?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "activated_combo_products": {
        "combo_product_id": 430000823,
        "combo_product_info": {
          "combo_product_variations": [
            {
              "count": 1,
              "product_id": "e258399e-792a-43f7-b379-da99712f82f1",
              "variation_id": "74592bc7-e3d9-4734-82b0-246d79784602"
            }
          ],
          "discount_amount": 10000,
          "discount_by_percent": 0,
          "name": "combo mẫu mã"
        },
        "quantity_combo_activated": 1
      },
      "activated_promotion_advances": [
        {
          "id": 9027,
          "promotion_advance_id": "fb056b32-9cf6-4c5a-92de-0eb94db71121",
          "promotion_advance_info": {
            "id": "fb056b32-9cf6-4c5a-92de-0eb94db71121",
            "creator_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
            "display_id": 3,
            "discount_by_customer_levels": [],
            "is_activated": true,
            "is_free_shipping": false,
            "name": "KM noel",
            "type": "coupon",
            "end_time": "2024-11-30T16:59:59",
            "start_time": "2024-10-31T17:00:00",
            "start_price": 100000,
            "end_price": 1000000,
            "items": [],
            "coupon_info": {
                "discount": 30000,
                "is_percent": false
            },
            "inserted_at": "2024-11-27T11:19:40",
            "used_count": 1,
            "updated_at": "2024-11-27T11:19:40",
            "warehouse_ids": [],
            "priority_level": null,
            "group_name": null
          }
        }
      ],
      "bill_full_name": "hoang anh ",
      "bill_phone_number": "0999999999",
      "page_id": "256469571178082",
      "creator": {
        "avatar_url": null,
        "fb_id": "2042723249341651",
        "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
        "name": "Hoang Anh"
      },
      "id": 1418,
      "system_id": 862,
      "inserted_at": "2020-05-12T04:51:42",
      "updated_at": "2020-05-12T04:51:54",
      "is_free_shipping": false,
      "is_livestream": true,
      "is_live_shopping": false,
      "is_smc": false,
      "received_at_shop": false,
      "partner_fee": 28000,
      "post_id": "185187094667903_477083092110915",
      "customer_pay_fee": false,
      "items": [
        {
          "components": [
            {
              "component_id": "1d41c462-5254-4f5c-ba79-f4c0fa53b9c8",
              "quantity": 1,
              "variation_id": "9bc83da6-9a2c-4cee-bcdb-3f300def870f",
              "variation_info": {
                "detail": "Kích thước: M",
                "id": "Carla Top - AO26 - M",
                "images": [
                  "https://statics.pancake.vn/user-content.pancake.vn/2023/4/19/c308af10b95fad3a1248e765d65d25b589b3f462.jpg"
                ],
                "name": "Carla Top - AO26",
                "product_id": "Carla Top - AO26",
                "retail_price": 290000
              }
            }
          ],
          "discount_each_product": 0,
          "is_bonus_product": false,
          "is_composite": true,
          "is_discount_percent": false,
          "is_wholesale": false,
          "measure_group_id": 860000034,
          "note": "sản phẩm dễ vỡ",
          "note_product": "Combo Mẹ Nhàn Bé Khỏe",
          "one_time_product": false,
          "quantity": 1,
          "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
          "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
          "variation_info": {
            "detail": "size: L, color: red",
            "fields": null,
            "display_id": "PARILRED",
            "images": [
              "https://content.pancake.vn/user-content-dev2.pancake.vn/2025/3/22/d8c4b496c070f2f36eef2cbb39aab733d9d0a8a6.webp"
            ],
            "name": "aaaaaa",
            "product_display_id": null,
            "retail_price": 100000,
            "weight": 100,
            "measure_info": {
              "exchange_value": 30,
              "measure_id": 61
            }
          }
        }
      ],
      "sub_status": 1,
      "note": "",
      "note_print": null,
      "returned_reason": 1,
      "partner": {
        "cod": 200000,
        "custom_partner_id": null,
        "extend_code": "S58824.MB25.C3.500020713",
        "extend_update": [
          {
            "key": "bb098697-402d-4582-89af-10cbf2bcdfd2",
            "note": "Parcels have been dispatched to rider",
            "status": "delivery-in-progress",
            "tracking_id": "20A316MOG0DI",
            "update_at": "2025-06-06T09:20:03+07:00"
          }
        ],
        "is_returned": null,
        "order_number_vtp": null,
        "paid_at": null,
        "partner_id": 1,
        "sort_code": null,
        "system_created": true,
        "total_fee": 0,
        "updated_at": "2020-05-12T05:18:16"
      },
      "payment_purchase_histories": [
        {
          "amount": 869000,
          "inserted_at": "2025-02-11T18:18:19.000000",
          "ipn_reply": true,
          "result_code": "0",
          "tags": [
            "static"
          ],
          "type": "techcombank",
          "voucher_amount": 0
        }
      ],
      "warehouse_id": "630744ef-4614-4a70-988c-52e6d78c953c",
      "shipping_address": {
        "address": "aaaaa",
        "commune_id": "2210941",
        "country_code": null,
        "district_id": "22109",
        "full_address": "aaaaa, Xã Bắc Lý, Huyện Hiệp Hòa, Bắc Giang",
        "full_name": "hoang anh ",
        "phone_number": "0999999999",
        "post_code": null,
        "province_id": "221"
      },
      "shipping_fee": 0,
      "shop_id": 4,
      "status": 0,
      "status_name": "new",
      "tags": [
        {
          "id": 2,
          "name": "Chờ cọc"
        },
        {
          "id": 3,
          "name": "Nhập hàng"
        },
        {
          "id": 13,
          "name": "Delay lấy hàng"
        }
      ],
      "total_discount": 0,
      "warehouse_info": {
        "district_id": "10111",
        "full_address": "kakakaka, Phường Khương Trung, Quận Thanh Xuân, Hà Nội",
        "name": "snappy",
        "phone_number": "0999999999",
        "province_id": "101"
      },
      "shopify_abandon_checkout_id": 30120904851641,
      "link_confirm_order": "https://order.pke.gg/tracking?id=RyvKXPdNWkGlh2Wk8g70Juca8F03N8O",
      "pke_mkter": "b482ae3a-b89a-4d64-9859-ed6e3af5a476",
      "marketer": {
        "avatar_url": null,
        "email": "hunghoang@gmail.com",
        "fb_id": "739014329883748",
        "id": "b482ae3a-b89a-4d64-9859-ed6e3af5a476",
        "name": "Hùng Hoàng",
        "phone_number": null
      },
      "ads_source": "Facebook",
      "bank_payments": {
        "cb4be308-c09e-473b-bda7-da81abb428aa": 11000
      },
    },
    ...
  ],
  "page_number": 1,
  "page_size": 100,
  "success": true,
  "total_entries": 1418,
  "total_pages": 15
}

Query Parameters

Parameter	Required	Type	Default	Description	Example
page_size	false	int	30
page_number	false	int	1
search	false	string	null	Phone number, name of customer, note, ....
filter_status	false	array	null	Order status	[0, 1]
include_removed	false	int	null	Include removed orders	1
updateStatus	false	string / int	inserted_at	Filter orders by time
startDateTime	false	unix timestamp	null	Start date	1699635600
endDateTime	false	unix timestamp	null	End date	1699635600
option_sort	false	string	inserted_at_desc	Orders sequence
fields	false	array	null	Response fields	["id", "bill_phone_number", ...]
partner_id	false	array	null	Partner ID	[1, 3]
customer_id	false	uid	null	Customer ID
order_sources	false	array	null	[[Order source ID, Order source account id], ...]	[["-1", "314"], ["-3"]]
is_filter_exclude_source	false	boolean	false	Exclude order source	true
ad_ids	false	array	null	Advertising ID	["1784439461476385", "1784439461473489"]

updateStatus	Filter orders by time
inserted_at	Create order
updated_at	Last update
partner_inserted_at	Send request to courier
paid_at	Reconciliation
estimate_delivery_date	Estimated delivery time
picked_up_at	Picked up by courier at
first_delivery_at	First delivery
transfer_proof	Transfer proof
time_assign_seller	Assign seller
time_assign_care	Time assign care
time_assign_marketer	Time assign marketer
-1	Last status update
0	New
11	Restocking
20	Purchased
1	Confirmed
12	Wait for printing
13	Printed
8	Packaging
9	Waiting for pick up
2	Shipped
3	Delivered
16	Collected money
4	Returning
15	Partial return
5	Returned

option_sort	Orders sequence
inserted_at_desc	Order creation time gradually decreases
inserted_at_asc	Order creation time gradually increases
last_updated_order_desc	Last updated order gradually decreases
last_updated_order_asc	Last updated order gradually increases
last_update_status_at_desc	Last status update at gradually decreases
last_update_status_at_asc	Last status update at gradually increases
order_valuation_desc	Order value gradually decreases
order_valuation_asc	Order value gradually increases
product_quantity_desc	Product quantity gradually decreases
product_quantity_asc	Product quantity gradually increases
product_name_desc	Product name gradually decreases
product_name_asc	Product name gradually increases
sub_status_sort_desc	Delivery delay update gradually decreases
sub_status_sort_asc	Delivery delay update gradually increases
first_undeliverable_at_desc	First undeliverable at gradually decreases
first_undeliverable_at_asc	First undeliverable at gradually increases
customer_sort_desc	Customer name gradually decreases
customer_sort_asc	Customer name gradually increases
estimate_delivery_date_desc	Estimated delivery date gradually decreases
estimate_delivery_date_asc	Estimated delivery date gradually increases
order_source_desc	Order source gradually decreases
order_source_asc	Order source gradually increases

Get order information

GET /shops/<SHOP_ID>/orders/<ORDER_ID>?api_key=<api_key> HTTP/1.1

Response

  {
    "activated_combo_products": {
      "combo_product_id": 430000823,
      "combo_product_info": {
        "combo_product_variations": [
          {
            "count": 1,
            "product_id": "e258399e-792a-43f7-b379-da99712f82f1",
            "variation_id": "74592bc7-e3d9-4734-82b0-246d79784602"
          }
        ],
        "discount_amount": 10000,
        "discount_by_percent": 0,
        "name": "combo mẫu mã"
      },
      "quantity_combo_activated": 1
    },
    "activated_promotion_advances": [
      {
        "id": 9027,
        "promotion_advance_id": "fb056b32-9cf6-4c5a-92de-0eb94db71121",
        "promotion_advance_info": {
          "id": "fb056b32-9cf6-4c5a-92de-0eb94db71121",
          "creator_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
          "display_id": 3,
          "discount_by_customer_levels": [],
          "is_activated": true,
          "is_free_shipping": false,
          "name": "KM noel",
          "type": "coupon",
          "end_time": "2024-11-30T16:59:59",
          "start_time": "2024-10-31T17:00:00",
          "start_price": 100000,
          "end_price": 1000000,
          "items": [],
          "coupon_info": {
              "discount": 30000,
              "is_percent": false
          },
          "inserted_at": "2024-11-27T11:19:40",
          "used_count": 1,
          "updated_at": "2024-11-27T11:19:40",
          "warehouse_ids": [],
          "priority_level": null,
          "group_name": null
        }
      }
    ],
    "bill_full_name": "hoang anh ",
    "bill_phone_number": "0999999999",
    "page_id": "256469571178082",
    "creator": {
      "avatar_url": null,
      "fb_id": "2042723249341651",
      "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
      "name": "Hoang Anh"
    },
    "id": 1418,
    "system_id": 862,
    "inserted_at": "2020-05-12T04:51:42",
    "updated_at": "2020-05-12T04:51:54",
    "is_free_shipping": false,
    "is_livestream": true,
    "is_live_shopping": false,
    "is_smc": false,
    "received_at_shop": false,
    "partner_fee": 28000,
    "post_id": "185187094667903_477083092110915",
    "fee_marketplace": 4000,
    "customer_pay_fee": false,
    "items": [
      {
        "components": [
          {
            "component_id": "1d41c462-5254-4f5c-ba79-f4c0fa53b9c8",
            "quantity": 1,
            "variation_id": "9bc83da6-9a2c-4cee-bcdb-3f300def870f",
            "variation_info": {
              "detail": "Kích thước: M",
              "id": "Carla Top - AO26 - M",
              "images": [
                "https://statics.pancake.vn/user-content.pancake.vn/2023/4/19/c308af10b95fad3a1248e765d65d25b589b3f462.jpg"
              ],
              "name": "Carla Top - AO26",
              "product_id": "Carla Top - AO26",
              "retail_price": 290000
            }
          }
        ],
        "discount_each_product": 0,
        "is_bonus_product": false,
        "is_composite": true,
        "is_discount_percent": false,
        "is_wholesale": false,
        "measure_group_id": 860000034,
        "note": "sản phẩm dễ vỡ",
        "note_product": "Combo Mẹ Nhàn Bé Khỏe",
        "one_time_product": false,
        "quantity": 1,
        "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
        "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
        "variation_info": {
          "detail": null,
          "fields": null,
          "display_id": null,
          "images": [
            "https://content.pancake.vn/user-content-dev2.pancake.vn/2025/3/22/d8c4b496c070f2f36eef2cbb39aab733d9d0a8a6.webp"
          ],
          "name": "aaaaaa",
          "product_display_id": null,
          "retail_price": 100000,
          "weight": 100,
          "measure_info": {
            "exchange_value": 30,
            "measure_id": 61
          }
        }
      }
    ],
    "sub_status": 1,
    "note": "",
    "note_print": null,
    "returned_reason": 1,
    "payment_purchase_histories": [
      {
        "amount": 869000,
        "inserted_at": "2025-02-11T18:18:19.000000",
        "ipn_reply": true,
        "result_code": "0",
        "tags": [
          "static"
        ],
        "type": "techcombank",
        "voucher_amount": 0
      }
    ],
    "partner": {
      "cod": 200000,
      "custom_partner_id": null,
      "extend_code": "S58824.MB25.C3.500020713",
      "extend_update": [
        {
          "key": "bb098697-402d-4582-89af-10cbf2bcdfd2",
          "note": "Parcels have been dispatched to rider",
          "status": "delivery-in-progress",
          "tracking_id": "20A316MOG0DI",
          "update_at": "2025-06-06T09:20:03+07:00"
        }
      ],
      "is_returned": null,
      "order_number_vtp": null,
      "paid_at": null,
      "partner_id": 1,
      "sort_code": null,
      "system_created": true,
      "total_fee": 0,
      "updated_at": "2020-05-12T05:18:16"
    },
    "warehouse_id": "630744ef-4614-4a70-988c-52e6d78c953c",
    "shipping_address": {
      "address": "aaaaa",
      "commune_id": "2210941",
      "country_code": null,
      "district_id": "22109",
      "full_address": "aaaaa, Xã Bắc Lý, Huyện Hiệp Hòa, Bắc Giang",
      "full_name": "hoang anh ",
      "phone_number": "0999999999",
      "post_code": null,
      "province_id": "221"
    },
    "shipping_fee": 0,
    "shop_id": 4,
    "status": 0,
    "status_name": "new",
    "tags": [
      {
        "id": 2,
        "name": "Chờ cọc"
      },
      {
        "id": 3,
        "name": "Nhập hàng"
      },
      {
        "id": 13,
        "name": "Delay lấy hàng"
      }
    ],
    "total_discount": 0,
    "warehouse_info": {
      "district_id": "10111",
      "full_address": "kakakaka, Phường Khương Trung, Quận Thanh Xuân, Hà Nội",
      "name": "snappy",
      "phone_number": "0999999999",
      "province_id": "101"
    },
    "shopify_abandon_checkout_id": 30120904851641,
    "link_confirm_order": "https://order.pke.gg/tracking?id=RyvKXPdNWkGlh2Wk8g70Juca8F03N8O",
    "pke_mkter": "b482ae3a-b89a-4d64-9859-ed6e3af5a476",
    "marketer": {
      "avatar_url": null,
      "email": "hunghoang@gmail.com",
      "fb_id": "739014329883748",
      "id": "b482ae3a-b89a-4d64-9859-ed6e3af5a476",
      "name": "Hùng Hoàng",
      "phone_number": null
    },
    "ads_source": "Facebook",
    "bank_payments": {
      "cb4be308-c09e-473b-bda7-da81abb428aa": 11000
    }
  }

Create order

POST /shops/<SHOP_ID>/orders?api_key=<api_key> HTTP/1.1

Request

{
  "bill_full_name": "hoang anh ",
  "bill_phone_number": "0999999999",
  "is_free_shipping": false,
  "received_at_shop": false,
  "page_id": "256469571178082",
  "account": 4,
  "account_name": "facebook321",
  "assigning_seller_id": "340644fc-314d-450e-a45f-33343678cab6",
  "items": [
    {
      "discount_each_product": 0,
      "is_bonus_product": false,
      "is_discount_percent": false,
      "is_wholesale": false,
      "one_time_product": false,
      "quantity": 1,
      "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
      "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
      "variation_info": {
        "detail": null,
        "fields": null,
        "display_id": null,
        "name": "aaaaaa",
        "product_display_id": null,
        "retail_price": 100000,
        "weight": 100
      }
    }
  ],
  "note": "",
  "note_print": null,
  "returned_reason": 1,
  "warehouse_id": "630744ef-4614-4a70-988c-52e6d78c953c",
  "shipping_address": {
    "address": "aaaaa",
    "commune_id": "2210941",
    "country_code": null,
    "district_id": "22109",
    "full_address": "aaaaa, Xã Bắc Lý, Huyện Hiệp Hòa, Bắc Giang",
    "full_name": "hoang anh ",
    "phone_number": "0999999999",
    "post_code": null,
    "province_id": "221"
  },
  "shipping_fee": 0,
  "shop_id": 4,
  "total_discount": 0,
  "warehouse_info": {
    "district_id": "10111",
    "full_address": "kakakaka, Phường Khương Trung, Quận Thanh Xuân, Hà Nội",
    "name": "snappy",
    "phone_number": "0999999999",
    "province_id": "101"
  },
  "custom_id": "Ma0001",
  "activated_promotion_advances": [
    {
      "promotion_advance_id": "fb056b32-9cf6-4c5a-92de-0eb94db71121",
      "is_activated": true
    }
  ]
}

Query Parameters

Parameter	Required	Type	Default	Description
bill_full_name	false	string	null
bill_phone_number	false	string	null
is_free_shipping	false	boolean	false
items	true	array	[]
note	false	string	null
note_print	false	string	null
warehouse_id	true	uid
shipping_address	true	json
shipping_fee	false	int	0
shop_id	true	int
total_discount	false	int	0
warehouse_info	false	json
custom_id	false	string	null
account	false	int	null
assigning_seller_id	false	uid	null
activated_promotion_advances (1.1)	false	array	null	Thông tin khuyến mại nâng cao

Item

Parameter	Type	Default
discount_each_product	int	0
is_bonus_product	boolean	false
is_discount_percent	boolean	false
is_wholesale	boolean	false
one_time_product	boolean	false
quantity	int	0
variation_id	uid
product_id	uid
variation_info	json

activated_promotion_advances (1.1)

Parameter	Type	Description
promotion_advance_id	uid	Mã khuyến mại nâng cao
is_activated	boolean	Áp dụng

Update order

PUT /shops/<SHOP_ID>/orders/<ORDER_ID>?api_key=<api_key> HTTP/1.1

Request

{
  "bill_full_name": "hoang anh ",
  "bill_phone_number": "0999999999",
  "creator": {
    "avatar_url": null,
    "fb_id": "2042723249341651",
    "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
    "name": "Hoang Anh"
  },
  "account": 4,
  "account_name": "facebook321",
  "assigning_seller_id": "340644fc-314d-450e-a45f-33343678cab6",
  "id": 1418,
  "inserted_at": "2020-05-12T04:51:42",
  "updated_at": "2020-05-12T04:51:54",
  "is_free_shipping": false,
  "received_at_shop": false,
  "cod": 110000,
  "discount": 20000,
  "total_price": 100000,
  "total_price_after_sub_discount": 110000,
  "page_id": "256469571178082",
  "charged_by_card": 0,
  "charged_by_momo": 0,
  "charged_by_qrpay": 0,
  "transfer_money": 0,
  "partner_fee": 28000,
  "fee_marketplace": 4000,
  "customer_pay_fee": false,
  "items": [
    {
      "discount_each_product": 0,
      "is_bonus_product": false,
      "is_discount_percent": false,
      "is_wholesale": false,
      "one_time_product": false,
      "quantity": 1,
      "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
      "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
      "variation_info": {
        "detail": null,
        "fields": null,
        "display_id": null,
        "name": "aaaaaa",
        "product_display_id": null,
        "retail_price": 100000,
        "weight": 100
      }
    }
  ],
  "note": "",
  "note_print": null,
  "returned_reason": 1,
  "partner": {
    "cod": 0,
    "custom_partner_id": null,
    "extend_code": "S58824.MB25.C3.500020713",
    "extend_update": [
      {
        "key": "bb098697-402d-4582-89af-10cbf2bcdfd2",
        "note": "Parcels have been dispatched to rider",
        "status": "delivery-in-progress",
        "tracking_id": "20A316MOG0DI",
        "update_at": "2025-06-06T09:20:03+07:00"
      }
    ],
    "is_returned": null,
    "order_number_vtp": null,
    "paid_at": null,
    "partner_id": 1,
    "sort_code": null,
    "system_created": true,
    "total_fee": 0,
    "updated_at": "2020-05-12T05:18:16"
  },
  "warehouse_id": "630744ef-4614-4a70-988c-52e6d78c953c",
  "shipping_address": {
    "address": "aaaaa",
    "commune_id": "2210941",
    "country_code": null,
    "district_id": "22109",
    "full_address": "aaaaa, Xã Bắc Lý, Huyện Hiệp Hòa, Bắc Giang",
    "full_name": "hoang anh ",
    "phone_number": "0999999999",
    "post_code": null,
    "province_id": "221"
  },
  "shipping_fee": 10000,
  "shop_id": 4,
  "status": 0,
  "status_name": "new",
  "tags": [
    {
      "id": 2,
      "name": "Chờ cọc"
    },
    {
      "id": 3,
      "name": "Nhập hàng"
    },
    {
      "id": 13,
      "name": "Delay lấy hàng"
    }
  ],
  "warehouse_info": {
    "district_id": "10111",
    "full_address": "kakakaka, Phường Khương Trung, Quận Thanh Xuân, Hà Nội",
    "name": "snappy",
    "phone_number": "0999999999",
    "province_id": "101"
  },
  "arrange_shipment_marketplace": true,
  "pick_up_method": "pick_up",
  "picking_shif_marketplace": "closest",
  "activated_promotion_advances": [
    {
      "promotion_advance_id": "fb056b32-9cf6-4c5a-92de-0eb94db71121",
      "is_activated": true
    }
  ]
}

Parameter	Type	Description	Note
shop_id	int	Shop ID
bill_phone_number	string	Phone number of customer
bill_full_name	string	Customer name
id	string	Order ID
warehouse_id	uid	Warehouse ID. Get by api GET /warehouses
is_free_shipping	boolean	Free shipping
shipping_fee	int	Shipping fee
received_at_shop	boolean	true: Sale at the counter false: Sale online
note_print	string	Note
items	array	List of products
item.discount_each_product	int	Discount ech product
item.is_discount_percent	boolean	Discount ech product by percent
item.is_bonus_product	boolean	Bonus product
item.quantity	int	Product quantity
item.one_time_product	boolean	Quickly added product
item.variation_info	json	Variation information
item.variation_id	uid	Variation ID. Get by api GET /variations
item.product_id	uid	Product ID. Get by api GET /variations
province_id	string	Province ID. Get by api GET /geo/provinces
district_id	string	District ID. Get by api GET /geo/districts
commune_id	string	Commune ID. Get by api GET/ geo/communes
shipping_address	json	Delivery information
shipping_address.address	string	Detailed delivery address (house number, street name, ....)
shipping_address.full_address	string	Full address
shipping_address.full_name	string	Full name of customer
shipping_address.phone_number	string	Phone number, name of customer, note, ....
warehouse_info	json	Warehouse information
note	string	Internal note
discount	int	Order discount
is_wholesale	boolean	Wholesale
inserted_at	time	Creation time
updated_at	time	Status update time
creator	json	Order creator
creator.fb_id	string	Facebook ID of creator
creator.name	string	Creator name
last_editor	json	Last editor updated order
status	int	Order status
partner.partner_id	int	Partner ID
partner.extend_code	string	Shipping order ID on partner system
tags	array	List of order tags
tag.id	string	Tag ID
tag.name	string	Tag name
cod	int	Cash on delivery
total_price	int	Total price
total_price_after_sub_discount	int	Total price after sub discount
charged_by_momo	int	Charged by MOMO
charged_by_qrpay	int	Charged by QRPAY
charged_by_card	int	Charged by card
transfer_money	int	Transfer money
page_id	string	Facebook page ID
partner_fee	int	Fee from shipping partner
fee_marketplace	int	Fees from e-commerce platforms
customer_pay_fee	boolean	false: Shop paid shipping fee true: Customer paid shipping fee
account	int	Order source ID
account_name	string	Order source name
assigning_seller_id	uid	Assigning seller ID
arrange_shipment_marketplace	boolean	Prepare goods with orders from E-commerce platform	Shopee, Lazada, TikTok
pick_up_method (1.1)	string	Pickup method	Shopee, Tiktok
picking_shif_marketplace (1.2)	string	Pickup shift	Shopee
activated_promotion_advances (1.3)	array	Thông tin khuyến mại nâng cao

(1.1) pick_up_method	Pickup method
pick_up	Courier to pickup
drop_off	Take goods to post office

(1.2) picking_shif_marketplace	Pickup shift
closest	Closest
farthest	Farthest

(1.3) activated_promotion_advances

Parameter	Type	Description
promotion_advance_id	uid	Mã khuyến mại nâng cao
is_activated	boolean	Áp dụng

List of order sources

GET /shops/<SHOP_ID>/order_source?api_key=<api_key> HTTP/1.1

Response

{
    "data": [
      {
        "id": -3,
        "inserted_at": "2020-06-10T11:50:07",
        "name": "Shopee",
        "parent_id": null,
        "shop_id": 7,
        "updated_at": "2020-06-10T11:50:07"
      },
      {
        "id": 4,
        "inserted_at": "2020-06-17T08:41:54",
        "name": "40999897",
        "parent_id": -3,
        "shop_id": 7,
        "updated_at": "2020-06-17T08:41:54"
      },
      {
        "id": "1471242102982974",
        "inserted_at": "2021-04-22T08:33:15",
        "name": "Pancake.vn",
        "parent_id": -1,
        "shop_id": 20,
        "updated_at": "2024-04-08T03:11:25"
      }
    ],
    "success": true
}

Response Parameters

Parameter	Type	Description	Example
shop_id	int	Shop ID
id	int / string	Order sources ID / Page ID
name	string	Order sources name / Page name
parent_id	int	Parent's order source ID

Get link print label

POST /shops/<SHOP_ID>/products/get_logistics_shipping_document?api_key=<api_key> HTTP/1.1

Request

{
  "params": [
    {
      "order_id": "576551803772635228"
    }
  ]
}

Response

{
  "data": [
    "https://content.pancake.vn/2-25/2025/3/28/071edc2cc6c728f6c3fa493a2cb033e8f61fb11e.071edc2cc6c728f6c3fa493a2cb033e8f61fb11e"
  ],
  "success": true
}

Query Parameters

Parameter	Required	Type	Example
document_type (1.1)	true (E-commerce label) / false	string	SL_PL

Request Parameters

Parameter	Required	Type	Description
order_id	true	string	Order ID

(1.1) document_type	Print type
SL_PL	Shipping label + Packing slips
SHIPPING_LABEL	Shipping label
PICK_LIST	Packing slips

Get order confirm link

POST /shops/<SHOP_ID>/orders/get_tracking_url?api_key=<api_key> HTTP/1.1

Request

{
  "system_id": 862
}

Response

{
  "url": "https://pke.gg/99gjy3r",
  "success": true
}

Query Parameters

Parameter	Required	Type	Description
system_id	true	int	System ID

Response Parameters

Parameter	Type	Description
url	string	Order confirm link

List of advanced promotions of the order

POST /shops/<SHOP_ID>/orders/get_promotion_advance_active?api_key=<api_key> HTTP/1.1

Request

Apply to existing order
{
  "order_id": "LMP0266310053VNA"
}

Apply to new order
{
  "order": {
    "shop_id": 224,
    "received_at_shop": false,
    "warehouse_id": "73c9505e-0f90-4a18-a1a1-13e1bdac21ee",
    "order_currency": "VND",
    "order_sources": -3,
    "customer": {
      "shop_customer": {
        "tags": [
          "Tiềm năng"
        ]
      }
    },
    "items": [
      {
        "product_id": "4a6fc152-5989-4202-83d4-a11a2ab28078",
        "variation_id": "ad5a7194-034f-49cb-9d27-64fec1f30999",
        "quantity": 1,
        "variation_info": {
          "retail_price": 500000,
          "category_ids": [
            1572
          ],
          "product_tags": [
            196
          ]
        }
      }
    ]
  }
}

Query Parameters (Order already exists)

Parameter	Required	Type	Description
order_id	true	string	Order ID

Query Parameters (New order creation)

Parameter	Required	Type	Description
shop_id	true	int	Shop ID
received_at_shop	false	boolean	Sale at the counter
warehouse_id	false	uid	Warehouse ID
order_currency	false	string	Currency unit
order_sources	false	int	Order source ID
customer	false	json	Customer information
items	true	array	Product Information

Order information

Response

{
  "activated_combo_products": {
    "combo_product_id": 430000823,
    "combo_product_info": {
      "combo_product_variations": [
        {
          "count": 1,
          "product_id": "e258399e-792a-43f7-b379-da99712f82f1",
          "variation_id": "74592bc7-e3d9-4734-82b0-246d79784602"
        }
      ],
      "discount_amount": 10000,
      "discount_by_percent": 0,
      "name": "combo mẫu mã"
    },
    "quantity_combo_activated": 1
  },
  "activated_promotion_advances": [
    {
      "id": 9027,
      "promotion_advance_id": "fb056b32-9cf6-4c5a-92de-0eb94db71121",
      "promotion_advance_info": {
        "id": "fb056b32-9cf6-4c5a-92de-0eb94db71121",
        "creator_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
        "display_id": 3,
        "discount_by_customer_levels": [],
        "is_activated": true,
        "is_free_shipping": false,
        "name": "KM noel",
        "type": "coupon",
        "end_time": "2024-11-30T16:59:59",
        "start_time": "2024-10-31T17:00:00",
        "start_price": 100000,
        "end_price": 1000000,
        "items": [],
        "coupon_info": {
            "discount": 30000,
            "is_percent": false
        },
        "inserted_at": "2024-11-27T11:19:40",
        "used_count": 1,
        "updated_at": "2024-11-27T11:19:40",
        "warehouse_ids": [],
        "priority_level": null,
        "group_name": null
      }
    }
  ],
  "advanced_platform_fee": {
    "affiliate_commission": 1,
    "diff_shipping_fee": 100,
    "marketplace_voucher": 100,
    "payment_fee": 7225,
    "platform_commission": 100,
    "seller_transaction_fee": 100,
    "service_fee": 100,
    "sfp_service_fee": 100
  },
  "printing_count": 1,
  "updated_at": "2023-11-02T09:14:32.661282",
  "money_to_collect": 430000,
  "total_price": 430000,
  "shop_customer_address_id": "d306bedc-9b35-4c7e-b3b1-26815c207dc9",
  "customer": {
    "fb_id": null,
    "id": "691ce908-bc13-4282-a87a-7d3f7e64a5cf",
    "name": "C Loan",
    "page_id": null,
  },
  "status": 9,
  "bill_phone_number": "0941902893",
  "total_quantity": 2,
  "time_assign_marketer": "2023-11-02T09:14:32",
  "is_locked": false,
  "note_print": "Giao tận tay khách",
  "creator_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
  "status_history": [
    {
      "avatar_url": null,
      "editor": {
        "avatar_url": null,
        "email": "vuson897654@gmail.com",
        "fb_id": "377936050731194",
        "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
        "name": "Vũ Sơn",
        "phone_number": null
      },
      "editor_fb": "377936050731194",
      "editor_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "name": "Vũ Sơn",
      "old_status": null,
      "status": 0,
      "updated_at": "2023-11-02T08:48:28"
    }
  ],
  "duplicated_phone": true,
  "order_currency": "VND",
  "note": "Giao tận tay khách",
  "warehouse_info": {
    "address": "190 La Thành",
    "affiliate_id": null,
    "commune_id": "1012957",
    "custom_id": null,
    "district_id": "10129",
    "ffm_id": null,
    "full_address": "190 La Thành, Xã Ba Trại, Huyện Ba Vì, Hà Nội",
    "has_snappy_service": false,
    "name": "Kho mặc định",
    "phone_number": "0366452565",
    "province_id": "101"
  },
  "is_free_shipping": false,
  "is_livestream": true,
  "is_live_shopping": false,
  "is_smc": false,
  "tags": [61],
  "charged_by_vnpay": 0,
  "charged_by_qrpay": 0,
  "partner_fee": 27000,
  "post_id": "185187094667903_477083092110915",
  "custom_id": "SOICUN-12049-10",
  "last_editor": {
    "avatar_url": null,
    "email": "vuson897654@gmail.com",
    "fb_id": "377936050731194",
    "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "name": "Vũ Sơn",
    "phone_number": null
  },
  "charged_by_momo": 0,
  "bank_transfer_images": null,
  "partner": {
    "cod": 200000,
    "delivery_name": null,
    "delivery_tel": null,
    "extend_code": "LMP0224531356VNA",
    "extend_update": [
      {
        "key": "bb098697-402d-4582-89af-10cbf2bcdfd2",
        "note": "Parcels have been dispatched to rider",
        "status": "delivery-in-progress",
        "tracking_id": "20A316MOG0DI",
        "update_at": "2025-06-06T09:20:03+07:00"
      },
      ...
    ],
    "paid_at": null,
    "partner_id": 57,
    "picked_up_at": null,
    "sort_code": "H-THL-1B",
    "system_created": true,
    "total_fee": 0,
    "updated_at": "2023-11-02T09:13:28"
  },
  "payment_purchase_histories": [
    {
      "amount": 869000,
      "inserted_at": "2025-02-11T18:18:19.000000",
      "ipn_reply": true,
      "result_code": "0",
      "tags": [
        "static"
      ],
      "type": "techcombank",
      "voucher_amount": 0
    }
  ],
  "id": 103973,
  "system_id": 862,
  "page_id": "104438181227821",
  "inserted_at": "2023-11-02T08:48:29.136481",
  "shop_id": 20,
  "transfer_money": 0,
  "lock_order_by_user": null,
  "received_at_shop": false,
  "assigning_care": {
    "avatar_url": null,
    "email": "vuson897654@gmail.com",
    "fb_id": "377936050731194",
    "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "name": "Vũ Sơn",
    "phone_number": null
  },
  "assigning_seller_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
  "total_discount": 0,
  "einvoices": [],
  "shop_customer_id": "1442ab20-ab99-4c16-ab17-c7ebd4158a00",
  "charged_by_card": 0,
  "time_assign_seller": "2023-11-02T08:48:28",
  "sub_status_history": [],
  "items": [
    {
      "components": [
        {
          "component_id": "1d41c462-5254-4f5c-ba79-f4c0fa53b9c8",
          "quantity": 1,
          "variation_id": "9bc83da6-9a2c-4cee-bcdb-3f300def870f",
          "variation_info": {
            "detail": "Kích thước: M",
            "id": "Carla Top - AO26 - M",
            "images": [
              "https://statics.pancake.vn/user-content.pancake.vn/2023/4/19/c308af10b95fad3a1248e765d65d25b589b3f462.jpg"
            ],
            "name": "Carla Top - AO26",
            "product_id": "Carla Top - AO26",
            "retail_price": 290000
          }
        }
      ],
      "returned_count": 0,
      "note": "sản phẩm dễ vỡ",
      "note_product": "Combo Mẹ Nhàn Bé Khỏe",
      "id": 37956,
      "inserted_at": "2023-11-02T09:13:23.245866",
      "measure_group_id": 58,
      "variation_info": {
        "barcode": "12392-4",
        "brand_id": "66e29cff-ed98-425d-ad3f-0e177dddacea",
        "category_ids": [
          1572
        ],
        "display_id": "PARILRED",
        "detail": "mau: trang, size: X",
        "fields": [
          {
            "id": "a7096d25-85f4-4459-a979-e50f2dec7f43",
            "keyValue": "L",
            "name": "size",
            "value": "L"
          },
          {
            "id": "9c580bc8-2911-41d9-af14-3a4f5d91b914",
            "keyValue": "RED",
            "name": "color",
            "value": "red"
          }
        ],
        "images": [
          "https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"
        ],
        "last_imported_price": 100000,
        "measure_info": {
          "exchange_value": 30,
          "measure_id": 61
        },
        "name": "Áo thời trang Nam Pari",
        "product_display_id": "PARI"
        "retail_price": 200000,
        "weight": 700
      },
      "product_id": "73ec61e2-52e3-41dd-bd24-b7ec1035184d",
      "assigning_seller_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "variation_id": "76887a5b-8a27-472c-a15a-661ea59434dd",
      "quantity_by_combo_products": [],
      "discount_each_product": 0,
      "is_bonus_product": false,
      "is_composite": true,
      "quantity": 2
    }
  ],
  "sub_status": 1,
  "estimate_delivery_date": "2023-11-03T08:47:00",
  "display_id": 12049,
  "order_sources": "-1",
  "charged_by_fundiin": 0,
  "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
  "surcharge": 0,
  "returned_reason": null,
  "last_editor_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
  "is_linked_partner": true,
  "shipping_fee": 30000,
  "call_laters": [],
  "last_update_status_at": "2023-11-02T09:13:28",
  "discount_by_customer_level": null,
  "shop_partner_id": 137,
  "viewing": [],
  "creator": {
    "avatar_url": null,
    "email": "vuson897654@gmail.com",
    "fb_id": "377936050731194",
    "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "name": "Vũ Sơn",
    "phone_number": null
  },
  "bill_full_name": "C Loan",
  "order_returned_ids": null,
  "cost_surcharge": 0,
  "time_send_partner": "2023-11-02T09:13:28",
  "charged_by_kredivo": 0,
  "shipping_address": {
    "address": "Sn 18 ngách 91 ngõ 9 bãi muối",
    "commnue_name": "Phường Cao Thắng",
    "commune_id": "2250115",
    "country_code": "84",
    "district_id": "22501",
    "district_name": "Thành phố Hạ Long",
    "full_address": "Sn 18 ngách 91 ngõ 9 bãi muối, Phường Cao Thắng, Thành phố Hạ Long, Quảng Ninh",
    "full_name": "C Loan",
    "phone_number": "0941902893",
    "post_code": null,
    "province_id": "225",
    "province_name": "Quảng Ninh"
  },
  "discount": 0,
  "pke_mkter": "316dcba2-e4ef-4787-b2d2-b02e83c8522c",
  "histories": [
    {
      "bank_payments": {
        "new": {},
        "old": null
      },
      "editor_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "items": [
        {
          "new": {
            "discount_each_product": 0,
            "is_discount_percent": false,
            "quantity": 2,
            "variation_info": {
              "fields": [
                {
                  "id": "56e0ac18-3bd0-47ac-91ba-0f4056326c1d",
                  "keyValue": "TRANG",
                  "name": "mau",
                  "value": "trang"
                }
              ],
              "measure_info": {
                "exchange_value": 2,
                "measure_id": 1959
              },
              "name": "Áo thời trang Nam Pari",
              "retail_price": 200000,
              "weight": 700
            }
          },
          "old": null,
          "variation_id": "76887a5b-8a27-472c-a15a-661ea59434dd"
        }
      ],
      "total_quantity": {
        "new": 2,
        "old": 0
      },
      "updated_at": "2023-11-02T09:13:24"
    }
  ],
  "duplicated_customer": true,
  "bill_email": "dfadf@gmail.com",
  "customer_referral_code": null,
  "assigning_seller": {
    "avatar_url": null,
    "email": "vuson897654@gmail.com",
    "fb_id": "377936050731194",
    "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "name": "Vũ Sơn",
    "phone_number": null
  },
  "tax": 0,
  "time_assign_care": "2023-11-02T09:14:32",
  "assigning_care_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
  "cod": 430000,
  "customer_pay_fee": false,
  "cash": 0,
  "is_from_ecommerce": null,
  "account": "104438181227821",
  "note_image": null,
  "customer_needs": [],
  "shopify_abandon_checkout_id": 30120904851641,
  "link_confirm_order": "https://order.pke.gg/tracking?id=RyvKXPdNWkGlh2Wk8g70Juca8F03N8O",
  "pke_mkter": "b482ae3a-b89a-4d64-9859-ed6e3af5a476",
  "marketer": {
    "avatar_url": "https://statics.pancake.vn/user-content-dev2.pancake.vn/2022/1/4/a913bfe540a71b2a2bdf45429f91074cdcfdb170.png",
    "email": "hunghoang@gmail.com",
    "fb_id": "739014329883748",
    "id": "b482ae3a-b89a-4d64-9859-ed6e3af5a476",
    "name": "Hùng Hoàng",
    "phone_number": null
  },
  "ads_source": "Facebook",
  "bank_payments": {
    "cb4be308-c09e-473b-bda7-da81abb428aa": 11000
  }
}

Parameter	Type	Description
advanced_platform_fee (1.0)	json	Fees from e-commerce platforms
printing_count	int	Printing count
updated_at	time	Status update time
money_to_collect	int	Amount to collect
total_price	int	Total price
shop_customer_address_id	uid	Customer address id
customer (1.1)	json	Customer information
status	int	Order status
bill_phone_number	string	Phone number of customer
total_quantity	int	Total quantity
time_assign_marketer	time	Time assign marketer
is_locked	boolean	Order lock
note_print	string	Note
creator_id	uid	Creator id
status_history	array	Status update history
duplicated_phone	boolean	Duplicate phone number
order_currency	string	Currency unit
note	string	Internal note
warehouse_info	json	Warehouse information
is_free_shipping	boolean	Free shipping
tags (1.2)	array	List of order tags
charged_by_vnpay	int	Amount paid by VNPAY
charged_by_qrpay	int	Charged by QRPAY
partner_fee	int	Fee from shipping partner
custom_id	string	Order ID
last_editor	json	Last editor updated order
charged_by_momo	int	Charged by MOMO
bank_transfer_images	array	Bank transfer image link
id	integer / string (Custom ID)	Order ID
system_id	int	System ID
partner (1.3)	json	Shipping information
payment_purchase_histories	array	Payment histories
page_id	string	Facebook page ID
inserted_at	time	Creation time
shop_id	int	Shop ID
transfer_money	int	Transfer money
lock_order_by_user	uid	Order lock user id
received_at_shop	boolean	true: Sale at the counter false: Sale online
assigning_care	json	Care
assigning_seller_id	uid	Assigning seller ID
total_discount	int	Discount total
einvoices	array	E-invoice information
shop_customer_id	uid	Customer ID
charged_by_card	int	Charged by card
items (1.4)	array	List of products
estimate_delivery_date	time	Estimated delivery date
order_sources	string	Order source ID
charged_by_fundiin	int	Amount paid by Fundiin
warehouse_id	uid	Warehouse ID. Get by api GET /warehouses
surcharge	int	Surcharge
returned_reason	string	Return reason
last_editor_id	uid	Last editor code
is_linked_partner	boolean	Linked delivery partner
shipping_fee	int	Shipping fee
call_laters	array	Call back
last_update_status_at	time	Last status update time
discount_by_customer_level	int	Discount by customer level
viewing	array	Currently viewing employee
creator	json	Order creator
creator.fb_id	string	Facebook ID of creator
creator.name	string	Creator name
bill_full_name	string	Customer name
order_returned_ids	uid	Return order id
cost_surcharge	int	Cost surcharge
marketer	json	Marketer
pke_mkter	uid	Marketer id
time_send_partner	time	Time send partner
charged_by_kredivo	int	Amount paid by Kredivo
shipping_address (1.5)	json	Delivery information
activated_combo_products	json	Activated combo information
activated_promotion_advances (1.6)	array	Thông tin khuyến mãi được kích hoạt
discount	int	Discount
histories	array	History
duplicated_customer	boolean	Duplicate customer
bill_email	string	Customer email
customer_referral_code	json	Customer referral code
assigning_seller	json	Seller
tax	int	Tax
time_assign_care	time	Time assign care
assigning_care_id	uid	Assigning care id
cod	int	Cash on delivery
customer_pay_fee	boolean	false: Shop paid shipping fee true: Customer paid shipping fee
cash	int	Cash
is_from_ecommerce	boolean	Order from e-commerce
account	int	Order source ID
note_image	array	Link note image
shopify_abandon_checkout_id	int	Uncompleted payment ID from Shopify
link_confirm_order	string	Link confirm order
sub_status (1.7)	int	Reason for delivery delay
is_livestream	boolean	Order from livestream
is_live_shopping	boolean	Order from live shopping
is_smc	boolean	Order from shopping on Messenger
post_id	string	Post ID
ads_source	string	Advertising source
bank_payments	json	Payment method

advanced_platform_fee (1.0)

Parameter	Type	Description
affiliate_commission	int	Affiliate Commission (E-commerce)
diff_shipping_fee	int	Shipping fee different (E-commerce)
marketplace_voucher	int	E-Commerce voucher (E-commerce)
payment_fee	int	Platform fee (E-commerce)
platform_commission	int	Platform commission (E-commerce)
seller_transaction_fee	int	Payment Fee (E-commerce)
service_fee	int	Service fee (E-commerce)
sfp_service_fee	int	SFP fee (E-commerce)

customer (1.1)

Parameter	Type	Description
fb_id	string	Customer Facebook ID
id	uid	Customer ID
name	string	Full name of customer
page_id	string	Facebook page ID

tags (1.2)

Parameter	Type	Description
id	string	Tag ID
name	string	Tag name

partner (1.3)

Parameter	Type	Description
cod	int	COD reconciliation
delivery_name	string	Delivery
delivery_tel	string	Delivery phone number
extend_code	string	Shipping order ID on partner system
extend_update	array	Update from courier
extend_update.note	string	Courier notes
extend_update.status	string	Status
extend_update.tracking_id	string	Shipping order ID on partner system
extend_update.update_at	time	Updated at
partner_id	int	Partner ID
picked_up_at	time	Picked up at
sort_code	string	Shortened transportation code
total_fee	int	Total fee
updated_at	time	Updated at

items (1.4)

Parameter	Type	Description
components	array	Product components
note	string	Product notes in order
note_product	string	Product notes
inserted_at	time	Creation time
measure_group_id	int	Measure group id
discount_each_product	int	Discount ech product
is_bonus_product	boolean	Bonus product
is_composite	boolean	Product composite
is_discount_percent	boolean	Discount ech product by percent
is_wholesale	boolean	Wholesale
variation_id	uid	Variation ID. Get by api GET /variations
product_id	uid	Product ID. Get by api GET /variations
quantity	int	Product quantity
variation_info	json	Variation information
variation_info.measure_info	json	Measure information
variation_info.measure_info.measure_id	int	Measure id
variation_info.measure_info.exchange_value	int	Exchange value

shipping_address (1.5)

Parameter	Type	Description
address	string	Detailed delivery address (house number, street name, ....)
commnue_name	string	Commune
commune_id	string	Commune ID. Get by api GET/ geo/communes
country_code	string	Country code (for example, Vietnam country code is 84)
district_id	string	District ID. Get by api GET /geo/districts
district_name	string	District
full_address	string	Full address
full_name	string	Full name of customer
phone_number	string	Phone number, name of customer, note, ....
province_id	string	Province ID. Get by api GET /geo/provinces
province_name	string	Province / City

activated_promotion_advances (1.6)

Parameter	Type	Description
id	int	Promotion code
promotion_advance_id	uid	Advanced promotion id
promotion_advance_info	json	Advanced promotional information

sub_status (1.7)	Reason for delivery delay
1	Need to handle
2	Processed
3	Responded

Order status

Status ID	Description
0	New
17	Waiting for confirmation
11	Restocking
12	Wait for printing
13	Printed
20	Purchased
1	Confirmed
8	Packaging
9	Waiting for pick up
2	Shipped
3	Delivered
16	Collected money
4	Returning
15	Partial return
5	Returned
6	Canceled
7	Deleted recently

Partner Status	Status name
request_received	New
delay_pickup	Delay pick up
picking_up	Picking up
picked_up	Picked up
on_the_way	In transit warehouse
delay_delivery	Delay delivery
out_for_delivery	On delivery
undeliverable	Undeliverable
waiting_for_return	Waiting for return
delivered	Delivered
delivered_cod	Delivery and paid
returning	Returning
returned	Returned
returned_cod	Returned and paid
canceled	Canceled

PartnerId	Shipping partner name
0	Snappy
1	Giao hàng tiết kiệm
2	EMS
3	Viettel Post
4	247
5	Giao hàng nhanh
17	Vnpost(Bưu điện)
15	J&T
16	Best Inc
9	DHL
19	Ninja Van
36	Nhất Tín Express
39	Hola Ship
11	Ahamove
37	Grab Express
38	Vạn Phúc Express
32	SuperShip
33	ZTO Express
10	J&T Phi
12	LBC Express
13	Lazada Express
42	Shopee Express
31	Ninja van Phi
35	Byaheros
20	Kerry express
21	Flash express
22	Lalamove
23	J&T Thai
24	Nim express
25	Thailand post
26	Thai parcel
27	DHL Thai
28	CJ logistics
29	Best Express Thai
30	Ninja van Tha
40	LWE

Returned reason	Returned reason description
1	By customer
2	By staff
3	By product
4	Due to shipping partner
5	Due to returning

Tag

GET /shops/<SHOP_ID>/orders/tags?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "color": "#123123",
      "groups": [
        {
          "id": 13,
          "name": "nhom 1"
        },
        {
          "id": 16,
          "name": "nhom 2"
        }
      ],
      "id": 75,
      "name": "thẻ 4"
    },
    {
      "color": "#f04134",
      "groups": [
        {
          "id": -1,
          "name": "Delivery Group"
        },
        {
          "id": 13,
          "name": "nhom 1"
        }
      ],
      "id": 1,
      "is_system_tag": true,
      "name": "Giao không thành"
    },
    {
      "color": "#096dd9",
      "groups": [],
      "id": 2,
      "is_system_tag": true,
      "name": "Chờ cọc"
    },
    ...
  ],
  "success": true
}

Response Parameters

Parameter	Type	Description
id	int	Tag ID
name	string	Tag name
color	string	Tag color code
is_system_tag	boolean	true - System tag
groups	array	Tag group information

Payment method

List payment method

GET /shops/<SHOP_ID>/bank_payments?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "creator_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "id": "e01fed02-8680-4102-bdf4-343a7e1a00f5",
      "inserted_at": "2025-08-19T02:25:37",
      "name": "Tiền cọc",
      "shop_id": 224,
      "updated_at": "2025-08-19T02:25:37"
    }
  ],
  "success": true
}

Response Parameters

Parameter	Type	Description
creator_id	uid	Creator id
id	uid	Payment method id
inserted_at	time	Creation time
name	string	Payment method name
shop_id	int	Shop ID
updated_at	time	Updated at

Return order

List return order

GET /shops/<SHOP_ID>/orders_returned?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "bill_full_name": "HUy",
      "bill_phone_number": "0377666434",
      "creator_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "custom_id": null,
      "discount": 0,
      "discount_from_order_to_returned": 0,
      "display_id": 636,
      "id": 1403,
      "inserted_at": "2024-04-25T08:34:50.000000",
      "order": {
        "prepaid_by_point": {
          "money": 0,
          "point": 0
        },
        "surcharge": 0,
        "money_to_collect": -80000,
        "system_id": 14856,
        "shipping_address": {
          "address": "Ha nội",
          "commnue_name": "Phường Nghĩa Đô",
          "commune_id": "1011301",
          "country_code": "84",
          "district_id": "10113",
          "district_name": "Quận Cầu Giấy",
          "full_address": "Ha nội, Phường Nghĩa Đô, Quận Cầu Giấy, Hà Nội",
          "full_name": "HUy",
          "phone_number": "0377666434",
          "post_code": null,
          "province_id": "101",
          "province_name": "Hà Nội"
        },
        "total_discount": 0,
        "status": 0,
        "items": [
          {
            "added_to_cart_quantity": 2,
            "discount_each_product": 0,
            "exchange_count": 0,
            "id": 45373,
            "product_id": "73ec61e2-52e3-41dd-bd24-b7ec1035184d",
            "quantity": 2,
            "return_quantity": 0,
            "returned_count": 0,
            "returning_quantity": 0,
            "variation_id": "23f91ea1-5cb8-46a1-a8a6-e3819af9abad",
            "variation_info": {
              "barcode": "12392-2",
              "detail": "mau: xanh, size: X",
              "display_id": "Nam Pari XX",
              "exact_price": 200000,
              "fields": [
                {
                  "id": "283d9e1d-c254-4bad-8d69-19be477f2512",
                  "keyValue": "XANH",
                  "name": "mau",
                  "value": "xanh"
                },
                {
                  "id": "968f5f28-d043-4937-911a-9334efede2f1",
                  "keyValue": "X",
                  "name": "size",
                  "value": "X"
                }
              ],
              "last_imported_price": 100000,
              "name": "Áo thời trang Nam Pari",
              "product_display_id": "Áo thời trang Nam Pari",
              "retail_price": 200000,
              "weight": 700
            }
          }
        ],
        "cash": 0,
        "account_name": "wa_c.us@6282288988901",
        "charged_by_qrpay": 0,
        "total_quantity": 2,
        "account": "46",
        "shipping_fee": 20000,
        "time_assign_seller": "2024-04-25T08:34:47",
        "id": "1485614856",
        "total_price": 400000,
        "inserted_at": "2024-04-25T08:32:53.064777",
        "charged_by_momo": 0,
        "prepaid": 0,
        "bill_phone_number": "0377666434",
        "fee_marketplace": 0,
        "total_price_after_sub_discount": 420000,
        "order_sources": "-1",
        "assigning_seller_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
        "bill_full_name": "HUy",
        "order_currency": "VND",
        "shop_id": 20,
        "updated_at": "2024-04-25T08:34:52.471988",
        "return_fee": false,
        "order_link": "https://pos.pages.fm/shop/20/order?order_id=109503",
        "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
        "cod": -80000,
        "is_exchange_order": false,
        "exchange_payment": 500000,
        "items_length": 1,
        "transfer_money": 0,
        "estimate_delivery_date": null,
        "received_at_shop": false,
        "customer_pay_fee": false,
        "partner_fee": 0,
        "charged_by_card": 0,
        "status_name": "new",
      },
      "order_id": 109503,
      "order_id_to_returned": 109502,
      "order_to_returned": {
        "prepaid_by_point": {
          "money": 0,
          "point": 0
        },
        "surcharge": 0,
        "money_to_collect": 1020000,
        "system_id": 14855,
        "shipping_address": {
          "address": "Ha nội",
          "commnue_name": "Phường Nghĩa Đô",
          "commune_code_sicepat": null,
          "commune_id": "1011301",
          "country_code": "84",
          "district_id": "10113",
          "district_name": "Quận Cầu Giấy",
          "full_address": "Ha nội, Phường Nghĩa Đô, Quận Cầu Giấy, Hà Nội",
          "full_name": "HUy",
          "phone_number": "0377666434",
          "post_code": null,
          "province_id": "101",
          "province_name": "Hà Nội"
        },
        "total_discount": 0,
        "status": 3,
        "time_assign_care": null,
        "items": [
          {
            "added_to_cart_quantity": 2,
            "discount_each_product": 0,
            "exchange_count": 0,
            "id": 45372,
            "one_time_product": false,
            "product_id": "73ec61e2-52e3-41dd-bd24-b7ec1035184d",
            "quantity": 2,
            "return_quantity": 1,
            "returned_count": 0,
            "returning_quantity": 1,
            "variation_id": "76887a5b-8a27-472c-a15a-661ea59434dd",
            "variation_info": {
              "barcode": "12392-4",
              "detail": "mau: trang, size: X",
              "display_id": "Nam Pari TX",
              "exact_price": 200000,
              "fields": [
                {
                  "id": "56e0ac18-3bd0-47ac-91ba-0f4056326c1d",
                  "keyValue": "TRANG",
                  "name": "mau",
                  "value": "trang"
                },
                {
                  "id": "50c8ba70-db9a-40e0-8198-af2237335bf2",
                  "keyValue": "X",
                  "name": "size",
                  "value": "X"
                }
              ],
              "last_imported_price": 100000,
              "name": "Áo thời trang Nam Pari",
              "product_display_id": "Áo thời trang Nam Pari",
              "retail_price": 500000,
              "weight": 700
            }
          }
        ],
        "cash": 0,
        "account_name": "wa_c.us@6282288988901",
        "charged_by_qrpay": 0,
        "total_quantity": 2,
        "account": "46",
        "shipping_fee": 20000,
        "time_assign_seller": "2024-04-25T08:33:47",
        "id": "1485514855",
        "order_sources_name": "Facebook",
        "note": "",
        "total_price": 1000000,
        "inserted_at": "2024-04-25T08:32:53.064777",
        "change_by_orders": [
          {
            "bill_full_name": "HUy",
            "bill_phone_number": "0377666434",
            "creator_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
            "custom_id": null,
            "discount": 0,
            "discount_from_order_to_returned": 0,
            "display_id": 636,
            "id": 1403,
            "inserted_at": "2024-04-25T08:34:50.000000",
            "order": {
              "prepaid_by_point": {
                "money": 0,
                "point": 0
              },
              "surcharge": 0,
              "money_to_collect": -80000,
              "p_utm_term": null,
              "system_id": 14856,
              "shipping_address": {
                "address": "Ha nội",
                "commnue_name": "Phường Nghĩa Đô",
                "commune_code_sicepat": null,
                "commune_id": "1011301",
                "country_code": "84",
                "district_id": "10113",
                "district_name": "Quận Cầu Giấy",
                "full_address": "Ha nội, Phường Nghĩa Đô, Quận Cầu Giấy, Hà Nội",
                "full_name": "HUy",
                "phone_number": "0377666434",
                "post_code": null,
                "province_id": "101",
                "province_name": "Hà Nội"
              },
              "total_discount": 0,
              "status": 0,
              "cash": 0,
              "account_name": "wa_c.us@6282288988901",
              "charged_by_qrpay": 0,
              "total_quantity": 2,
              "account": "46",
              "shipping_fee": 20000,
              "time_assign_seller": "2024-04-25T08:34:47",
              "id": "1485614856",
              "order_sources_name": "Facebook",
              "total_price": 420000,
              "inserted_at": "2024-04-25T08:32:53.064777",
              "charged_by_momo": 0,
              "prepaid": 0,
              "bill_phone_number": "0377666434",
              "fee_marketplace": 0,
              "order_sources": "-1",
              "assigning_seller_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
              "bill_full_name": "HUy",
              "order_currency": "VND",
              "shop_id": 20,
              "updated_at": "2024-04-25T08:34:52.471988",
              "return_fee": false,
              "order_link": "https://pos.pages.fm/shop/20/order?order_id=109503",
              "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
              "cod": -80000,
              "is_exchange_order": false,
              "exchange_payment": 500000,
              "transfer_money": 0,
              "is_free_shipping": false,
              "levera_point": 0,
              "received_at_shop": false,
              "customer_pay_fee": false,
              "partner_fee": 0,
              "charged_by_card": 0,
              "status_name": "new",
            },
            "order_id": 109503,
            "order_id_to_returned": 109502,
            "order_to_returned": {},
            "returned_fee": 0,
            "returned_items": [
              {
                "discount_each_product": 0,
                "id": 1423,
                "is_discount_percent": false,
                "product_id": "73ec61e2-52e3-41dd-bd24-b7ec1035184d",
                "returned_quantity": 1,
                "variation_id": "76887a5b-8a27-472c-a15a-661ea59434dd",
                "variation_info": {
                  "barcode": "12392-4",
                  "detail": "mau: trang, size: X",
                  "id": "Nam Pari TX",
                  "images": [
                    "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/9/29/d05f44dcf2b9f96312d88b718da35aa5317242d6.jpg",
                  ],
                  "name": "Áo thời trang Nam Pari",
                  "product_id": "Áo thời trang Nam Pari",
                  "retail_price": 500000,
                  "weight": 700,
                  "wholesale_price": 0,
                }
              }
            ],
            "shop_customer_id": "fd3388d9-d6a6-4fca-8ef5-9e7647395cf0",
            "shop_id": 20,
            "status": 0,
            "updated_at": "2024-04-25T08:34:50.000000",
            "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"
          }
        ],
        "charged_by_momo": 0,
        "prepaid": 0,
        "bill_phone_number": "0377666434",
        "fee_marketplace": 0,
        "post_id": null,
        "total_price_after_sub_discount": 1020000,
        "order_sources": "-1",
        "assigning_seller_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
        "bill_full_name": "HUy",
        "activated_promotion_advances": [],
        "order_currency": "VND",
        "shop_id": 20,
        "updated_at": "2024-04-25T08:34:52.680954",
        "order_link": "https://pos.pages.fm/shop/20/order?order_id=109502",
        "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
        "cod": 1020000,
        "is_exchange_order": true,
        "exchange_payment": 0,
        "items_length": 1,
        "transfer_money": 0,
        "levera_point": 0,
        "received_at_shop": false,
        "creator": {
          "email": "vuson897654@gmail.com",
          "fb_id": "377936050731194",
          "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
          "name": "Vũ Sơn",
          "phone_number": null
        },
        "assigning_care_id": null,
        "partner_fee": 0,
        "charged_by_card": 0,
        "status_name": "delivered",
        "sub_status": null,
        "assigning_care": null,
        "note_print": null
      },
      "returned_fee": 0,
      "returned_items": [
        {
          "discount_each_product": 0,
          "id": 1423,
          "product_id": "73ec61e2-52e3-41dd-bd24-b7ec1035184d",
          "returned_quantity": 1,
          "variation_id": "76887a5b-8a27-472c-a15a-661ea59434dd",
          "variation_info": {
            "barcode": "12392-4",
            "detail": "mau: trang, size: X",
            "id": "Nam Pari TX",
            "images": [
              "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/9/29/d05f44dcf2b9f96312d88b718da35aa5317242d6.jpg",
            ],
            "name": "Áo thời trang Nam Pari",
            "one_time_product_id": null,
            "product_id": "Áo thời trang Nam Pari",
            "retail_price": 500000,
            "retail_price_by_currency": [
              {
                "currency": "USD",
                "retailPriceByCurrency": "100"
              },
              {
                "currency": "VND",
                "retailPriceByCurrency": "200000"
              }
            ],
            "weight": 700,
          }
        }
      ],
      "shop_customer_id": "fd3388d9-d6a6-4fca-8ef5-9e7647395cf0",
      "shop_id": 20,
      "status": 0,
      "status_histories": [
        {
          "editor_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
          "id": "71d9ecce-986f-4cbe-90be-ddaefb0b4c5a",
          "inserted_at": "2024-04-25T08:34:52.000000",
          "old_status": null,
          "status": 0,
          "updated_at": "2024-04-25T08:34:52.000000"
        }
      ],
      "tags": [],
      "updated_at": "2024-04-25T08:34:50.000000",
      "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"
    }
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 636
}

Query Parameters

Parameter	Required	Type	Default	Description	Example
page	false	int	1
page_size	false	int	30
status	false	int	-1	Status
update_status	false	string / int	inserted_at	Filter orders by time
start_time	false	unix timestamp	null	Start date	1699635600
end_time	false	unix timestamp	null	End date	1699635600

update_status	Filter orders by time
inserted_at	Create order
0	New
2	Shipped
1	Completed
4	Canceled

Warehouse

Create warehouses

POST /shops/<SHOP_ID>/warehouses?api_key=<api_key> HTTP/1.1

Request

{
  "address": "19/349 Minh Khai , Hai bà Trưng, Hà Nội",
  "batch_config": {
    "col": "0",
    "line": "3",
    "row": "3"
  },
  "commune_id": "1010735",
  "custom_batch_config": {
    "custom_config": {
      "0": "lô 1"
    }
  },
  "custom_shelf_config": {
    "custom_config": {
      "0": "1.1",
      "1": "1.2",
      "2": "1.3",
      "3": "1.4"
    }
  },
  "country_code": "84",
  "district_id": "10107",
  "hide_config_batch_shelf": false,
  "name": "kho 2",
  "phone_number": "098765432",
  "province_id": "101",
  "shelf_config": {
    "col": "3"
  }
}

Query Parameters

Parameter	Required	Type	Default
address	false	string	Details dddress of warehouse (number of houses, roads, ...)
batch_config	false	json	Batch config
country_code	false	string	Country code
commune_id	false	string	Commune ID. Get by api GET/ geo/communes
custom_batch_config	false	json	Custom batch config
custom_shelf_config	false	json	Custom shelf config
district_id	false	string	District ID. Get by api GET /geo/districts
hide_config_batch_shelf	false	boolean	Open custom batch shelf config
province_id	false	string	Province ID. Get by api GET /geo/provinces
phone_number	false	string	Warehouse phone number
name	true	string	Warehouse name
shelf_config	true	json	Shelf config

Update warehouse

PUT /shops/<SHOP_ID>/warehouses/<WAREHOUSE_ID>/?api_key=<api_key> HTTP/1.1

Request

{
  "address": "190 La Thành",
  "batch_config": {
    "col": "0",
    "line": "3",
    "row": "3"
  },
  "commune_id": "1011309",
  "custom_batch_config": {
    "custom_config": {
      "0": "lô 1"
    }
  },
  "custom_shelf_config": {
    "custom_config": {
      "0": "1.1",
      "1": "1.2",
      "2": "1.3",
      "3": "1.4"
    }
  },
  "district_id": "10113",
  "hide_config_batch_shelf": false,
  "name": "Kho mặc định",
  "phone_number": "0366452565",
  "province_id": "101",
  "shelf_config": {
    "col": "3"
  }
}

Query Parameters

Parameter	Required	Type	Default
address	false	string	Details dddress of warehouse (number of houses, roads, ...)
batch_config	false	json	Batch config
country_code	false	string	Country code
commune_id	false	string	Commune ID. Get by api GET/ geo/communes
custom_batch_config	false	json	Custom batch config
custom_shelf_config	false	json	Custom shelf config
district_id	false	string	District ID. Get by api GET /geo/districts
hide_config_batch_shelf	false	boolean	Open custom batch shelf config
province_id	false	string	Province ID. Get by api GET /geo/provinces
phone_number	false	string	Warehouse phone number
name	true	string	Warehouse name
shelf_config	true	json	Shelf config

List of warehouses

GET /shops/<SHOP_ID>/warehouses?api_key=<api_key> HTTP/1.1

Response

{
    "data": [
      {
        "address": "hâhhha",
        "allow_create_order": true,
        "commune_id": "7170510",
        "country_code": "84",
        "custom_id": null,
        "district_id": "71705",
        "full_address": "hâhhha, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu",
        "id": "b4cb5897-6e56-4581-96cc-2f12677c7bd8",
        "name": "kho test ecod",
        "phone_number": "0999999999",
        "province_id": "717",
        "shop_id": 26290
      },
      {
        "address": "19/349 Minh Khai , Hai bà Trưng, Hà Nội",
        "allow_create_order": false,
        "commune_id": "1010735",
        "country_code": "84",
        "custom_id": null,
        "district_id": "10107",
        "full_address": "19/349 Minh Khai , Hai bà Trưng, Hà Nội, Phường Minh Khai, Quận Hai Bà Trưng, Hà Nội",
        "id": "644b0063-e9a8-43cd-ba08-66a8066d462e",
        "name": "kho 2",
        "phone_number": "01655809949",
        "province_id": "101",
        "shop_id": 26290
      }
    ]
}

Response Parameters

Parameter	Type	Description
address	string	Details dddress of warehouse (number of houses, roads, ...)
allow_create_order	boolean	Warehouse can create orders
commune_id	string	Commune ID
district_id	string	District ID
province_id	string	Province ID
country_code	string	Country code
custom_id	string	Warehouse custom code
id	uid	Warehouse ID
full_address	string	Full address warehouse
name	string	Warehouse name
phone_number	string	Warehouse phone number

List of employee

GET /shops/<SHOP_ID>/users?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "department": {
        "id": 933,
        "name": "Sales"
      },
      "shop_id": 7,
      "user": {
        "email": "2042723249341651@facebook.com",
        "fb_id": "2042723249341651",
        "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
        "name": "Hoang Anh",
        "phone_number": null
      },
      "user_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
      "sale_group": {
        "id": 30,
        "name": "Ca sáng"
      }
    }
  ],
  "success": true
}

Response Parameters

Parameter	Type	Description
department	json	Department information
shop_id	int	Shop ID
user_id	uid	Employee code
user	json	Employee information
user.email	string	Employee email
user.fb_id	string	Employee facebook ID
user.name	string	Employee name
user.phone_number	string	Employee phone number
sale_group	json	Sale group information
sale_group.id	int	Sale group ID
sale_group.name	string	Sale group name

Call later & Reminder

List of call later & reminders

GET /shops/<SHOP_ID>/order_call_laters?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "called_at": "2024-01-30T01:54:17",
      "creator": {
        "avatar_url": null,
        "email": "vuson897654@gmail.com",
        "fb_id": "377936050731194",
        "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
        "name": "Vũ Sơn",
        "phone_number": null
      },
      "display_id": 70,
      "id": "1885d8d4-e210-4e56-bb32-683988a032f5",
      "need_notify_users": [
        "cee3c05e-5f85-43c4-b27e-889b99c50097"
      ],
      "needs_call_at": "2024-01-30T02:20:48",
      "notice_created": "Gọi lại cho khách",
      "order_display_id": "SOICUN-12943-02",
      "order_id": 106703,
      "status": 1,
      "type": "call"
    },
    ...
  ],
  "key": "today",
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 3,
  "total_pages": 1
}

Query Parameters

Parameter	Required	Type	Default	Description
page_number	false	int	1
page_size	false	int	30
key	false	string	today
status	false	int	-1	Status

Status	Status name
-1	All status
0	Not processed
3	Calling / Processing
1	Processed
2	Not listening / Unsuccessful
7	Removed

Response Parameters

Parameter	Type	Description
called_at	unix timestamp	Called at / Processed at
creator	json	Creator information
display_id	int	Call later & reminder id
need_notify_users	array	Processing staff
needs_call_at	unix timestamp	Need to call at / Need to process at
notice_created	string	Notice information
order_display_id	string	Order ID
status	int	Status
type	string	Notification type

Create call later and remind

POST /shops/<SHOP_ID>/order_call_laters?api_key=<api_key> HTTP/1.1

Request

{
  "order_call_later": {
    "status": 0,
    "need_notify_users": [
      "cee3c05e-5f85-43c4-b27e-889b99c50097"
    ],
    "notice_created": "Gọi lại xác nhận",
    "needs_call_at": "2024-08-29T05:50:31.700Z",
    "phone_number": "0929911922",
    "order_ids": ["106703"]
  }
}

Query Parameters

Parameter	Required	Type	Description
status	false	int	Status
need_notify_users	false	array	Processing staff
notice_created	false	string	Notice information
needs_call_at	true	iso 8601	Need to call at
phone_number	true	string	Phone number
order_ids	false	array	Order ID

Product

Create product

POST /shops/<SHOP_ID>/products?api_key=<api_key> HTTP/1.1

Request

{
  "product": {
    "name": "Ao so mi nam",
    "category_ids": [1290021044, 201250699],
    "note_product": "Ghi chú sản phẩm",
    "product_attributes": [{"name": "Màu", "values": ["Đen", "Trắng", "Đỏ"]}, {"name": "Size", "values": ["S", "M", "L"]}],
    "tags": [193, 51],
    "variations": [
      {
        "fields": [{"name": "Màu", "value": "Trắng"}, {"name": "Size", "value": "M"}],
        "images": ["https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"],
        "last_imported_price": 30000,
        "retail_price": 140000,
        "price_at_counter": 123000,
        "weight": 0,
        "barcode": "BARCODE123",
        "custom_id": "VCUSTOMID",
        "is_hidden": false
      }
    ],
    "weight": 1,
    "custom_id": "PCUSTOMID",
    "is_published": true,
    "variations_warehouses": [
      {
        "remain_quantity": 10,
        "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
        "batch_position": "lô 1",
        "shelf_position": "1.2"
      }
    ],
    "materials": [182, 193],
    "keyword": "vai|cao cấp"
  }
}

Query Parameters

Parameter	Required	Type	Description	Example
name	true	string	Product name	Test
category_ids	false	array	Category Id	[1290021044, 201250699]
note_product	false	string	Product notes
product_attributes	false	array	Attribute information	[{name: "Màu", values: ["Đen", "Trắng", "Đỏ"]}, {name: "Size", values: ["S", "M", "L"]}]
tags	false	array	Product tags	[193, 51]
weight	true	int	Product weight	100
custom_id	false	string	Product custom code	TEST1
is_published	false	boolean	StoreCake status	true
variation.images	false	array	Image link	"https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
variation.last_imported_price	false	int	Imported price	30000
variation.retail_price	true	int	Variation retail price	1400000
variation.price_at_counter	false	int	Price at counter	123000
variation.weight	true	int	Variation weight	100
variation.barcode	false	string	Variation barcode ID	BAR001
variation.custom_id	false	string	Variation custom code	TEST1001
variation.is_hidden	false	string	StoreCake status is_hidden = true -> hide, is_hidden = false -> no hide	false
variation.fields	false	array	Variation attribute information	[{name: "Màu", value: "Trắng"}, {name: "Size", value: "M"}]
variation.variations_warehouses	false	array	Warehouse information	[{remain_quantity: 10, warehouse_id: "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da", batch_position: "lô 1", "shelf_position": "1.2"}]
materials	false	array	Material IDs	[182, 193]
keyword	false	string	keyword	vai|cao cap (Keywords are separated by "|")

Update product information

PUT /shops/<SHOP_ID>/products/<PRODUCT_ID>?api_key=<api_key> HTTP/1.1

Request

{
  "product": {
    "name": "Ao so mi nam",
    "category_ids": [1290021044, 201250699],
    "note_product": "Ghi chú sản phẩm",
    "product_attributes": [{"name": "Màu", "values": ["Đen", "Trắng", "Đỏ"]}, {"name": "Size", "values": ["S", "M", "L"]}],
    "variations": [
      {
        // Cập nhật mẫu mã cũ
        "id": "3c3aca82-030e-4708-a75b-b2eaf538a2f5",
        "fields": [{"name": "Màu", "value": "Trắng"}, {"name": "Size", "value": "M"}],
        "images": [],
        "last_imported_price": 30000,
        "retail_price": 140000,
        "price_at_counter": 123000,
        "weight": 0,
        "barcode": "BARCODE123",
        "custom_id": "VCUSTOMID",
        "is_hidden": false
        "variations_warehouses": [
          {
            "remain_quantity": 10,
            "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
            "batch_position": "lô 1",
            "shelf_position": "1.2"
          }
        ]
      },
      {
        // Tạo mẫu mã mới cho Sản phẩm
        "fields": [{"name": "Màu", "value": "Đỏ"}, {"name": "Size", "value": "L"}],
        "images": ["https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"],
        "last_imported_price": 30000,
        "retail_price": 140000,
        "price_at_counter": 123000,
        "weight": 0,
        "barcode": "BARCODE123",
        "custom_id": "VCUSTOMID2",
        "is_hidden": false,
        "variations_warehouses": [
          {
            "remain_quantity": 10,
            "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
            "batch_position": "lô 1",
            "shelf_position": "1.2"
          }
        ]
      }
    ],
    "weight": 1,
    "custom_id": "PCUSTOMID",
    "is_published": true,
    "tags": [193, 51],
    "materials": [182, 193],
    "keyword": "vai|cao cấp"
  }
}

Query Parameters

Parameter	Type	Description	Example
name	string	Product name	Test
category_ids	array	Category Id	[1290021044, 201250699]
note_product	string	Product notes
product_attributes	array	Attribute information	[{name: "Màu", values: ["Đen", "Trắng", "Đỏ"]}, {name: "Size", values: ["S", "M", "L"]}]
tags	array	Product tags	[193, 51]
weight	int	Product weight	100
custom_id	string	Product custom code	TEST1
is_published	false	boolean	StoreCake status
variations	array	Product variation
variation.images	array	Image link	"https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
variation.last_imported_price	int	Imported price	300000
variation.retail_price	int	Variation retail price	1000000
variation.price_at_counter	int	Price at counter	123000
variation.weight	int	Variation weight	100
variation.barcode	string	Variation barcode ID	BAR001
variation.custom_id	string	Variation custom code	TEST1001
variation.is_hidden	boolean	StoreCake status is_hidden = true -> hide, is_hidden = false -> no hide	false
variation.fields	array	Variation attribute information	[{name: "Màu", value: "Trắng"}, {name: "Size", value: "M"}]
variation.variations_warehouses	array	Thông tin kho	[{remain_quantity: 10, warehouse_id: "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da", batch_position: "lô 1", "shelf_position": "1.2"}]
variation.is_removed	boolean	true: Remove variation, false: No remove variation	false
materials	array	Material IDs	[182, 193]
keyword	string	keyword	vai|cao cap (Keywords are separated by "|")

Update inventory

POST /shops/<SHOP_ID>/variations/<VARIATION_ID>/update_quantity?api_key=<api_key> HTTP/1.1

Request

{
 "variations_warehouses": [
    {
      "remain_quantity": 20,
      "warehouse_id": "a41b5d73-9236-4a5d-9954-4db6d93242d1"
    },
    {
      "remain_quantity": 20,
      "warehouse_id": "a41b5d73-9236-4a5d-9954-4db6d93242d4"
    },
    {
      "remain_quantity": 20,
      "warehouse_id": "a41b5d73-9236-4a5d-9954-4db6d93242d5"
    }
  ]
}

Query Parameters

Parameter	Type	Description	Example
VARIATION_ID	string	Variation ID	e190db2b-1163-4cc3-b956-7a9528fbf5ef
variations_warehouses	array	Inventory information
variations_warehouses.remain_quantity	int	Inventory remain quantity
variations_warehouses.warehouse_id	string	Warehouse ID
is_actual_remain_quantity	boolean	true: Update inventory, false: Update remain quantity

Updated inventory of many variations

POST /shops/<SHOP_ID>/variations/update_quantity?api_key=<api_key> HTTP/1.1

Request

{
  "is_actual_remain_quantity": true,
  "variations_warehouses": [
    {
      "variation_id": "20e7d183-c70c-445e-8ce2-4d7e3a378e34",
      "remain_quantity": 15,
      "warehouse_id": "229102e4-39c3-4523-bd57-4ed0a45a85ba"
    },
    {
      "variation_id": "5f0cfb8d-aee9-4ec0-9ff0-b5668d3143d2",
      "remain_quantity": 15,
      "warehouse_id": "24c4447e-c35f-4acc-affa-70e49eb354d1"
    },
    {
      "variation_id": "5f0cfb8d-aee9-4ec0-9ff0-b5668d31fhl3",
      "remain_quantity": 15,
      "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"
    }
  ]
}

Query Parameters

Parameter	Type	Description
is_actual_remain_quantity	boolean	true: Update inventory, false: Update remain quantity
variations_warehouses	array	Inventory information
variations_warehouses.variation_id	string	Variation ID
variations_warehouses.remain_quantity	int	Inventory remain quantity
variations_warehouses.warehouse_id	string	Warehouse ID

Update composite product

POST /shops/<SHOP_ID>/variations/update_composite_product?api_key=<api_key> HTTP/1.1

Request

{
  "variation_id": "79aecce9-3b1e-4ad3-afe1-2ee658720687",
  "composite_products": [
    {
      "quantity": 1,
      "component_id": "67b19856-3226-457e-a746-df26e4ec1360"
    }
  ]
}

Query Parameters

Parameter	Type	Description
variation_id	uid	Variation ID
composite_products.quantity	int	Composite quantity
composite_products.component_id	string	Composite variation id

List of products

GET /shops/<SHOP_ID>/products/variations?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "barcode": null,
      "display_id": "ADXL",
      "is_hidden": false,
      "is_locked": false,
      "is_sell_negative_variation": true,
      "fields": [
        {
          "id": "b032c515-3f71-4a1b-8e1d-77721ae72f37",
          "name": "màu",
          "value": "nâu"
        },
        {
          "id": "677c14b5-458f-4af6-8d73-08bcb2245547",
          "name": "size",
          "value": "s"
        }
      ],
      "id": "e190db2b-1163-4cc3-b956-7a9528fbf5ef",
      "images": [
        "https://cf.shopee.vn/file/03e670d02803fcfbb17b2b719762ee17",
        "https://cf.shopee.vn/file/9070bb1b0e6fcc84b46b6e5057544023"
      ],
      "inserted_at": "2024-01-10T14:34:44.000000",
      "last_imported_price": 55000,
      "price_at_counter": 123000,
      "product_id": "3b98a639-9d40-4faa-a692-6662f20e128d",
      "product": {
        "note_product": "Ghi chú sản phẩm",
        "categories": [],
        "display_id": "ADXL",
        "image": "https://content.pancake.vn/user-content-dev2.pancake.vn/2024/11/7/1fdf82943574017240257bf9c88bc70a06a8813a.png",
        "inserted_at": "2024-01-10T14:34:44",
        "name": "ASOS đen XL",
        "tags": [
          {
            "id": 51,
            "note": "the 3"
          },
          {
            "id": 193,
            "note": "thẻ 1"
          }
        ],
        "is_published": true,
        "manipulation_warehouses": [
          "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"
        ]
      },
      "remain_quantity": 20,
      "retail_price": 140000,
      "total_purchase_price": 4500000,
      "variations_warehouses": [
        {
          "actual_remain_quantity": 100,
          "pending_quantity": 0,
          "remain_quantity": 20,
          "returning_quantity": 0,
          "selling_avg": 0.23,
          "total_quantity": 102,
          "warehouse_id": "a41b5d73-9236-4a5d-9954-4db6d93242d1"
        }
      ],
      "wholesale_price": []
    }
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 751,
  "total_pages": 26
}

Query Parameters

Parameter	Required	Type	Default	Description	Example
page_size	false	int	30
page_number	false	int	1
search	false	string	null
selling_status (1)	false	string		Selling speed
product_status (2)	false	string		Product status
category_id	false	array		Category Id
is_filter_categories_by_or	false	boolean	true	Filter category by "or" condition
filter_exclude_categories	false	boolean	false	Filter exclude category
warehouse_until	false	time	null	Get inventory information at time	2024-06-10T17:00:00.000Z
promotion_advance (3)	false	array	null	Promotion advance ID	[18614714-61d0-402f-96a8-dd968e1eb2cd, ...]
manipulationWarehouse	false	array	null	Manipulation warehouse id	[43614714-61d0-402f-96a8-dd968e1eb2cd, ...]
startDate	false	unix timestamp	null	Product creation start time	1748797200
endDate	false	unix timestamp	null	Product creation end time	1749488399
start_time_update	false	unix timestamp	null	Product update start time	1748797200
end_time_update	false	unix timestamp	null	Product update end time	1749488399
included_composite (4)	false	string	false	Filter composite products	parent

selling_status (1)

value	Description
none	Testing
bad	Slow
normal	Normal
star	Popular

product_status (2)

value	Description
locked	deactivate
not_locked	active

promotion_advance (3)

value	Description
[18614714-61d0-402f-96a8-dd968e1eb2cd, ...]	Promotion advance ID
[has_promotion]	Has promotion
[no_promotion]	No promotion

included_composite (4)

value	Description
parent	Composed of other products
children	Composed for other products

Reponse Parameters

Parameter	Type	Description
display_id	string	Product display id
note_product	string	Product notes
is_hidden	boolean	StoreCake status is_hidden = true -> hide, is_hidden = false -> no hide
is_locked	boolean	Locked product
is_sell_negative_variation	boolean	Allow sell negative
fields	json	Details information of product
field.name	string	Attribute name
field.value	string	Attribute value
id	uid	Variation ID
last_imported_price	int	Price import
product.categories	array	Product categories
product.display_id	string	Product display id
product.image	string	The product's representative image
product.inserted_at	iso 8601	Product inserted at
product.name	string	Product name
product.tags	array	Product tags
product.is_published	boolean	StoreCake status
product.manipulation_warehouses	array	Manipulation warehouse id
product_id	uid	Product ID
remain_quantity	int	Number of remaining products
retail_price	int	Retail price
price_at_counter	int	Price at counter
total_purchase_price	int	Remaining goods value
variations_warehouses	array	Detail information of inventory
variations_warehouses.actual_remain_quantity	int	In stock
variations_warehouses.pending_quantity	int	Pending quantity
variations_warehouses.remain_quantity	int	Number of remaining products in warehouse
variations_warehouses.returning_quantity	int	Returning quantity
variations_warehouses.selling_avg	float	Average selling
variations_warehouses.total_quantity	int	Total quantity
variations_warehouses.warehouse_id	uid	Warehouse ID
wholesale_price	array	Wholesale price
images	array	Image link
inserted_at	iso 8601	Variation inserted at

Hide product

PUT /shops/<SHOP_ID>/products/update_hide?api_key=<api_key> HTTP/1.1

Request

{
  "is_hide": true,
  "product_ids": [
    "3cbf2227-0205-446e-8c0e-584995f3cb23",
    "36b1e64c-f1f7-4518-afeb-1f9d2edc0f3e"
  ]
}

Request Parameters

Parameter	Required	Type	Description
is_hide	true	boolean	Hide product
product_ids	true	array	Product ID

Product categories

GET /shops/<SHOP_ID>/categories?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "id": 865301,
      "nodes": [],
      "text": "AirSense Áo Khoác Siêu Nhẹ",
    },
    {
      "id": 30163,
      "nodes": [
        {
          "id": 30167,
          "nodes": [],
          "text": "Áo Thun",
        },
        {
          "id": 30169,
          "nodes": [
            {
              "id": 865293,
              "nodes": [],
              "text": "Áo Thun In Họa Tiết"
            }
          ],
          "text": "Áo Cardigan",
        },
        {
          "id": 865292,
          "nodes": [],
          "text": "Áo Nỉ & Áo Hoodie",
        }
      ],
      "text": "ÁO",
    }
  ],
  "success": true
}

Response Parameters

Parameter	Type	Description
id	int	Category Id
text	string	Category name
nodes	array	Children category

Product material

GET /shops/<SHOP_ID>/materials_products?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "description": "cao cấp",
      "id": 180,
      "name": "vai",
      "nodes": [
        {
          "description": "chất liệu bò",
          "id": 181,
          "name": "vải bò",
          "nodes": []
        }
      ]
    }
  ],
  "success": true
}

Response Parameters

Parameter	Type	Description
description	string	Description
id	int	Material ID
name	string	Material name
nodes	array	Children material

Measure group

List of measure groups

GET /shops/<SHOP_ID>/product_measurements/get_measure?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "id": 58,
      "name": "Nước hoa 1",
      "nodes": [
        {
          "exchange_value": 30,
          "id": 61,
          "is_default": false,
          "name": "30 ml",
          "parent_id": 58,
        },
      ],
      "shop_id": 20
    },
    ...
  ],
  "success": true
}

Response Parameters

Parameter	Type	Description
id	int	Measure group id
name	string	Measure group name
nodes	array	Measure group information
nodes.exchange_value	int	Exchange value
nodes.id	int	Measure id
nodes.is_default	boolean	Default measure
nodes.name	string	Measure name
nodes.parent_id	int	Measure group id

Supplier

Supplier list

GET /shops/<SHOP_ID>/supplier?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "address": "90 cầu giấy",
      "commune_id": "1011309",
      "country_code": 84,
      "custom_id": "HH",
      "debt_must_pay": "88334",
      "description": null,
      "district_id": "10113",
      "full_address": "90 cầu giấy, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
      "id": 988,
      "images": [
        "https://content.pancake.vn/user-content-dev2.pancake.vn/2025/7/9/8029d570d92ca81812c6ed59465fe75db042e7f9.png"
      ],
      "is_activated": true,
      "name": "CT TNHH Hồng Hà",
      "payment_info": {
        "account_name": "THANG LONG",
        "account_number": "123456789",
        "partner_code": "CTG"
      },
      "phone_number": "0983239908",
      "province_id": "101",
      "tags": [5],
      "total_purchase": "344444",
      "type": 0
    },
    ...
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_debt": 1000000,
  "total_entries": 30,
  "total_pages": 1
}

Response Parameters

Parameter	Type	Description
address	string	Detailed delivery address (house number, street name, ....)
commune_id	string	Commune ID
country_code	int	Country code
custom_id	string	Supplier products id
debt_must_pay	string	Debt must pay
description	string	Description
district_id	string	District ID
full_address	string	Full address
images	array	Image link
is_activated	boolean	Active status (true: active, false: inactive)
name	string	Supplier name
payment_info	string	Payment information
phone_number	string	Phone number
province_id	string	Province ID
tags	array	Tag
total_purchase	string	Total purchase
type	int	Supplier type (-1: Product / raw material supplier, 0: Product supplier, 1: Raw material supplier)

E-commerce platform

E-commerce platform account

GET /shops/<SHOP_ID>/marketplace/get_account_info?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "id": "252068408",
      "marketplace_id": "-3",
      "name": "ILABY",
      "shop_id": 20
    },
    {
      "id": "VN100U7",
      "marketplace_id": "-4",
      "name": "vuson8910@gmail.com",
      "shop_id": 20
    }
    ...
  ],
  "success": true
}

Query Parameters

Parameter	Required	Type	Default	Example
account_id	false	string	null	252068408
marketplace_id	false	string	null	-3
name	false	string	null	ILABY

Response Parameters

Parameter	Type	Description
id	string	E-commerce platform Shop Id
marketplace_id (1)	string	E-commerce platform Id
name	string	Account name
shop_id	int	Shop id

marketplace_id (1)

value	Description
-2	Tiki
-3	Shopee
-4	Lazada
-6	Sendo
-9	TikTok
-16	WooCommerce
-17	Shopify
-20	Line Shopping
-25	Tokopedia
-27	Mercado Libre

Evaluation on E-Commerce Platform

Evaluation List

GET /shops/<SHOP_ID>/shopee/evaluate?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "buyer": "Vu Son",
      "comment": "Giao nhanh, gói cẩn thận Đúng loại và sản phẩm y như mô tả Mình mua nhiều lần rồi và rất ưng vị của shop",
      "create_at": "2024-08-12T08:31:22",
      "last_rating": 3,
      "marketplace": {
        "marketplace_shop_id": "20732730",
        "marketplace_shop_name": "Vũ Sơn shop"
      },
      "marketplace_id": "-3",
      "order_id": "240806J7RNCBUB",
      "product": {
        "images": [
          "https://content.pancake.vn/user-content-dev2.pancake.vn/2024/4/15/841a6d57f52f22176dea7a9a6fb35761c89fd4eb.jpg"
        ],
        "marketplace_product_name": "Áo thun nam form rộng 12 con giáp tuổi Sửu ATD478 Miucho Iconic cotton cổ tròn in graphic"
      },
      "product_name": "Áo thun nam form rộng 12 con giáp tuổi Sửu ATD478 Miucho Iconic cotton cổ tròn in graphic",
      "rating": 5,
      "reply": {
        "hidden": false,
        "reply": "Cảm ơn quý khách đã mua hàng và đánh giá tốt cho shop!\nQuý khách thật tuyệt vời khi đã đặt hàng, nhận hàng và dành thời gian đánh giá tích cực.\nNếu có bất kể vấn đề gì quý khách cứ nhắn tin shop bảo đảm xử lý có lợi cho khách hàng.\nShop vô cùng cầu thị với mong muốn được phục vụ quý khách trong những đơn hàng tiếp theo.\nShop xin chúc quý khách cùng gia đình mạnh khoẻ, vui vẻ, may mắn, bình an!\n\n"
      },
      "shop_id": 224,
      "variation": {
        "images": ["https://content.pancake.vn/user-content-dev2.pancake.vn/2024/4/15/0636d7492a531270596064c3712b0e228a843c3b.jpg"],
        "marketplace_sku": "ATD478-2X-CC-M"
      }
    },
    ...
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 69,
  "total_pages": 3
}

Query Parameters

Parameter	Required	Type	Default
page	false	int	1
page_size	false	int	30

Response Parameters

Parameter	Type	Description
buyer	string	Buyer
comment	string	Buyer Comment
create_at	iso 8601	Creation time
last_rating	int	Latest evaluation
order_id	string	Order ID
product	json	Product Information
product_name	string	Product name
rating	int	Evaluation
reply	json	Response Information
reply.hidden	boolean	true: hidden, false: visible
reply.reply	string	Response Content
variation	json	Variation information
marketplace	json	E-commerce platform Information
marketplace.marketplace_shop_id	string	E-commerce platform Shop Id
marketplace.marketplace_shop_name	string	E-commerce platform Shop Name
marketplace_id	string	E-commerce platform Id

Customer

List of customers

GET /shops/<SHOP_ID>/customers?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "date_of_birth": "1999-09-01",
      "fb_id": null,
      "reward_point": 10,
      "id": "b0110315-b102-436b-8b3b-ed8d16740327",
      "last_order_at": "2020-04-01T10:18:41",
      "level": null,
      "name": "Trần Thủ độ",
      "order_count": 108,
      "phone_numbers": ["0999999999"],
      "emails": ["thudo@gmail.com"],
      "reward_point": 100.5,
      "purchased_amount": 0,
      "reward_point": 0.0,
      "referral_code": "1nw4geGA",
      "shop_customer_addresses": [
        {
          "address": "lê văn lương",
          "commune_id": null,
          "country_code": null,
          "district_id": "10101",
          "full_address": "lê văn lương, Quận Ba Đình, Hà Nội",
          "full_name": "test",
          "id": "0fefd213-7d0c-4d5b-bdbf-35694da80857",
          "phone_number": "0999999999",
          "province_id": "101"
        },
        {
          "address": "asdsad",
          "commune_id": "2210951",
          "country_code": null,
          "district_id": "22109",
          "full_address": "asdsad, Xã Châu Minh, Huyện Hiệp Hòa, Bắc Giang",
          "full_name": "test",
          "id": "ea55405d-9879-4075-8ec4-5df01504f8ec",
          "phone_number": "0999999999",
          "province_id": "221"
        }
      ],
      "succeed_order_count": 8,
      "tags": [],
      "gender": "male"
    }
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 3,
  "total_pages": 1
}

Query Parameters

Parameter	Required	Type	Default	Description	Example
page_size	false	int	30
page_number	false	int	1
search	false	string	null
start_time_inserted_at	false	unix timestamp		Start Time (Create)	1710608400
end_time_inserted_at	false	unix timestamp		End Time (Create)	1713286799
start_time_updated_at	false	unix timestamp		Start Time (Update)	1712595600
end_time_updated_at	false	unix timestamp		End Time (Update)	1713286799
customer_ids	false	string	null	Customer ID	"4c74b7cf-f87b-484e-8549-6872d964f78f,d74e7fe9-580e-45e5-9374-7241297bd69d"
selectedLevel	false	array	null	Customer level Id	["508c9819-a681-4ae2-bcff-acf92bf4e5fa"]

Response Parameters

Parameter	Type	Description
date_of_birth	string	Birthday
fb_id	string	Facebook ID
reward_point	int	Reward points
id	uid	Customer ID
name	string	Full name of customer
order_count	int	Number of order
phone_numbers	array	Customer's phone number list
emails	array	Customer email
last_order_at	time	Last purchase times
purchased_amount	int	Amount purchased
shop_customer_addresses	array	Customer address information
succeed_order_count	int	Number of successful purchases
full_address	string	Full address warehouse
tags	array	Customer tags
phone_number	string	Warehouse phone number
reward_point	float	Reward points
referral_code	string	Referral code
gender	string	Giới tính

Create customer

POST /shops/<SHOP_ID>/customers?api_key=<api_key> HTTP/1.1

Response

{
  "data": {
    "succeed_order_count": 0,
    "emails": [],
    "total_amount_referred": null,
    "gender": null,
    "creator_id": "e4cec6de-96fa-4c16-9523-07910ddfee8e",
    "is_block": false,
    "name": "Nguyen Van Hoang",
    "phone_numbers": [
      "0903924956"
    ],
    "conversation_tags": null,
    "currency": null,
    "last_order_at": "2024-05-16T17:00:00",
    "tags": [],
    "username": null,
    "order_count": 0,
    "assigned_user_id": "e4cec6de-96fa-4c16-9523-07910ddfee8e",
    "reward_point": 0,
    "id": "9e749e68-142f-4587-a3b1-70279c30b5c2",
    "is_adjust_debts": null,
    "level": null,
    "customer_id": "5b717afb-1856-48c9-9b6e-b8ac9db7d520",
    "updated_at": "2024-05-14T02:59:02",
    "referral_code": "gqo7ulKf",
    "count_referrals": 0,
    "notes": [],
    "is_discount_by_level": true,
    "shop_id": 20,
    "purchased_amount": 0,
    "current_debts": 0,
    "list_voucher": [],
    "date_of_birth": "1995-02-01",
    "used_reward_point": 0,
    "fb_id": null,
    "user_block_id": null,
    "inserted_at": "2024-05-14T02:59:02",
    "shop_customer_addresses": [
      {
        "address": null,
        "commune_id": null,
        "country_code": 84,
        "district_id": null,
        "full_address": null,
        "full_name": null,
        "id": "deeb419a-e7b6-42fd-9684-52ec6a72a41a",
        "phone_number": "0903924956",
        "province_id": null
      }
    ],
    "returned_order_count": 0,
    "active_levera_pay": false
  },
  "success": true
}

Query Parameters

Parameter	Required	Type	Description	Example
name	true	string	Full name of customer	Nguyen Van Hoang
phoneNumber	true	string	Phone number	0903924956
createType	true	string	Create method	ignore
dateOfBirth	false	string time	Date of birth	1995-02-01
last_order_at	false	unix timestamp	Last order at	1715878800

createType	Create method
ignore	Skip customer if phone number existed
update	Update customer if phone number existed
force	Create new customer if phone number existed

Update customer

PUT /shops/<SHOP_ID>/customers/<CUSTOMER_ID>?api_key=<api_key> HTTP/1.1

Request

{
  "customer": {
    "name": "Nguyễn Thị Hằng",
    "gender": "female",
    "emails": ["pancake@gmail.com", "hoang@gmail.com"],
    "phone_numbers": ["0983925966"],
    "date_of_birth": "1995-03-04",
    "reward_point": 20,
    "is_discount_by_level": false,
    "tags": ["Hay hoàn"],
    "is_block": false,
    "assigned_user_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "level_id": "f8dced06-965d-4070-a765-dd8268373f1e",
    "notes": [
      {
        "id": "8a6f5380-4674-44e9-aaf2-40d898d460f5",
        "message": "Khách hàng thân thiết",
        "images": [
          {
            "url": "https://content.pancake.vn/user-content-dev2.pancake.vn/2023/9/6/655ae9172118ba9ffde16fa129a7001a392d1fff.png"
          }
        ]
      }
    ],
    "shop_customer_addresses": [
      {
        "id": "df631f21-3841-4d1c-8204-b85a7ecfce0c",
        "country_code": 84,
        "province_id": "101",
        "district_id": "10113",
        "commune_id": "1011309",
        "address": "190 Cầu Giấy",
        "full_name": "sơn",
        "phone_number": "0972868874",
      }
    ],
    "order_count": 7,
    "purchased_amount": 1000000
  }
}

Query Parameters

Parameter	Required	Type	Description	Example
name	false	string	Full name of customer	Nguyễn Thị Hằng
gender	false	string	Giới tính	female
emails	false	array	Email	["pancake@gmail.com", "hoang@gmail.com"]
phone_numbers	false	array	Phone number	["0983925966"]
date_of_birth	false	string	Date of birth	1995-03-04
reward_point	false	int	Reward points	20
is_discount_by_level	false	boolean	Discount based on level	false
tags	false	array	Customer tags	["Hay hoàn"]
is_block	false	boolean	Block customer	false
assigned_user_id	false	uid	Assigned employee Id
level_id	false	uid	Customer level Id
notes (1.1)	false	array	Customer note
shop_customer_address (1.2)	false	array	Customer address
order_count	false	int	Number of order	7
purchased_amount	false	int	Amount purchased	1000000

Note (1.1)

Parameter	Required	Type	Description	Example
id	false	uid	Note id
message	false	string	Content note
images	false	array	Image note	[{url: "https://content.pancake.vn/user-content.pancake.vn/2022/1/19/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"}]

Shop_customer_address (1.2)

Parameter	Required	Type	Description
id	false	uid	Address Id
country_code	false	int	Country code
province_id	false	string	Province ID
district_id	false	string	District ID
commune_id	false	string	Commune ID
address	false	string	Address
full_name	false	string	Recipient name
phone_number	false	string	Phone number

Customer reward point history

GET /shops/<SHOP_ID>/customers/point_logs?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "amount": 10.0,
      "creator": {
        "avatar_url": null,
        "fb_id": "377936050731194",
        "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
        "name": "Vũ Sơn"
      },
      "current_point": 20.0,
      "inserted_at": "2024-09-27T03:40:31",
      "note": "Tăng điểm khi chỉnh sửa điểm thưởng khách hàng"
    },
    ...
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 2,
  "total_pages": 1
}

Query Parameters

Parameter	Required	Type	Default	Description
page_size	false	int	30
page_number	false	int	1
shop_customer_id	true	uid		Customer ID

Response Parameters

Parameter	Type	Description
amount	int	Number of points changed
creator	json	Creator information
current_point	int	Current point
inserted_at	iso 8601	Creation time
note	string	Reason for changing reward point

Create promotion by customer

POST /shops/<SHOP_ID>/promotion_advance/create_multi?api_key=<api_key> HTTP/1.1

Request

{
  "promotion_advance": {
    "promotion": {
      "start_time": "2024-09-30T04:58:30.020Z",
      "end_time": "2024-10-30T04:58:30.020Z",
      "warehouse_ids": [],
      "customer_tags": [],
      "type": "discount_by_coupon_id",
      "is_activated": true,
      "promo_code_info": {
        "discount": 5,
        "is_percent": true,
        "max_discount_by_percent": 100000,
        "disable": false,
        "order_price_min": 2000000,
        "order_price_max": 3000000,
        "no_applied_products_in_other_promotions": true,
        "discount_after_other_discount": true
      }
    },
    "shop_customer_ids": ["a8c1113d-55c2-4f7e-b33a-d4ecd76668fd"]
  }
}

Request Parameters

Parameter	Required	Type	Description
start_time	false	iso 8601	Start time
end_time	false	iso 8601	End time
warehouse_ids	false	array	Warehouse id applied
customer_tags	false	array	Customer tags
type	true	string	Promotion type
is_activated	true	boolean	Activate
promo_code_info	true	json	Promotion information
promo_code_info.discount	true	int	Discount value
promo_code_info.is_percent	true	boolean	true: by %, false: by value
max_discount_by_percent	false	int	Maximum discount amount by %
order_price_min	false	int	Minimum order value
order_price_max	false	int	Maximum order value
no_applied_products_in_other_promotions	false	boolean	Not applicable to products already included in other promotions
discount_after_other_discount	false	boolean	Discount based on order value after deducting other discounts
shop_customer_ids	true	array	Customer id applied

Customer conversation note

List of notes

GET /shops/<SHOP_ID>/customers?/<CUSTOMER_ID>/load_customer_notes?api_key=<api_key> HTTP/1.1

Response

{
  "customer_notes": [
    {
      "notes": [
        {
          "created_at": 1678075407193,
          "created_by": {
              "fb_id": "377936050731194",
              "fb_name": "Vũ Sơn",
              "uid": "cee3c05e-5f85-43c4-b27e-889b99c50097"
          },
          "edit_history": [],
          "id": "a472f7db-b9db-410a-a43a-5f972c685b6c",
          "images": [],
          "message": "khách hàng mua lại",
          "order_id": "97798",
          "updated_at": null
        }
      ]
    }
  ]
}

Response Parameters

Parameter	Type	Description
created_at	unix timestamp	Creation time
created_by	json	Creator information
edit_history	array	Edit history
id	uid	Note id
images	array	Link note image
message	string	Content note
order_id	string	Order ID
updated_at	unix timestamp	Update time

Add note

POST /shops/<SHOP_ID>/customers/<CUSTOMER_ID>/create_note?api_key=<api_key> HTTP/1.1

Request

{
  "conversation_id": "117967746266487_9306266852780716",
  "page_id": "117967746266487",
  "message": "khách hàng mua nhiều lần",
  "images": [
    {
      "image_data": {
        "height": 225,
        "width": 225
      },
      "name": "iship thai.jpeg",
      "preview_url": "https://content.pancake.vn/user-content-dev2.pancake.vn/2025/2/25/2488ecb12514520d9828390f695abc9db69a1452.jpg",
      "url": "https://content.pancake.vn/user-content-dev2.pancake.vn/2025/2/25/2488ecb12514520d9828390f695abc9db69a1452.jpg"
    }
  ],
  "order_id": 116947
}

Query Parameters

Parameter	Required	Type	Description
conversation_id	false	string	Conversation ID
page_id	false	string	Page ID
message	false	string	Note content
images	false	array	Note image information
order_id	false	int	Order ID

Customer level

Customer level list

GET /shops/<SHOP_ID>/customer_levels?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "color_customer_level": "#87d068",
      "discount": 5,
      "discount_type": 3,
      "id": "84fdef8b-8e4b-44e7-8d61-8553ee7f5833",
      "name": "cap 1",
      "shop_id": 20,
      "upgrade_by_order_count": 10,
      "upgrade_by_point": 100,
      "upgrade_by_total_purchase": 30000000
    }
  ],
  "success": true
}

Query Parameters

Parameter	Required	Type	Description	Example
search	false	string	Customer level name	level 1

Response Parameters

Parameter	Type	Description
color_customer_level	string	Color code of the level
discount	int	Discount value
discount_type	int	Discount type 2: By value, 3: By percentage (%)
id	uid	Level ID
name	string	Level name
upgrade_by_order_count	int	Upgrade by order count
upgrade_by_point	int	Upgrade by points
upgrade_by_total_purchase	int	Upgrade by total purchase

Transaction

List of transactions

GET /shops/<SHOP_ID>/transactions?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "advertising_cost_id": null,
      "amount": -70000,
      "creator": {
        "avatar_url": null,
        "fb_id": "1286585024855632",
        "id": "d6e6a545-f102-439e-9943-8ac8369f9735",
        "name": "vudzung12"
      },
      "creator_id": "d6e6a545-f102-439e-9943-8ac8369f9735",
      "display_id": "KH6815",
      "id": "5b6bbae4-56b4-4189-a84d-d2ecfecead3e",
      "images": [
        "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"
      ],
      "inserted_at": "2023-09-23T05:00:20",
      "is_accounting": false,
      "is_canceled": false,
      "is_locked": false,
      "name": "Giao dịch công nợ #1692 trả nhà cung cấp",
      "note": "trả nhà cung cấp",
      "payment_debts_to_suppliers": false,
      "payments": [
        "cash"
      ],
      "shop_id": 20,
      "status": 1,
      "supplier_products_id": 293,
      "table_name": "debts",
      "tag_ids": [
        "193a-e877-359a-b340-01d8-4d2e-2050",
        "55f6-111c-2fd5-38e8-5b9d-009f-d3b1"
      ],
      "time_incurred": "2023-09-23T05:00:20",
    },
    ....
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 117,
  "total_pages": 4
}

Query Parameters

Parameter	Required	Type	Default	Description	Example
page	false	int	1
page_size	false	int	30
status	false	int	-1	Status
startDateTime	false	unix timestamp	null	Start time	1692810000
endDateTime	false	unix timestamp	null	End time	1695488399

Status	Status name
-1	All status
0	New
1	Effective
2	Canceled
3	Deleted

Response Parameters

Parameter	Type	Description
advertising_cost_id	uid	Advertising cost ID
amount	int	Amount of money
creator	json	Creator information
creator_id	uid	Creator id
display_id	string	Transaction ID
images	array	Image link
inserted_at	unix timestamp	Creation time
is_accounting	boolean	Financial accounting
is_locked	boolean	Locked
name	string	Transaction name
note	string	Note
payment_debts_to_suppliers	boolean	Paying off debts to suppliers
payments	array	Payment method
status	int	Status
supplier_products_id	int	Supplier products id
tag_ids	array	Transaction tag
time_incurred	unix timestamp	Time incurred

Create transaction

POST /shops/<SHOP_ID>/transactions?api_key=<api_key> HTTP/1.1

Request

{
  "transaction": {
    "name": "Thanh toán tiền hàng",
    "note": "thanh toán tiền hàng",
    "amount": -1000000,
    "is_locked": false,
    "tag_ids": [
      "193a-e877-359a-b340-01d8-4d2e-2050"
    ],
    "payments": [
      "transfer_money"
    ],
    "supplier_products_id": 293,
    "is_accounting": true,
    "time_incurred": "2023-09-23T08:41:54.404Z",
    "payment_debts_to_suppliers": true,
    "images": [
      "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"
    ]
  }
}

Query Parameters

Parameter	Required	Type	Description	Example
name	true	string	Transaction name
note	false	string	Note
amount	false	int	Amount of money
is_locked	false	boolean	Locked
tag_ids	false	array	Transaction tag	["193a-e877-359a-b340-01d8-4d2e-2050"]
payments	false	array	Payment method	["transfer_money"]
supplier_products_id	false	int	Supplier products id
is_accounting	false	boolean	Financial accounting
time_incurred	false	unix timestamp	Time incurred
images	false	array	Image link	["https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"]

payments	Payment method
cash	Cash
transfer_money	Transfer money
charged_by_card	Charged by card
charged_by_momo	Momo
charged_by_vnpay	VNPay
charged_by_kredivo	Kredivo
charged_by_fundiin	Fundiin
charged_by_qrpay	QRpay

Create advertising cost

POST /shops/<SHOP_ID>/adv_costs?api_key=<api_key> HTTP/1.1

Request

{
  "params": {
    "cost_date": "2023-09-07 22:00:00",
    "transaction": {
      "name": "Chi phí quảng cáo",
      "is_locked": false,
      "note": "example",
      "status": "0",
      "time_incurred": "2023-09-07 15:00:00",
      "tags": ["Thẻ 1", "Thẻ 2"]
    },
    "items": [
      {
        "cost": 10000,
        "tax": 5,
        "warehouse_id": "IS",
        "is_livestream": true,
        "product": "1",
        "pke_mkter": "test@gmail.com",
        "source": {
          "key": "-3",
          "account": "3"
        },
        "is_wholesale": true,
        "post_ids": ["127967746288487_545680607828820"]
      }
    ]
  }
}

Request Parameters

Parameter	Required	Type	Description
cost_date	true	string	Date advertising costs
transaction	true	json	Transaction
name	true	string	Name of advertising cost
is_locked	false	boolean	Locked
note	false	string	Note
status	true	string	Status
time_incurred	false	string	Time incurred
tags	false	array	Advertising cost tags
items	true	array	Detailed list of advertising costs
items[].cost	true	int	Cost
items[].tax	false	int	Tax percentage
items[].warehouse_id	false	string	Warehouse ID
items[].is_livestream	false	boolean	Livestream
items[].product	false	string	Product ID
items[].pke_mkter	false	string	Marketer
items[].source	false	json	Source
items[].is_wholesale	false	boolean	Wholesale
items[].post_ids	false	array	Post code list

Transaction history

GET /shops/<SHOP_ID>/payment_accounts/get_payment_histories?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "amount": 176000,
      "date": "2025-04-18T06:00:47",
      "id": 1747,
      "order": {
        "custom_id": 90265,
        "display_id": 3705,
        "email": null,
        "id": 119138,
        "name": "Nguyen Van Dung",
        "phone": "0989893212",
        "warehouse_id": "48cbe669-6897-493d-8002-5f9125f87f13"
      },
      "partner_code": "mecado",
      "payment_content": "MS04T01735066283674,DANG LE CONG TUAN,MBVCB.10169928012.5193BFTVG22PWR6Y.VO XUAN BAO NGOC chuyen tien.CT tu 0761002354938 VO XUAN BAO NGOC toi MS04T01735066283674 DANG LE CONG TUAN tai TECHCOMBANK",
      "result_code": "0",
      "trans_id": "S22O3705T1744970427",
      "type": "techcombank"
    },
    ...
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 36,
  "total_pages": 2
}

Query Parameters

Parameter	Required	Type	Default	Description	Example
page	false	int	1
page_size	false	int	30
startDate	false	unix timestamp	null	Start time	1692810000
endDate	false	unix timestamp	null	End time	1695488399

Response Parameters

Parameter	Type	Description
amount	int	Amount of money
date	timestamp	Transaction time
id	int	Transaction history id
order	json	Order information
partner_code	string	Account number / Card number
payment_content	string	Transaction description
result_code	string	Transaction result code
trans_id	string	Transaction ID
type	string	Transaction type

Statistic report

Order statistics

GET /shops/<SHOP_ID>/analytics/sale?api_key=<api_key> HTTP/1.1

cURL

curl --location 'https://pos.pages.fm/api/v1/shops/<SHOP_ID>/analytics/sale?api_key=<api_key>&since=2025-06-27T17%3A00%3A00.000Z&until=2025-07-28T16%3A59%3A59.999Z&split_by=Time.day&filter[Variation.product_id][]=4a6fc152-5989-4202-83d4-a11a2ab28078&success_status=1&success_record=inserted_at&user_type=create&returned_record=inserted_at&select_fields[]=cod&select_fields[]=partner_fee&select_fields[]=total_order_count&select_fields[]=order_count&select_fields[]=shipping_fee&select_fields[]=price&select_fields[]=surcharge&select_fields[]=fee_marketplace'

Response

  {
    "data": [
        {
            "Time.day": "2020-07-22",
            "returned": null,
            "success": {
                "cod": 1710000,
                "discount": 0,
                "order_count": 3,
                "price": 1800000,
                "product_count": 18,
                "shipping_fee": 0,
                "custom_formula_d6ae-ad02-be3d-b26e-3f65-d497-33c4": 1000000
            }
        },
        {
            "Time.day": "2020-07-27",
            "returned": null,
            "success": {
                "cod": 570000,
                "discount": 0,
                "order_count": 1,
                "price": 600000,
                "avg_price": 600000,
                "product_count": 6,
                "shipping_fee": 0,
                "custom_formula_d6ae-ad02-be3d-b26e-3f65-d497-33c4": 1000000
            }
        },
        {
            "Time.day": "2020-07-28",
            "returned": null,
            "success": {
                "cod": 5130000,
                "discount": 0,
                "order_count": 9,
                "price": 5400000,
                "avg_price": 600000,
                "product_count": 54,
                "shipping_fee": 0,
                "custom_formula_d6ae-ad02-be3d-b26e-3f65-d497-33c4": 1200000
            }
        },
        {
            "Time.day": "2020-07-30",
            "returned": null,
            "success": {
                "cod": 570000,
                "discount": 0,
                "order_count": 1,
                "price": 600000,
                "avg_price": 600000,
                "product_count": 6,
                "shipping_fee": 0,
                "custom_formula_d6ae-ad02-be3d-b26e-3f65-d497-33c4": 1200000
            }
        },
    ],
    "success": true
  }

Query Parameters

Parameter	Required	Type	Example	Description
since	false	string	'2020-08-01 00:00:00'	Time to start statistics
until	false	string	'2020-08-20 00:00:00'	Time to end statistics
split_by	false	array	["Time.day", "Order.source", "Variation.id", "Variation.product_id"]	Time.day: By date, Order.source: By order source, Variation.id: By the variation, Variation.product_id: By the product
filter	false	json	{"Variation.id":["08d25e0c-4016-498e-a0c6-48b8e7aad2b4"]}	Variation.id: By the variation, Variation.product_id: By the product
success_status	false	string	'1'	'send_to_partner': Close a sale after pushing to the shipping partner '1': Close a sale after updating status to confirmed
success_record	false	string	'inserted_at'	'inserted_at': Revenue added by the time of order creation 'updated_at': Revenue added by the time of status update
user_type	false	string	'create'	Who completed order ('create': Creator, 'update': Updating staff, 'assign': Assigned staff, 'care': Caring staff, 'marketer': Marketer)
returned_status	false	string	'5'	'5': Order is completed when returned '4': Order is completed when returning
returned_record	false	string	'inserted_at'	Revenue will be deducted at the time ('inserted_at': Create, 'updated_at': Status update, 'success_record': Closing sale)
select_fields	false	array	(*) ["price", "avg_price", "custom_formula_{custom_formula_id}"]	Select fields

• (*)
• "price", "avg_price": Analytic field
• "custom_formula_{custom_formula_id}": Analytic field custom (In there custom_formula_id: ID of custom formula)
• Example: "custom_formula_d6ae-ad02-be3d-b26e-3f65-d497-33c4" ID of custom formula is "d6ae-ad02-be3d-b26e-3f65-d497-33c4"

Response Parameters

Parameter	Type	Description
Time.day	string	Statistic day
returned	json	Data of returned order
success	json	Data of success order
cod	int	Cash on delivery
discount	int	Discount
order_count	int	Number of order
price	int	Goods price
product_count	int	Products in orders
shipping_fee	int	Shipping fee

List of customized formulas

GET /shops/<SHOP_ID>/analytics/get_list_formula?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "formula": "{price} - {shipping_fee}",
      "id": "0ea7-bc72-ae51-0769-a7c9-ca34-fff6",
      "name": "tien hang - phi ship",
      "unit": "currency"
    },
    {
      "formula": "{revenue} + {transfer_money}",
      "id": "3db3-72a7-c426-066a-4eed-a63b-be49",
      "name": "doanh thu + ck$",
      "unit": "currency"
    }
  ],
  "success": true
}

Response Parameters

Parameter	Type	Description
formula	string	Formula
id	string	Formula id
name	string	Formula name
unit	string	Unit

List of analytic fields

GET /shops/<SHOP_ID>/analytics/get_analytic_fields?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "id": "price",
      "name": "Price"
    },
    {
      "id": "avg_price",
      "name": "Average price"
    },
    ...
  ],
  "success": true
}

Response Parameters

Parameter	Type	Description
id	string	Analytic field id
name	string	Analytic field name

Purchase

List of purchases

GET /shops/<SHOP_ID>/purchases?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "auto_create_debts": true,
      "total_remain_quantity": 1,
      "status": 0,
      "display_id": 6392,
      "total_quantity": 1,
      "bill_images": [],
      "not_create_transaction": true,
      "inserted_at": "2023-09-20T02:21:51",
      "transport_fee": 10000,
      "id": "96bbc665-3fd5-4efc-9d8a-0110ecfa1754",
      "items": [
        {
          "id": "02cb1ff3-9b21-4e1c-9288-a29c16bd907d",
          "imported_price": 200000,
          "gross_price": 200000,
          "discount": 10000,
          "note_purchase": "áo nam thời trang",
          "product_name": "Áo nam",
          "quantity": 1,
          "selling_status": "bad",
          "variation_id": "20e7d183-c70c-445e-8ce2-4d7e3a378e34",
          "variation": {
            "barcode": "mauma1",
            "display_id": "mauma1",
            "id": "69416fa6-4c3d-451f-897d-9faa0420c060",
            "product": {
              "display_id": "Áo nam",
              "name": "Áo nam"
            },
            "product_id": "f210413c-dc84-45e5-b722-9dc72ff7c9af",
            "remain_quantity": 9,
            "retail_price": 10000,
            "retail_price_after_discount": 10000,
            "variations_warehouses": [
              {
                "actual_remain_quantity": 0,
                "pending_quantity": 0,
                "remain_quantity": 0,
                "returning_quantity": 0,
                "total_quantity": 0,
                "waiting_quantity": 0,
                "warehouse_id": "ced33e05-0a8a-4e9e-ae7f-5419e737a3ef"
              }
            ],
            "weight": 0
          }
        }
      ],
      "is_lock": null,
      "images": [
        "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"
      ],
      "user_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "prepaid_debt": 100000,
      "total_price": 200000,
      "received_at": "2023-09-21T00:00:00",
      "updated_at": "2023-09-20T02:22:05",
      "total_remain_price": 200000,
      "tags": [1],
      "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
      "supplier_products_id": 293,
      "supplier": {
        "custom_id": "HH",
        "id": 724,
        "name": "CT TNHH Hồng Hà"
      },
      "discount": 10000,
      "created_type": "actual_purchase",
      "user": {
        "avatar_url": null,
        "fb_id": "377936050731194",
        "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
        "name": "Vũ Sơn"
      },
      "separate_by_display_ids": null,
      "note": "nhập kho sản phẩm"
    }
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 1,
  "total_pages": 1
}

Query Parameters

Parameter	Required	Type	Default	Description
page	true	int	1
page_size	true	int	30
status	true	int	-2	Status
type	true	string	product

Status	Status name
-2	All status
-1	New
0	Confirmed
1	Imported goods
2	Canceled

Response Parameters

Parameter	Type	Description
auto_create_debts	boolean	Auto create debts
total_remain_quantity	int	Total remaining quantity
status	int	Status
display_id	int	Purchase id
total_quantity	int	Total quantity
bill_images	array	Invoice image link
not_create_transaction	boolean	Not create transaction
inserted_at	unix timestamp	Creation time
transport_fee	int	Shipping fee
items	array	Variation information
is_lock	boolean	Locked
images	array	Link note image
user_id	uid	Creator id
prepaid_debt	int	Prepaid debt
total_price	int	Total purchase price
received_at	unix timestamp	Date of receipt of goods
updated_at	unix timestamp	Updated at
total_remain_price	int	Total remaining price
tags	array	Tag id
warehouse_id	uid	Warehouse code list
supplier_products_id	int	Supplier products id
supplier	json	Supplier information
discount	int	Discount
created_type	string	Purchase type
user	json	Creator information
separate_by_display_ids	int	Separated purchase id
note	string	Note

items

Parameter	Type	Description
imported_price	int	Imported price
note_purchase	int	Note
product_name	string	Product name
quantity	int	Import quantity
selling_status	string	Sales status
variation_id	uid	Variation ID
gross_price	int	Gross price (excluding discounts, excluding shipping fees)
discount	int	Discount on product

created_type	Description
actual_purchase	Actual purchase
adjust_warehouse	Adjust warehouse
transfer_warehouse	Transfer warehouse

Create purchase

POST /shops/<SHOP_ID>/purchases?api_key=<api_key> HTTP/1.1

Request

{
  "purchase": {
    "note": "",
    "status": 1,
    "not_create_transaction": false,
    "auto_create_debts": true,
    "supplier_products_id": 169,
    "shop_id": 20,
    "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
    "change_received_at": true,
    "received_at": 1651683600,
    "images": ["https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"],
    "items": [
      {
        "imported_price": 100000,
        "gross_price": 100000,
        "discount": 10000,
        "quantity": 1,
        "variation_id": "29044dcf-2f4c-492f-a0a9-e447b20e21da",
        "index": 0,
      }
    ]
  }
}

Request Parameters

Parameter	Type	Description
note	string	Note
status	int	Purchase status
not_create_transaction	boolean	Not create transaction
auto_create_debts	boolean	Auto create debts
supplier_products_id	int	Supplier products id
shop_id	int	Shop ID
warehouse_id	string	Warehouse ID
change_received_at	boolean	Change received at
received_at	unix timestamp	Date of receipt of goods
images	array	Link purchase image
items	array	List product
items.imported_price	int	Purchase price (no need to send as the system will calculate automatically)
items.gross_price	int	Gross price (excluding discounts, excluding shipping fees)
items.discount	int	Discount on product
items.quantity	int	Import quantity
items.variation_id	string	Variation ID

Update purchase

PUT /shops/<SHOP_ID>/purchases/<PURCHASE_ID>?api_key=<api_key> HTTP/1.1

Request

{
  "purchase": {
    "note": "",
    "status": 1,
    "not_create_transaction": false,
    "auto_create_debts": true,
    "supplier_products_id": 169,
    "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
    "change_received_at": true,
    "received_at": 1651683600,
    "images": ["https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"],
    "items": [
      {
        "imported_price": 100000,
        "quantity": 1,
        "variation_id": "29044dcf-2f4c-492f-a0a9-e447b20e21da",
      }
    ]
  }
}

Request Parameters

Parameter	Required	Type	Description
note	false	string	Note
status	false	int	Purchase status
not_create_transaction	false	boolean	Not create transaction
auto_create_debts	false	boolean	Auto create debts
supplier_products_id	false	int	Supplier products id
warehouse_id	true	string	Warehouse ID
change_received_at	false	boolean	Change received at
received_at	false	unix timestamp	Date of receipt of goods
images	false	array	Link purchase image
items	false	array	List product
items.imported_price	true	int	Import price
items.quantity	false	int	Import quantity
items.variation_id	false	string	Variation ID

Status	Status name
-1	New
0	Confirmed
1	Imported goods
2	Canceled

Separate purchase

POST /shops/<SHOP_ID>/purchases/separate?api_key=<api_key> HTTP/1.1

Request

{
    "newPurchase": {
        "auto_create_debts": true,
        "discount": 500,
        "images": ["https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"],
        "items": [
            {
                "imported_price": 100000,
                "quantity": 1,
                "variation_id": "ddefd476-bc91-4151-8cd2-2cf5ad227f09",
                "index": 0
            }
        ],
        "not_create_transaction": false,
        "note": "Tách phiếu nhập",
        "prepaid_debt": 20000,
        "received_at": 1683997200,
        "status": 0,
        "supplier_products_id": 293,
        "tags": [1],
        "transport_fee": 0,
        "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"
    },
    "oldPurchase": {
        "auto_create_debts": true,
        "discount": 500,
        "id": "0ecbdb3b-a376-4a3d-9b8a-174ae15ae886",
        "images": ["https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"],
        "items": [
            {
                "imported_price": 100000,
                "quantity": 23,
                "variation_id": "ddefd476-bc91-4151-8cd2-2cf5ad227f09",
                "index": 0
            }
        ],
        "not_create_transaction": false,
        "note": "Nhập hàng để bán",
        "prepaid_debt": 20000,
        "received_at": 1683997200,
        "status": 0,
        "supplier_products_id": 293,
        "tags": [1],
        "transport_fee": 0,
        "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"
    }
}

Request Parameters

Note: newPurchase and oldPurchase use the same request parameters

Parameter	Required	Type	Description
newPurchase	true	json	New purchase
oldPurchase	true	json	Purchase need separate
auto_create_debts	false	boolean	Auto create debts
discount	false	int	Discount
id	true	string	Purchase id / only for oldPurchase
images	false	array	Link purchase image
items	true	array	List product
items.imported_price	true	int	Import price
items.quantity	true	int	Import quantity
items.variation_id	true	string	Variation ID
items.index	false	int	Product sort order
not_create_transaction	false	boolean	Not create transaction
note	false	string	Note
prepaid_debt	false	int	Prepaid debt
received_at	false	unix timestamp	Date of receipt of goods
status	true	int	Purchase status
supplier_products_id	false	int	Supplier products id
tags	false	array	Tag purchase
transport_fee	false	int	Shipping fee
warehouse_id	true	string	Warehouse ID

Export

List of exports

GET /shops/<SHOP_ID>/export?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "display_id": 472,
      "export_items": [
        {
          "display_id": 0,
          "id": "78dfe47a-a3dd-4d47-8f8b-16eb1ccd69ee",
          "imported_price": 0,
          "inserted_at": "2024-01-25T16:18:20",
          "quantity": 1,
          "variation_id": "76887a5b-8a27-472c-a15a-661ea59434dd"
        }
      ],
      "id": "8095ca3c-a485-4378-9914-5013e1179d55",
      "images": [
        "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"
      ],
      "inserted_at": "2024-01-25T16:18:20",
      "note": "Xuất bán hàng",
      "status": 0,
      "supplier_products_id": 400037328,
      "tags": [1],
      "total": 1,
      "total_price": 0,
      "type": 0,
      "updated_at": "2024-01-25T16:18:20",
      "user": {
        "avatar_url": null,
        "fb_id": "1286585024855632",
        "id": "d6e6a545-f102-439e-9943-8ac8369f9735",
        "name": "vudzung12"
      },
      "user_id": "d6e6a545-f102-439e-9943-8ac8369f9735",
      "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"
    }
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 1,
  "total_pages": 1
}

Query Parameters

Parameter	Required	Type	Default	Description
page	true	int	1
page_size	true	int	30
status	true	int	-1	Status
type	true	int	0

Status	Status name
-1	All status
0	New
1	Completed
2	Canceled

Response Parameters

Parameter	Type	Description
display_id	int	Export id
export_items	array	List product
images	array	Link export image
inserted_at	unix timestamp	Creation time
note	string	Note
status	int	Status
supplier_products_id	int	Supplier products id
tags	array	Tag id
total	int	Total quantity
total_price	int	Total export price
updated_at	unix timestamp	Updated at
user	json	Creator information
warehouse_id	uid	Warehouse code list

export_items

Parameter	Type	Description
id	uid	Export Item dd
imported_price	int	Export price
quantity	int	Export quantity
variation_id	string	Variation ID

Create export

POST /shops/<SHOP_ID>/export?api_key=<api_key> HTTP/1.1

Request

{
  "export_list": {
    "note": "",
    "supplier_products_id": 169,
    "tags": [
      1
    ],
    "status": 0,
    "type": 0,
    "shop_id": 20,
    "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
    "change_inserted_at": true,
    "inserted_at": 1651683600,
    "images": ["https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"],
    "export_items": [
      {
        "id": "13d7ddf6-4cd9-4e1f-a5c1-ac3cd7a7fc17",
        "imported_price": 100000,
        "quantity": 1,
        "variation_id": "29044dcf-2f4c-492f-a0a9-e447b20e21da",
      }
    ]
  }
}

Request Parameters

Parameter	Type	Description
note	string	Note
supplier_products_id	int	Supplier products id
tags	array	Export Tag
status	int	Export status
type	int	Type of export
shop_id	int	Shop ID
warehouse_id	string	Warehouse ID
images	array	Link export image
change_inserted_at	boolean	Change date of create export
inserted_at	unix timestamp	Date of create export
export_items	array	List product
export_items.id	uid	Export Item dd
export_items.imported_price	int	Export price
export_items.quantity	int	Export quantity
export_items.variation_id	string	Variation ID

Update export

PUT /shops/<SHOP_ID>/export/<EXPORT_ID>?api_key=<api_key> HTTP/1.1

Request

{
  "export_list": {
    "images": [
      "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/5/27/ee3be79d1574735ed35539ca48f7f6e9d7137706.jpg"
    ],
    "inserted_at": 1695142800,
    "note": "xuất bán hàng",
    "status": 0,
    "supplier_products_id": 319,
    "tags": [
      1
    ],
    "export_items": [
      {
        "id": "13d7ddf6-4cd9-4e1f-a5c1-ac3cd7a7fc17",
        "imported_price": 1000,
        "quantity": 1,
        "variation_id": "d1e522eb-2f6f-4d22-b8a1-ec25df4a33a4"
      }
    ]
  }
}

Query Parameters

Parameter	Required	Type	Description
images	false	array	Link export image
inserted_at	false	unix timestamp	Date of create export
note	false	string	Note
status (1.1)	false	int	Export status
supplier_products_id	false	int	Supplier products id
tags	false	array	Export Tag
export_items	false	array	List product
export_items.id	true	uid	Export Item dd
export_items.imported_price	true	int	Export price
export_items.quantity	true	int	Export quantity
export_items.variation_id	true	string	Variation ID

(1.1) status	Status
0	New
1	Completed
2	Canceled

Product defective (by export)

Create export product defect

POST /shops/<SHOP_ID>/export?api_key=<api_key> HTTP/1.1

Request

{
"export_list": {
    "note": "Xuất hàng lỗi",
    "supplier_products_id": 169,
    "status": 0,
    "type": 1,
    "shop_id": 20,
    "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
    "change_inserted_at": true,
    "inserted_at": 1651683600,
    "images": ["https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"],
    "export_items": [
      {
        "imported_price": 100000,
        "quantity": 1,
        "variation_id": "29044dcf-2f4c-492f-a0a9-e447b20e21da",
      }
    ]
  }
}

Request Parameters

Parameter	Type	Description
note	string	Note
supplier_products_id	int	Supplier products id
status	int	Export status
type	int	Type of export
shop_id	int	Shop ID
warehouse_id	string	Warehouse ID
images	array	Link export image
change_inserted_at	boolean	Change date of create export
inserted_at	unix timestamp	Date of create export
export_items	array	List product
export_items.imported_price	int	Export price
export_items.quantity	int	Export quantity
export_items.variation_id	string	Variation ID

Update export product defect

PUT /shops/<SHOP_ID>/export/<EXPORT_ID>?api_key=<api_key> HTTP/1.1

Request

{
  "export_list": {
    "images": [
      "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/5/27/ee3be79d1574735ed35539ca48f7f6e9d7137706.jpg"
    ],
    "inserted_at": 1695142800,
    "note": "xuất bỏ đi",
    "status": 0,
    "supplier_products_id": 319,
    "type": 1,
    "export_items": [
      {
        "id": "13d7ddf6-4cd9-4e1f-a5c1-ac3cd7a7fc17",
        "imported_price": 1000,
        "quantity": 1,
        "variation_id": "d1e522eb-2f6f-4d22-b8a1-ec25df4a33a4"
      }
    ]
  }
}

Query Parameters

Parameter	Required	Type	Description
images	false	array	Link export image
inserted_at	false	unix timestamp	Date of create export
note	false	string	Note
status (1.1)	false	int	Export status
supplier_products_id	false	int	Supplier products id
export_items	false	array	List product
export_items.id	true	uid	Export Item dd
export_items.imported_price	true	int	Export price
export_items.quantity	true	int	Export quantity
export_items.variation_id	true	string	Variation ID

(1.1) status	Status
0	Defect export
1	Elimination export
2	Canceled

Warehouse transfer

List of warehouse transfers

GET /shops/<SHOP_ID>/transfers?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "creator_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "display_id": 309,
      "from_warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
      "from_warehouse_name": "Kho HCM",
      "id": "5c9ef4a6-2411-4d5f-9a91-1bc22dbb7eb1",
      "images": [
        "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"
      ],
      "inserted_at": "2023-09-13T09:34:37",
      "items": [
        {
          "id": "f80bdc16-a000-4bf1-a979-c3fd4033f551",
          "product_display_id": "áo nam",
          "product_name": "áo nam",
          "quantity": 3,
          "variation_display_id": "XANH-M",
          "variation_fields": [
            {
              "id": "beb75502-5a50-48d6-bed8-89ea8ddc9a66",
              "keyValue": "xanh dương",
              "name": "màu",
              "value": "xanh dương"
            },
            {
              "id": "8eee6f85-0a76-46da-9dd7-6668bc6d8729",
              "keyValue": "M",
              "name": "size",
              "value": "M"
            }
          ]
          "variation_id": "3b11fb7b-9081-42c0-9546-dfac62b9c9ca"
        }
      ],
      "note": "Chuyển kho bán hàng",
      "shipping_fee": 30000,
      "shop_id": 20,
      "status": 0,
      "to_warehouse_id": "229102e4-39c3-4523-bd57-4ed0a45a85ba",
      "to_warehouse_name": "Cho tao cơm",
      "total_quantity": 1,
      "updated_status_at": "2023-09-13T09:34:37"
    }
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 1,
  "total_pages": 1
}

Query Parameters

Parameter	Required	Type	Default	Description
page_size	true	int	30
page	true	int	1
status	true	int	1	Status

Response Parameters

Parameter	Type	Description
creator_id	uid	Creator id
display_id	int	Warehouse transfer id
from_warehouse_id	uid	From warehouse id
from_warehouse_name	string	From warehouse name
images	array	Warehouse transfer image link
inserted_at	time	Creation time
items	array	List product
note	string	Note
shipping_fee	int	Shipping fee
shop_id	int	Shop ID
status	int	Status
to_warehouse_id	uid	To warehouse id
to_warehouse_name	string	To warehouse name
total_quantity	int	Total quantity
updated_status_at	time	Updated at

items

Parameter	Type	Description
product_display_id	string	Product ID
product_name	string	Product name
quantity	int	Transfer quantity
variation_display_id	string	Variation ID
variation_fields	array	Variation attribute information

Create warehouse transfer

POST /shops/<SHOP_ID>/transfers/multi?api_key=<api_key> HTTP/1.1

Request

{
  "transfer": {
    "from_warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
    "to_warehouse_ids": ["229102e4-39c3-4523-bd57-4ed0a45a85ba"],
    "shipping_fee": 20000,
    "items": [
      {
        "quantity": 1,
        "variation_id": "20e7d183-c70c-445e-8ce2-4d7e3a378e34"
      }
    ],
    "note": "đây là ghi chú",
    "images": [
      "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/5/27/ee3be79d1574735ed35539ca48f7f6e9d7137706.jpg"
    ],
    "inserted_at": "2025-03-11T09:24:42"
  }
}

Request Parameters

Parameter	Required	Type	Description
from_warehouse_id	true	uid	From warehouse id
to_warehouse_ids	true	array	To warehouse id
shipping_fee	false	int	Shipping fee
note	false	string	Note
images	false	array	Warehouse transfer image link
inserted_at	false	iso 8601	Creation time
items	true	array	List of products
item.quantity	true	int	Quantily
item.variation_id	true	uid	Variation ID

Update warehouse transfer

PUT /shops/<SHOP_ID>/transfers/<TRANSFER_ID>?api_key=<api_key> HTTP/1.1

Request

{
  "transfer": {
    "status": 1,
    "from_warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
    "shipping_fee": 10000,
    "items": [
      {
        "variation_id": "51bb0bb7-77e9-407e-9f57-5072a0236cb4",
        "quantity": 1
      }
    ],
    "note": "Chuyển kho bán hàng",
    "images": [
      "https://content.pancake.vn/user-content-dev2.pancake.vn/2024/8/30/7886ccd76d3629808d21fa3e59849c8e79a28162.png"
    ],
    "inserted_at": "2025-03-11T09:24:42",
    "change_inserted_at": true
  }
}

Request Parameters

Parameter	Required	Type	Description
status	true	int	Status
from_warehouse_id	true	uid	From warehouse id
shipping_fee	false	int	Shipping fee
note	false	string	Note
images	false	array	Warehouse transfer image link
inserted_at	false	iso 8601	Creation time
change_inserted_at	false / (true nếu có params inserted_at)	boolean	Change creation time
items	false	array	List of products
items.variation_id	true	string	Variation ID
items.quantity	true	int	Transfer quantity

Status	Status name
0	Waiting for pick up
1	Shipping
2	Completed
2	Canceled

Stocktaking

Stocktaking list

GET /shops/<SHOP_ID>/stocktakings?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "creator_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "display_id": null,
      "id": "4d0f479d-feab-489b-bc82-4a656902a20b",
      "inserted_at": "2023-10-11T08:25:18",
      "note": "Kiểm hàng tồn",
      "progress": 0,
      "shop_id": 20,
      "status": 0,
      "stocktaking_at": "2023-10-11T08:24:56",
      "stocktaking_by": "category_ids",
      "stocktaking_by_value": [
        "1315"
      ],
      "updated_at": "2023-10-11T09:03:03",
      "updated_status_at": "2023-10-11T08:25:18",
      "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"
    }
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 258,
  "total_pages": 9
}

Query Parameters

Parameter	Required	Type	Default	Description
page	true	int	1
page_size	true	int	30
status	true	int	-2	Status

Status	Status name
-2	All status
-1	Creating
0	Stocktaking
1	Stocktook
2	Canceled

Get stocktaking information

GET /shops/<SHOP_ID>/stocktakings/<STOCKTAKING_ID>?api_key=<api_key> HTTP/1.1

Request

{
  "data": {
    "creator_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "display_id": null,
    "id": "4d0f479d-feab-489b-bc82-4a656902a20b",
    "inserted_at": "2023-10-11T08:25:18",
    "items": [
      {
        "changed_quantity": 12,
        "current_quantity": 0,
        "id": "cb244b25-100e-4eaa-8b8f-0e72c5642631",
        "inserted_at": "2024-12-02T10:42:39",
        "note": null,
        "shop_id": 20,
        "updated_at": "2024-12-02T10:42:39",
        "variation_id": "27b3f94b-c945-4560-b694-a59526cae9a5",
        "variation": {
          "barcode": "12ml-6291107458328",
          "display_id": "1",
          "fields": [],
          "id": "27b3f94b-c945-4560-b694-a59526cae9a5",
          "images": [
            "https://statics.pancake.vn/user-content.pancake.vn/2023/4/12/05138842c6f772cde332fd8e1be1bff58245f19e.png"
          ],
          "last_imported_price": 20000,
          "product": {
            "display_id": "12ml-6291107458328",
            "image": null,
            "name": "12ml Badee Al Oud",
            "note_product": ""
          },
          "product_id": "61894c4f-d759-45b7-acf7-ff5e88082016",
          "retail_price": 240000,
          "weight": 1000,
        }
      }
    ],
    "note": "Kiểm hàng tồn",
    "progress": 0,
    "shop_id": 20,
    "status": 0,
    "stocktaking_at": "2023-10-11T08:24:56",
    "stocktaking_by": "category_ids",
    "stocktaking_by_value": [
      "1315"
    ],
    "updated_at": "2023-10-11T09:03:03",
    "updated_status_at": "2023-10-11T08:25:18",
    "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"
  }
  "success": true
}

Response Parameters

Parameter	Type	Description
creator_id	uid	Creator id
display_id	int	Stocktaking id
inserted_at	unix timestamp	Creation time
items (1)	array	List product
note	string	Note
progress	int	Processing percentage
shop_id	int	Shop ID
status	int	Status
stocktaking_at	unix timestamp	Stocktaking at
stocktaking_by (2)	string	Stocktaking by
stocktaking_by_value	array	Category Id / Supplier products id / Brand id
updated_at	unix timestamp	Updated at
updated_status_at	unix timestamp	Updated status at
warehouse_id	uid	Warehouse ID

items (1)

Parameter	Type	Description
changed_quantity	int	Changed quantity
current_quantity	int	Current quantity
note	string	Note
inserted_at	unix timestamp	Creation time
updated_at	unix timestamp	Updated at
variation_id	string	Variation ID
variation	json	Variation information

(2) stocktaking_by

value	Description
category_ids	Category
supplier_product_ids	Supplier
brand_id	Brands

Create stocktaking

POST /shops/<SHOP_ID>/stocktakings?api_key=<api_key> HTTP/1.1

Request

{
  "stocktaking": {
    "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
    "items": [
      {
        "variation_id": "20e7d183-c70c-445e-8ce2-4d7e3a378e34",
        "changed_quantity": -1
      }
    ],
    "note": "Kiểm hàng tồn",
    "status": 0,
    "inserted_at": "2025-04-04T10:42:40.100Z",
    "stocktaking_at": "2023-10-11T10:38:34.542Z",
    "stocktaking_by": "category_ids",
    "stocktaking_by_value": [
      "1315"
    ]
  }
}

Request Parameters

Parameter	Required	Type	Description
warehouse_id	true	uid	Warehouse ID
items	true	array	List product
items.variation_id	true	string	Variation ID
items.changed_quantity	true	int	Changed quantity
note	false	string	Note
status	true	int	Export status
inserted_at	false	unix timestamp	Creation time
stocktaking_at	false	unix timestamp	Stocktaking at
stocktaking_by (1.0)	false	string	Stocktaking by
stocktaking_by_value	false	array	Category Id / Supplier products id / Brand id

Update stocktaking

PUT /shops/<SHOP_ID>/stocktakings/<STOCKTAKING_ID>?api_key=<api_key> HTTP/1.1

Request

{
  "stocktaking": {
    "creator_id": "890f9367-45cd-43e9-b2cc-ffccda390405",
    "id": "39d023e9-fae5-4eed-a882-2be9d33914b4",
    "items": [
      {
        "changed_quantity": -1,
        "id": "f852fd0b-d299-4ca9-8961-59afead3345b",
        "variation_id": "20e7d183-c70c-445e-8ce2-4d7e3a378e34"
      }
    ],
    "note": "Kiểm hàng tồn",
    "status": 0,
    "stocktaking_at": "2023-10-11T10:38:34",
    "stocktaking_by": "category_ids",
    "stocktaking_by_value": [
      "1315"
    ],
    "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"
  }
}

Query Parameters

Parameter	Required	Type	Description
creator_id	false	uid	Creator id
id	true	uid	Stocktaking id
items	true	array	List product
items.changed_quantity	true	int	Changed quantity
items.id	true (Update) / false (Create)	uid	Stocktaking item id
items.variation_id	true	string	Variation ID
note	false	string	Note
status	true	int	Export status
stocktaking_at	false	unix timestamp	Stocktaking at
stocktaking_by (1.0)	false	string	Stocktaking by
stocktaking_by_value	false	array	Category Id / Supplier products id / Brand id
warehouse_id	true	uid	Warehouse ID

Inventory histories

GET /shops/<SHOP_ID>/inventory_histories?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "avg_price": 100000,
      "current_inventory": [
        {
          "actual_remain_quantity": 1170,
          "avg_price": 242295.345104334,
          "id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
          "name": "Kho mặc định",
          "remain_quantity": 968,
          "total_quantity": 1246
        }
      ],
      "editor_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "id": 186206,
      "inserted_at": "2024-06-10T10:03:53.015323",
      "quantity": -1,
      "ref_display_id": "433",
      "remain_quantity": 3387,
      "table_name": "warehouse_transfers",
      "type": "Tạo phiếu chuyển kho #433",
      "variation_now": {
        "barcode": null,
        "display_id": "Nam Pari TX",
        "fields": [
          {
            "id": "56e0ac18-3bd0-47ac-91ba-0f4056326c1d",
            "keyValue": "WHITE",
            "name": "Color",
            "value": "WHITE"
          }
        ],
        "id": "76887a5b-8a27-472c-a15a-661ea59434dd",
        "images": [
          "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/9/29/d05f44dcf2b9f96312d88b718da35aa5317242d6.jpg"
        ],
        "is_hidden": false,
        "is_locked": false,
        "is_sell_negative_variation": true,
        "last_imported_price": 100000,
        "product_id": "73ec61e2-52e3-41dd-bd24-b7ec1035184d",
        "retail_price": 200000,
        "weight": 700,
      },
      "warehouse": {
        "custom_id": null,
        "ffm_id": null,
        "full_address": "22, Jalan Kiara 6 jalan utamah pekan nanas johor 81500, Pekan Nenas, Johor, 81500",
        "id": "c0b42d67-7b53-48b7-9119-29c5b6e18d19",
        "name": "kho Malay",
        "phone_number": "0984565082"
      }
    }
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 1,
  "total_pages": 1
}

Query Parameters

Parameter	Required	Type	Example	Description
page	true	int	1
page_size	true	int	30
warehouse_id	false	iud	c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da	Warehouse ID
variation_ids	false	array	["76887a5b-8a27-472c-a15a-661ea59434dd"]	Variation ID
startDate	false	unix timestamp	1716310800	Start date
endDate	false	unix timestamp	1718989199	End date

Response Parameters

Parameter	Type	Description
avg_price	int	Average import price
current_inventory	array	Current inventory information
editor_id	uid	Updated employee id
id	int	Inventory history id
inserted_at	unix timestamp	Creation time
quantity	int	Change quantity
remain_quantity	int	In stock
variation_now	json	Variation information
warehouse	json	Warehouse change inventory

Voucher

Voucher list

GET /shops/<SHOP_ID>/vouchers?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "creator_id": "d6e6a545-f102-439e-9943-8ac8369f9735",
      "customer_tags": [
        "Tiềm năng",
        "Hay hoàn"
      ],
      "display_id": 8,
      "end_time": "2021-12-12T08:22:31",
      "id": "33640b56-4230-49b6-aa68-2fdb6b5ae77d",
      "inserted_at": "2021-12-06T08:22:43",
      "is_activated": false,
      "is_free_shipping": true,
      "is_used": null,
      "name": "bJZQBEXc",
      "promo_code_info": {
        "discount": 1234560,
        "is_percent": false,
        "max_discount_by_percent": 0
      },
      "shop_id": 3,
      "start_time": "2021-12-10T08:22:28",
      "type": "discount_by_coupon_id",
      "updated_at": "2021-12-06T08:22:43"
    },
    {
      "creator_id": "d6e6a545-f102-439e-9943-8ac8369f9735",
      "customer_tags": [
        "Tiềm năng"
      ],
      "display_id": 7,
      "end_time": "2021-12-10T04:27:26",
      "id": "9589b791-013f-4a5b-b8d1-164fad73d84e",
      "inserted_at": "2021-12-06T04:27:40",
      "is_activated": true,
      "is_free_shipping": false,
      "is_used": null,
      "name": "d5IvGYtj",
      "promo_code_info": {
        "discount": 4534,
        "is_percent": false,
        "max_discount_by_percent": 0
      },
      "shop_id": 3,
      "start_time": "2021-12-09T04:27:23",
      "type": "discount_by_coupon_id",
      "updated_at": "2021-12-10T02:26:59"
    },
    {
      "creator_id": "d6e6a545-f102-439e-9943-8ac8369f9735",
      "customer_tags": [
        "Hay hoàn"
      ],
      "display_id": 6,
      "end_time": "2021-12-05T08:14:04",
      "id": "0da90bea-b879-4679-a959-b7f8370073b6",
      "inserted_at": "2021-12-04T08:14:11",
      "is_activated": true,
      "is_free_shipping": false,
      "is_used": null,
      "name": "k3L7AUrV",
      "promo_code_info": {
        "discount": 2000,
        "is_percent": true,
        "max_discount_by_percent": 0
      },
      "shop_id": 3,
      "start_time": "2021-12-04T08:14:02",
      "type": "discount_by_coupon_id",
      "updated_at": "2021-12-10T02:27:24"
    }
  ],
  "success": true
}

Response Parameters

Parameter	Type	Description
name	string	Voucher code
start_time	unix timestamp	The start date applied
end_time	unix timestamp	The end date applied
promo_code_info	json	Discount information
is_free_shipping	boolean	Free shipping
is_activated	boolean	Activated
is_used	boolean	Used
creator_id	int	Creator id
inserted_at	unix timestamp	The time of creating
updated_at	unix timestamp	The time of updating
display_id	int	Voucher display id
id	int	Voucher id
shop_id	int	Shop ID
type	string	Voucher type
customer_tags	Array	Customer tags

promo_code_info

Parameter	Type	Description
discount	int	Discount amount
is_percent	boolean	Discount according to percent
max_discount_by_percent	int	Maximum percentage

Voucher information

GET /shops/<SHOP_ID>/vouchers/<VOUCHER_ID>?api_key=<api_key> HTTP/1.1

Response

{
  "creator_id": "d6e6a545-f102-439e-9943-8ac8369f9735",
  "customer_tags": [
    "Tiềm năng",
    "Hay hoàn"
  ],
  "display_id": 7,
  "end_time": "2021-12-10T04:27:26",
  "id": "9589b791-013f-4a5b-b8d1-164fad73d84e",
  "inserted_at": "2021-12-06T04:27:40",
  "is_activated": true,
  "is_free_shipping": false,
  "is_used": null,
  "name": "d5IvGYtj",
  "promo_code_info": {
    "discount": 4534,
    "is_percent": false,
    "max_discount_by_percent": 0
  },
  "shop_id": 3,
  "start_time": "2021-12-09T04:27:23",
  "type": "discount_by_coupon_id",
  "updated_at": "2021-12-06T04:27:40"
}

Create voucher

POST /shops/<SHOP_ID>/vouchers?api_key=<api_key> HTTP/1.1

Request

{
  "name": "test_voucher_5",
  "promo_code_info": {
    "discount": 53635,
    "is_percent": false
  },
  "is_free_shipping": false,
  "is_activated": true,
  "customer_tags": ["New tag"],
  "start_time": "2021-12-09T04:27:23",
  "end_time": "2021-12-10T04:27:26"
}

Request Parameters

Parameter	Type	Description
name	string	Voucher code
start_time	unix timestamp	The start date applied
end_time	unix timestamp	The end date applied
promo_code_info	json	Discount information
is_free_shipping	boolean	Free shipping
is_activated	boolean	Activated
customer_tags	Array	Customer tags

Create multipe voucher

POST /shops/<SHOP_ID>/vouchers?api_key=<api_key> HTTP/1.1

Request

{
  "create_multi_voucher": 15,
  "promo_code_info": {
    "discount": 53635,
    "is_percent": false
  },
  "is_free_shipping": false,
  "is_activated": true,
  "customer_tags": ["New tag"],
  "start_time": "2021-12-09T04:27:23",
  "end_time": "2021-12-10T04:27:26"
}

Request Parameters

Parameter	Type	Description
create_multi_voucher	int	Number of voucher
start_time	unix timestamp	The start date applied
end_time	unix timestamp	The end date applied
promo_code_info	json	Discount information
is_free_shipping	boolean	Free shipping
is_activated	boolean	Activated
customer_tags	Array	Customer tags

Promotion

Promotion list

GET /shops/<SHOP_ID>/promotion_advance?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "arr_level_promotion": [],
      "bonus_items": [],
      "coupon_info": {
        "discount": 0,
        "is_percent": false
      },
      "creator_id": "4eab0efc-2994-4b96-acf0-e4c847668555",
      "customer_tags": [],
      "discount_by_quantity": 1,
      "display_id": 50,
      "end_time": "2022-03-11T05:04:13",
      "group_name": "Nhóm 1",
      "id": "260a0d45-ba88-457b-8b31-afa3fda0ce0e",
      "inserted_at": "2022-03-10T05:04:33",
      "is_activated": true,
      "is_discount_in_birthday_customer": false,
      "is_free_shipping": false,
      "is_used": null,
      "is_variation": true,
      "level_order_prices": [],
      "name": "km 345",
      "order_sources": [],
      "post_ids": [],
      "priority_level": null,
      "promo_code_info": {
        "discount": 0,
        "is_percent": false,
        "max_discount_by_percent": 0
      },
      "shop_id": 3,
      "start_time": "2022-03-10T05:04:11",
      "total_quantity_bonus": 0,
      "type": "discount_by_product",
      "type_employee": "all",
      "updated_at": "2022-04-08T08:14:58",
      "warehouse_ids": []
    },
    {
      "arr_level_promotion": [],
      "bonus_items": [],
      "coupon_info": null,
      "creator_id": "20e88bf5-b755-4cc1-9f2e-740fa5a0a9d8",
      "customer_tags": [
        "New tag"
      ],
      "discount_by_quantity": 0,
      "display_id": 46,
      "end_time": null,
      "group_name": "Nhóm 1",
      "id": "9338e84b-5796-468c-856c-450d5ae73e35",
      "inserted_at": "2021-12-18T10:17:12",
      "is_activated": true,
      "is_discount_in_birthday_customer": null,
      "is_free_shipping": false,
      "is_used": null,
      "is_variation": true,
      "level_order_prices": null,
      "name": "km 454",
      "order_sources": [],
      "post_ids": [],
      "priority_level": null,
      "promo_code_info": {
        "discount": 53635,
        "is_percent": false
      },
      "shop_id": 3,
      "start_time": null,
      "total_quantity_bonus": 0,
      "type": "discount_by_coupon_id",
      "type_employee": null,
      "updated_at": "2021-12-18T10:17:12",
      "warehouse_ids": []
    }
  ],
  "page_number": 1,
  "page_size": 2,
  "success": true,
  "total_entries": 23,
  "total_pages": 12
}

Query Parameters

Parameter	Required	Type	Default	Description
page	false	int	1	Page
page_size	false	int	10	Number of record displayed in 1 page
textSearch	false	string	null	Keyword search

Reponse Parameters

Parameter	Type	Description
arr_level_promotion	array	Promotion level
bonus_items	array	Additional products
coupon_info	json	Coupon information
creator_id	string	Creator
customer_tags	array	Customer tags
discount_by_quantity	int	Number of discounts
display_id	string	Promotion code display code
end_time	string	End time
group_name	string	Promotion group
id	string	Promotion code
inserted_at	string	Time creation
is_activated	boolean	Activated
is_discount_in_birthday_customer	boolean	Promotion for birthdays
is_free_shipping	boolean	Free shipping
is_used	boolean	Used
is_variation	boolean	Promotion by variation
level_order_prices	json	Prices level
name	string	Promotion name
order_sources	array	Order sources
post_ids	array	Post code list
priority_level	int	Priority level
promo_code_info	json	Promotion code information
discount	int	Discount
is_percent	boolean	Discount according to percent
max_discount_by_percent	int	Maximum percentage
shop_id	int	Shop ID
start_time	string	Start time
total_quantity_bonus	int	Total number of promotion
type	string	Promotion type
type_employee	string	Staff type
updated_at	string	Update time
warehouse_ids	array	Warehouse code list

Create promotion

POST /shops/<SHOP_ID>/promotion_advance?api_key=<api_key> HTTP/1.1

Request

{
  "promotion_advance": {
    "name": "Khuyến mại 2/9",
    "start_time": 1752858000,
    "end_time": 1753549199,
    "warehouse_ids": [
      "-1"
    ],
    "customer_tags": ["thẻ 1", "thẻ 2"],
    "order_sources": [
      {
        "key": "-3",
        "account": "326",
        "page_id": null
      }
    ],
    "type_employee": "all",
    "type": "discount_by_product",
    "level_order_prices": [],
    "group_name": "Nhóm 1",
    "is_activated": true,
    "is_variation": true,
    "coupon_info": { // Dùng cho KM chung
      "discount": 0,
      "is_percent": false
    },
    "promo_code_info": {
      "discount": 0,
      "is_percent": false,
      "max_discount_by_percent": 0,
      "start_hour": "04:04",
      "end_hour": "06:07"
    },
    "items": [
      {
        "variation_id": "6b6dd69c-b6b1-420f-b433-22ca428c554e",
        "product_id": null,
        "category_id": null,
        "category": {},
        "level_info": [ // Dùng cho KM theo sản phẩm
          {
            "from_quantity": 0,
            "to_quantity": 1,
            "discount": 0,
            "is_percent": false
          }
        ],
        "fixed_prices": 0, // Dùng cho KM đồng giá
        "coupon_item_info": {
          // Giá trị giảm giá
          "discount": 10000,
          "is_percent": false

          // Phần trăm giảm giá
          "discount": 10,
          "is_percent": true,
          "max_discount_by_percent": 100000
        }
      }
    ],
    "is_free_shipping": false,
    "discount_by_quantity": 0,
    "bonus_items": [
      {
        "product_id": "774b9fc7-37cd-412d-a035-69947f837ec8",
        "quantity": 1,
        "variation_id": "215c6da3-bf40-4168-98ad-34d03b5e443e"
      }
    ],
    "is_discount_in_birthday_customer": false,
    "arr_level_promotion": [],
    "total_quantity_bonus": 0,
    "priority_level": 1
  }
}

Query Parameters

Parameter	Required	Type	Description	Example
name	true	string	Promotion name	Khuyến mại 2/9
start_time	false	array	Start time	1752858000
end_time	false	array	End time	1753549199
warehouse_ids	false	array	Warehouse code list	["ba7fabc2-03c8-4d22-8742-2b93c64891b7"]
customer_tags	false	array	Customer tags	["thẻ 1", "thẻ 2"]
order_sources	false	array	Order sources
type	true	string	Promotion type	discount_by_product
group_name	false	string	Promotion group	Nhóm 1
is_activated	false	boolean	Activated	true
is_variation	false	boolean	Promotion by variation	true
coupon_info	true	json	Coupon information
coupon_info.discount	true	int	Discount	10000
coupon_info.is_percent	false	boolean	Discount by percent	false
promo_code_info	false	json	Promotion information
promo_code_info.discount	false	int	Discount value	10000
promo_code_info.is_percent	false	boolean	Discount by percent	false
promo_code_info.max_discount_by_percent	false	int	Maximum discount amount in percent	100000
promo_code_info.start_hour	false	string	Start hour	04:04
promo_code_info.end_hour	false	string	End hour	06:07
items	true	array	Applied products
items.variation_id	false	string	Variation ID	6b6dd69c-b6b1-420f-b433-22ca428c554e
is_free_shipping	false	boolean	Free shipping	true
discount_by_quantity	false	int	Number of discounts	10
bonus_items	false	array	Additional products
is_discount_in_birthday_customer	false	boolean	Discount in birthday customer	true
total_quantity_bonus	false	int	Total number of promotion	10
priority_level	false	int	Priority level	1

Promotion type

type	Description
discount_by_product	Discount by product quantity
discount_by_order_price	Discount by order prices
fixed_prices	Fixed price
coupon	General discount
double_reward_point	Discount double reward point
discount_by_coupon_id	Discount by coupon ID
discount_by_attachment_products	Discount by attachment product

Promotion updates

PUT /shops/<SHOP_ID>/promotion_advance/<ID>?api_key=<api_key> HTTP/1.1

Request

{
  "promotion_advance": {
    "arr_level_promotion": [],
      "bonus_items": [],
      "coupon_info": {
        "discount": 0,
        "is_percent": false
      },
      "creator_id": "4eab0efc-2994-4b96-acf0-e4c847668555",
      "customer_tags": [],
      "discount_by_quantity": 1,
      "display_id": 50,
      "end_time": "2022-03-11T05:04:13",
      "id": "260a0d45-ba88-457b-8b31-afa3fda0ce0e",
      "inserted_at": "2022-03-10T05:04:33",
      "is_activated": true,
      "group_name": "Nhóm 1",
      "is_discount_in_birthday_customer": false,
      "is_free_shipping": false,
      "is_used": null,
      "is_variation": true,
      "level_order_prices": [],
      "name": "test cap nhat km555555",
      "order_sources": [],
      "post_ids": [],
      "priority_level": null,
      "promo_code_info": {
        "discount": 0,
        "is_percent": false,
        "max_discount_by_percent": 0
      },
      "items": [
        {
          "variation_id": "6b6dd69c-b6b1-420f-b433-22ca428c554e",
          "product_id": null,
          "category_id": null,
          "category": {},
          "level_info": [ // Dùng cho KM theo sản phẩm
            {
              "from_quantity": 0,
              "to_quantity": 1,
              "discount": 0,
              "is_percent": false
            }
          ],
          "fixed_prices": 0, // Dùng cho KM đồng giá
          "coupon_item_info": {
            // Giá trị giảm giá
            "discount": 10000,
            "is_percent": false

            // Phần trăm giảm giá
            "discount": 10,
            "is_percent": true,
            "max_discount_by_percent": 100000
          }
        }
      ],
      "shop_id": 3,
      "start_time": "2022-03-10T05:04:11",
      "total_quantity_bonus": 0,
      "type": "discount_by_product",
      "type_employee": "all",
      "updated_at": "2022-03-10T05:04:33",
      "warehouse_ids": []
  }
}

Activate, deactivate, delete promotions

POST /shops/<SHOP_ID>/promotion_advance/delete_multi?api_key=<api_key> HTTP/1.1

Request

{
  "ids": [
    "0fe988a1-26a5-4772-b4b6-a9c17c9f40cd"
  ],
  "type_action": "DEACTIVE_PROMOTIONS"
}

Request Parameters

Parameter	Required	Type	Description
ids	true	array	Promotion code
type_action	true	string	ACTIVE_PROMOTIONS: Activate / DEACTIVE_PROMOTIONS: Deactivate / DELETE_PROMOTIONS: Delete

Combo product

Combo list

GET /shops/<SHOP_ID>/combo_products?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {
      "currency": "VND",
      "custom_id": null,
      "discount_amount": 10000,
      "discount_by_percent": 0,
      "end_time": "2024-07-19T16:59:59",
      "id": 282,
      "inserted_at": "2024-06-19T10:42:33",
      "is_free_shipping": true,
      "is_use_percent": false,
      "is_value_combo": false,
      "is_variation": true,
      "max_discount_by_percent": 0,
      "name": "combo 1",
      "order_sources": [
        {
          "account": null,
          "key": "-2",
          "page_id": null
        }
      ],
      "order_types": [
        "all"
      ],
      "shop_id": 20,
      "snippet": null,
      "start_time": "2024-06-18T17:00:00",
      "updated_at": "2024-06-19T10:42:33",
      "value_combo": 0,
      "bonus_products": [
        {
          "discount_each_product": 0,
          "images": [
            "https://statics.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"
          ],
          "key": "fd46af68-9c2c-419b-adb6-309cd01a548c",
          "price_original": 200000,
          "product_id": "3116c7bc-d206-4c6c-a6e9-13b7999a543a",
          "quantity": 1,
          "variation_id": "fd46af68-9c2c-419b-adb6-309cd01a548c",
          "variation_info": {
            "product_attributes": [
              {
                "id": "3b3fe83f-cd98-4f1a-80c6-9141e8737cba",
                "name": "Size",
                "values": ["S"]
              }
            ],
            "manipulation_warehouses": [],
            "retail_price": 0,
            "is_sell_negative": null,
            "id": "XXL-yellow",
            "product_id": "áo phông nam",
            "categories": [
              {
                "id": 564,
                "name": "danh muc 1"
              }
            ],
            "shop_id": 20,
            "type": "product",
            "note": "xoas",
            "custom_id": "áo phông nam",
            "supplier_product_ids": [
              225
            ],
            "product_links": [
              "https://metruyenchu.com/truyen/chu-thien-van-gioi-nhan-vat-chinh-deu-la-ta-de/chuong-4"
            ],
            "inserted_at": "2022-06-04T07:30:05",
            "name": "áo phông nam",
            "keyword": null,
            "description": null,
            "brand_id": "a205de96-1d36-443e-9dd8-5f12f1b26909",
            "note_product": "asd",
            "tags": [
              {
                "id": 95,
                "note": "thẻ 3. 2"
              }
            ],
            "display_id": 11772
          }
        }
      ],
      "variations": [
        {
          "keyword": "xx",
          "weight": 200,
          "retail_price_currency_original": 200000,
          "images": [
            "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"
          ],
          "variations_warehouses": [
            {
              "actual_remain_quantity": 0,
              "available_quantity": 0,
              "avg_price": 100000,
              "defect_quantity": 0,
              "id": "313f126b-f690-423e-82b5-939e5a7a72c4",
              "pending_export_quantity": 0,
              "pending_quantity": 0,
              "pending_transfer_quantity": 0,
              "quantity_in_batch": 0,
              "remain_quantity": -1,
              "returning_quantity": 0,
              "shipping_quantity": 0,
              "shop_id": 20,
              "total_quantity": 0,
              "total_quantity_transfer": 0,
              "transfer_quantity": 0,
              "variation_id": "23f91ea1-5cb8-46a1-a8a6-e3819af9abad",
              "waitting_quantity": 0,
              "warehouse_id": "f8aef54c-7e19-412c-9109-cae52c45cad0"
            }
          ],
          "custom_id": "Nam Pari XX",
          "discount_percentage": "0%",
          "id": "23f91ea1-5cb8-46a1-a8a6-e3819af9abad",
          "product_id": "73ec61e2-52e3-41dd-bd24-b7ec1035184d",
          "remain_quantity": 2651,
          "limit_quantity_to_warn": 0,
          "price_at_counter": 0,
          "last_imported_price": 100000,
          "profit_rate": 50,
          "count": 1,
          "is_sell_negative_variation": null,
          "videos": null,
          "shop_id": 20,
          "original_price": null,
          "size": {
            "height": 3,
            "id": "30bc4d59-f934-4c6b-b6a5-5409289aee32",
            "length": 1,
            "width": 2
          },
          "offline_id": null,
          "wholesale_price": 0,
          "defect_quantity": 15,
          "composite_products": [],
          "fields": [
            {
              "id": "283d9e1d-c254-4bad-8d69-19be477f2512",
              "keyValue": "BLUE",
              "name": "Color",
              "value": "BLUE"
            }
          ],
          "product": {
            "name": "Áo thời trang Nam Pari đơn giản đẹp",
            "combo_product_variation_id": 491,
            "creator_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
            "custom_id": "ANPR",
            "type": "product",
            "inserted_at": "2023-01-27T07:55:09",
            "brand_id": null,
            "lifecycle_days": 0,
            "id": "73ec61e2-52e3-41dd-bd24-b7ec1035184d",
            "limit_quantity_to_warn": 3,
            "manipulation_warehouses": [],
            "count": 1,
            "shop_id": 20,
            "categories": [
              {
                "id": 590,
                "name": "Áo Phông"
              }
            ],
            "warning_by_variation": false,
            "product_links": [
              "www.product.com",
              "google.com.vn"
            ],
            "note_product": null,
            "display_id": 12392,
            "is_price_by_weight": false,
            "ignore_awarded_point": null,
            "updated_at": "2024-11-15T07:44:17",
            "category_ids": [
              590
            ],
            "image": null,
            "hide_product_name": null,
            "measure_group_id": null,
            "description": null
          },
          "retail_price_after_discount": 200000,
          "display_id": 2,
          "bonus_variations": [],
          "barcode": null,
          "cogs": 0,
          "is_removed": null,
          "is_composite": null,
          "updated_at": "2024-11-15T02:32:51.303603",
          "total_quantity": 3559,
          "retail_price": 200000
        }
      ]
    }
  ],
  "page_number": 1,
  "page_size": 30,
  "success": true,
  "total_entries": 3,
  "total_pages": 1
}

Query Parameters

Parameter	Required	Type	Default
page	false	int	1
page_size	false	int	30

Response Parameters

Parameter	Type	Description
currency	string	Currency unit
custom_id	string	Custom ID
discount_amount	int	Discount amount
discount_by_percent	int	Discount according to percent
end_time	unix timestamp	End time
id	string	Combo ID
inserted_at	unix timestamp	Creation time
is_free_shipping	boolean	Free shipping
is_use_percent	boolean	Apply percent discount
is_value_combo	boolean	Apply combo value
is_variation	boolean	Apply to variation
max_discount_by_percent	int	Maximum discount amount in percent
name	string	Combo name
order_sources	array	Order source apply
order_types	string	Order type apply
start_time	unix timestamp	Start time
updated_at	unix timestamp	Updated at
value_combo	int	Value of combo
bonus_products	array	Bonus product
variations	array	List of products in combo

Create combo

POST /shops/<SHOP_ID>/combo_products?api_key=<api_key> HTTP/1.1

Request

{
  "combo_product": {
    "name": "Combo 1",
    "currency": "VND",
    "start_time": 1745946000,
    "end_time": 1746637199,
    "order_sources": [
      {
        "key": "-3",
        "account": null,
      },
      {
        "key": "-1",
        "account": "406",
      }
    ],
    "order_types": ["all"],
    "livestream_manager_ids": [
      "c6825bf5-be22-4672-ac44-4a855df3ffb5"
    ],
    "is_value_combo": false,
    "value_combo": 0,
    "is_use_percent": false,
    "discount_amount": 100000,
    "discount_by_percent": 5,
    "max_discount_by_percent": 100000,
    "is_free_shipping": false,
    "bonus_products": [
      {
        "images": ["https://s3-uploads.rocketfy.co/adidas-nd-1500-vinotinto-calzado-432115311.jpg"],
        "product_id": "a0eaf647-4eb8-4665-83d2-1c0eb419edd9",
        "quantity": 1,
        "variation_id": "00ddfbf4-852a-4fe5-a623-b53cb04d0bf5",
        "variation_info": {
          "name": "ADIDAS ND 1500 - 35, BLANCO AZUL - Variation Id: 24577655507283",
          "id": 1,
          "display_id": 13109,
          "product_id": "a131092025"
        }
      }
    ],
    "is_variation": true,
    "is_categories": false,
    "categories": [{"id": "2954", "quantity": 1}],
    "variations": [
      {
        "count": 1,
        "product_id": "0cffd0a6-0a06-4471-a139-cf81aa1fcc6f"
        "variation_id": "821e1337-a04b-473a-b07c-805a572c465a"
      }
    ]
  }
}

Query Parameters

Parameter	Required	Type	Description	Example
name	true	string	Combo name	combo sản phẩm
currency	false	string	Currency unit	VND
start_time	false	unix timestamp	Start time	1745946000
end_time	false	unix timestamp	End time	1746637199
order_sources	false	array	Order sources	[{key: "-1", account: "406"}]
order_types	true	array	Applicable order types	["all" / "online" / "offline"]
livestream_manager_ids	false	array	Livestream ID	["c6825bf5-be22-4672-ac44-4a855df3ffb5"]
is_value_combo	true	boolean	Discount type (true: Combo value / false: Discount )	false
value_combo	true: when Discount type là Combo value / false: when Discount type là Discount	int	Giá trị combo	0
is_use_percent	true	boolean	Discount by percent	false
discount_amount	true: when is_use_percent = false / false: when is_use_percent = true	int	Discount value	100000
discount_by_percent	true: when is_use_percent = true / false: when is_use_percent = false	int	Percentage discount	5
max_discount_by_percent	true: when is_use_percent = true / false: when is_use_percent = false	int	Maximum discount value	100000
is_free_shipping	false	boolean	Free shipping	false
bonus_products	false	array	Bonus product information
is_variation	true	boolean	true: Apply to variation / false: Apply to product	false
variations	false	array	Applicable variation information	[{count: 1, product_id: "0cffd0a6-0a06-4471-a139-cf81aa1fcc6f"}]
variations.count	true	int	Quantily	1
variations.product_id	true	string	Product ID	"0cffd0a6-0a06-4471-a139-cf81aa1fcc6f"
variations.variation_id	true: when is_variation = true / false: when is_variation = false	string	Variation ID	"821e1337-a04b-473a-b07c-805a572c465a"
is_categories	false	boolean	true: Apply to category	false
categories	true: when is_categories = true / false: when is_categories = false	array	Applicable categories	[{id: "2954", quantity: 1}]

Fee partner caculator

POST /shops/<SHOP_ID>/orders/price_comparing?api_key=<api_key> HTTP/1.1

Request

  {
    "des_province": "805",
    "des_district": "80511",
    "des_commune": "8051125",
    "weight": "0",
    "warehouse_id": "7442b538-002b-42e3-8520-64425897e2f5",
    "shop_id": "",
    "quantity": "1",
    "price_product": "200000",
    "cod": "100000"
  }

Response

{
  "data": [
    {
      "partner_fee": 45000,
      "partner_id": 0,
      "partner_name": "Snappy"
    },
    {
      "partner_fee": 40000,
      "partner_id": 1,
      "partner_name": "GHTK"
    },
    {
      "partner_fee": 0,
      "partner_id": 3,
      "partner_name": "VTP"
    },
    {
      "partner_fee": 82500,
      "partner_id": 5,
      "partner_name": "GHN"
    },
    {
      "partner_fee": 0,
      "partner_id": 17,
      "partner_name": "VNPOST"
    },
    {
      "partner_fee": 0,
      "partner_id": 15,
      "partner_name": "JNT"
    },
    {
      "partner_fee": 36000,
      "partner_id": 16,
      "partner_name": "Best Express"
    }
  ],
  "success": true
}

Request Parameters

Parameter	Required	Type	Description
des_province	true	string	Code of provinces/cities to receive goods
des_district	true	string	Code of county/district receives goods
des_commune	true	string	Code of ward/commune receiving goods
weight	true	string	Weight
warehouse_id	true	string	Warehouse ID
shop_id	true	string	Shop ID
quantity	true	string	Quantily
price_product	true	string	Product price
cod	true	string	Cash on delivery
service_vtp	false	string	VTP service code
service_vnpost	false	string	VNPOST service code
service_best	false	string	BEST service code
service_ghn	false	string	GHN service code

VTP service code

Service code	Description
LCOD	LCOD - Road e-commerce
NCOD	NCOD - Flight e-commerce
VCN	VCN Express delivery
VTK	VTK Saving
V60	V60 Quick Service 60h
VVT	VVT Transportation services
VHT	VHT Very fast delivery
PTN	PTN Delivery in day within the province
PHT	PHT Delivery within the province
PHS	PHS Delivery delay a day within the province
VBE	VBE Savings under the box
VBS	VBS Express in the box
SCOD	SCOD Cashing delivery
ECOD	ECOD Cashing saving delivery
V20	V20
V25	V25
V30	V30
V35	V35
VCBA	VCBA Airline delivery
VCBO	VCBO Road delivery

VNPOST service code

Service code	Description
EMS	EMS - Express delivery
BK	BK - Common delivery
ECOD	ECOD - Savings delivery
BKCOD	BKCOD - E-commerce up to 5kg (VP2)
DONG_GIA	DONG_GIA - Private deal service between customers and VNPost
TMDT_EMS	E-commerce - Express delivery EMS
TMDT_BK	E-commerce - Standard delivery
TMDT_EMS_TK	E-commerce - Express saving delivery EMS (Interregional)

BEST service code

Service code	Description
12490	Express delivery (Express)
12491	Savings delivery (Eco)

GHN service code

Service code	Description
1	Fast
2	Standard
3	Save

Response Parameters

Parameter	Type	Description
partner_fee	int	Fee from shipping partner
partner_id	int	Partner ID
partner_name	string	Shipping partner name

Partner

GET /shops/<SHOP_ID>/partners?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
    {"id": 0, "name": "Snappy"},
    {"id": 1, "name": "Giao hàng tiết kiệm"},
    {"id": 2, "name": "EMS"},
    {"id": 4, "name": "247 Express"},
    {"id": 5, "name": "Giao hàng nhanh"},
    {"id": 7, "name": "VNP"},
    {"id": 8, "name": "SPL"},
    {"id": 9, "name": "DHL"},
    {"id": 10, "name": "J&T Philippines"},
    {"id": 11, "name": "Ahamove"},
    {"id": 12, "name": "LBC"},
    {"id": 13, "name": "Lazada Express"},
    {"id": 15, "name": "J&T"},
    {"id": 16, "name": "Best Inc"},
    {"id": 17, "name": "VN Post v2"},
    {"id": 19, "name": "Ninja Van"},
    {"id": 32, "name": "SuperShip"},
    {"id": 33, "name": "ZTO Express"},
    {"id": 36, "name": "NTX"},
    {"id": 37, "name": "Grab Express"},
    {"id": 38, "name": "Van Phuc"},
    {"id": 39, "name": "Hola Ship"},
    {"id": 40, "name": "LWE Express"},
    {"id": 41, "name": "Flash Express Phi"}
 ],
 "success": true
}

Response Parameters

Parameter	Type	Description
id	int	Partner ID
name	string	Partner name

WEBHOOK

Go website Setting -> Application
On frame WEBHOOK URL switch button, setting information:
- Webhook URL (Require)
- Email error message
- Request Headers
- Data type Orders(POS), Data table(CRM), Customers(POS, CRM), In stock(POS)

Cấu hình Webhook

PUT /shops/<SHOP_ID>?api_key=<api_key> HTTP/1.1

Response

  {
    "shop": {
      "webhook_enable": true,
      "webhook_url": "https://test.com",
      "webhook_email": "1234@gmail.com",
      "webhook_types": ["orders", "customers", "variations_warehouses"],
      "webhook_partner": "",
      "webhook_headers": {
          "X-API-KEY": "elqsF9ERiFWGacWQO9Gg5XC4kXojot"
      }
    }
  }

Response Parameters

Parameter	Type	Description
webhook_enable	boolean	Enable/Disable Webhook
webhook_url	string	Link URL
webhook_email	string	Error message email
webhook_types	array	Webhook data
webhook_partner	string	Partner

Order

Order Response

Response

  {
    "bill_full_name": "hoang anh ",
    "bill_phone_number": "0999999999",
    "page_id": "256469571178082",
    "creator": {
      "avatar_url": null,
      "fb_id": "2042723249341651",
      "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
      "name": "Hoang Anh"
    },
    "id": 1418,
    "inserted_at": "2020-05-12T04:51:42",
    "updated_at": "2020-05-12T04:51:54",
    "is_free_shipping": false,
    "is_livestream": true,
    "is_live_shopping": false,
    "is_smc": false,
    "post_id": "185187094667903_477083092110915",
    "received_at_shop": false,
    "partner_fee": 28000,
    "customer_pay_fee": false,
    "items": [
      {
        "discount_each_product": 0,
        "is_bonus_product": false,
        "is_discount_percent": false,
        "is_wholesale": false,
        "one_time_product": false,
        "quantity": 1,
        "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
        "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
        "variation_info": {
          "detail": null,
          "fields": null,
          "display_id": null,
          "name": "aaaaaa",
          "product_display_id": null,
          "retail_price": 100000,
          "weight": 100
        }
      }
    ],
    "note": "",
    "note_print": null,
    "returned_reason": 1,
    "partner": {
      "cod": 0,
      "custom_partner_id": null,
      "extend_code": "S58824.MB25.C3.500020713",
      "extend_update": [],
      "is_returned": null,
      "order_number_vtp": null,
      "paid_at": null,
      "partner_id": 1,
      "sort_code": null,
      "system_created": true,
      "total_fee": 0,
      "updated_at": "2020-05-12T05:18:16"
    },
    "payment_purchase_histories": [
      {
        "amount": 869000,
        "inserted_at": "2025-02-11T18:18:19.000000",
        "ipn_reply": true,
        "result_code": "0",
        "tags": [
          "static"
        ],
        "type": "techcombank",
        "voucher_amount": 0
      }
    ],
    "warehouse_id": "630744ef-4614-4a70-988c-52e6d78c953c",
    "shipping_address": {
      "address": "aaaaa",
      "commune_id": "2210941",
      "country_code": null,
      "district_id": "22109",
      "full_address": "aaaaa, Xã Bắc Lý, Huyện Hiệp Hòa, Bắc Giang",
      "full_name": "hoang anh ",
      "phone_number": "0999999999",
      "post_code": null,
      "province_id": "221"
    },
    "shipping_fee": 0,
    "shop_id": 4,
    "status": 0,
    "status_name": "new",
    "tags": [
      {
        "id": 2,
        "name": "Chờ cọc"
      },
      {
        "id": 3,
        "name": "Nhập hàng"
      },
      {
        "id": 13,
        "name": "Delay lấy hàng"
      }
    ],
    "total_discount": 0,
    "warehouse_info": {
      "district_id": "10111",
      "full_address": "kakakaka, Phường Khương Trung, Quận Thanh Xuân, Hà Nội",
      "name": "snappy",
      "phone_number": "0999999999",
      "province_id": "101"
    },
    "ads_source": "Facebook"
  }

CRM

CRM Response

Response

{
  "data": {
    "record": {
      "Address": "123",
      "CreatedBy": "6dcd3606-092a-467c-85d1-3149789cd470",
      "CreatedOn": "2019-06-21 10:50:21.411404",
      "Email": "qvasdaaasd@gmail.com",
      "LastContactAt": "2019-06-25T10:50:17.867Z",
      "LastContactUser": null,
      "ModifiedBy": "340644fc-314d-450e-a45f-33343678cab6",
      "ModifiedOn": "2020-11-03 16:02:50.217203",
    },
    "success": true
  }
}

Customer

Customer Response

Response

{
  "id": "00094712-d419-4f27-a8cc-e5ac9ed2dd75",
  "name": "Customer",
  "phone_numbers": ["0912312312"],
  "ad_clicks": [
    {
      "ad_id": "23851252560290199",
      "inserted_at": "2022-03-22T13:58:12",
      "post_id":"155703382366461_451824450048652"
    },
    {
      "ad_id": "23845321522860199",
      "inserted_at": "2022-03-25T03:32:12",
      "post_id": "109703394252261_451873526716231"
    }
  ],
  "birthday": null,
  "gender": "male",
  "customer_tags": ["tag 1", "tag 2"],
  "emails": ["hi@gmail.com"],
  "page_id": "4124125124323223",
  "reward_point": 100,
  "adjust_points": 20,
  "shop_id": 10,
  "type": "customers"
}

In stock

Response

{
  "data": {
    "record": {
      "actual_remain_quantity": 1,
      "remain_quantity": 1,
      "type": "variations_warehouses",
      "variation_id": "1996b3cd-fd72-4bd8-8889-a7f387821368",
      "warehouse_id": "77cbe2d5-6e65-4220-9c57-5d5d34f847e2",
      "change_quantity": -1,
      "is_actual_remain_quantity": false,
      "inserted_at": "2023-05-26 04:02:00.324609"
    },
    "success": true
  }
}

Response Parameters

Parameter	Type	Description
actual_remain_quantity	int	Actual remain quantity
remain_quantity	int	Number of remaining products
variation_id	uid	Variation ID
warehouse_id	uid	Warehouse ID
change_quantity	int	Change quantity
is_actual_remain_quantity	boolean	False: Is the act of changing the remaining quantity, True: Is the act of changing the actual amount remaining
inserted_at	string	Inserted at

CRM

List of tables

GET /shops/<SHOP_ID>/crm/tables?api_key=<api_key> HTTP/1.1

Response

{
  "success": true,
  "tables": [
    {
      "can_remove": false,
      "creator_id": null,
      "filters": [],
      "icon": null,
      "inserted_at": "2021-04-08T08:29:43",
      "is_removed": false,
      "label": "Contact",
      "modified_id": null,
      "name": "Contact",
      "permission_type": 1,
      "sections": [
        {
          "can_remove": false,
          "creator_id": null,
          "fields": [
            {
              "name": "Name",
              "label": "Name",
              "agg_field_id": null,
              "association_multi": true,
              "association_table": null,
              "association_type": null,
              "can_remove": false,
              "creator_id": null,
              "select_options": [],
              "summary_display_field_id": null,
              "summary_field_id": null,
              "summary_type": null,
              "type": 5,
              "order": 1,
              "quick_update": false,
              "is_require": true,
              "is_unique": false,
              "formulas": null
            },
            {
              "name": "Phone",
              "label": "Phone",
              "agg_field_id": null,
              "association_multi": true,
              "association_table": null,
              "association_type": null,
              "can_remove": false,
              "creator_id": null,
              "select_options": [],
              "summary_display_field_id": null,
              "summary_field_id": null,
              "summary_type": null,
              "type": 2,
              "order": 1,
              "quick_update": false,
              "is_require": true,
              "is_unique": false,
              "formulas": null
            }
          ]
        }
      ],
      "table_permissions": [
        {
          "id": "3f7ef102-7b45-4198-8783-7f7854b4a64a",
          "profile_id": "c25c1d3a-3dae-4877-af1e-5e71a41f6113",
          "role": 63,
          "table_id": "Contact"
        },
        {
          "id": "ea6c1d47-c230-43b8-a11e-fb61f4b611e4",
          "profile_id": "8e4d6a59-47e8-48bf-a51d-eb873ffd7eae",
          "role": 31,
          "table_id": "Contact"
        },
        {
          "id": "6963295c-fd7c-49c8-ab67-86641a800653",
          "profile_id": "58c99b60-2d8a-4edb-b7a2-a907bc874dbb",
          "role": 31,
          "table_id": "Contact"
        }
      ]
    }
 ]
}

Response Parameters

Parameter	Type	Description
label	string	Label of table
name	string	Name of table
permission_type	int	Who can see the table (1. Everyone, 2. Record owner and his manager)
sections.order	int	Order of section
sections.fields	array	Fields of section
sections.fields.order	int	Order fields in the section
sections.fields.type	int	Type of field
table_permissions	array	Permission of each group in the table

Data of table

GET /shops/<SHOP_ID>/crm/<TABLE_NAME>/records?api_key=<api_key> HTTP/1.1

Response

{
  "data": {
    "entries": [
      {
        "Address": "asdasd",
        "CreatedBy": "6dcd3606-092a-467c-85d1-3149789cd470",
        "CreatedOn": "2019-06-21 10:50:21.411404",
        "Email": "qwdasd@gmail.com",
        "LastContactAt": "2019-06-25T10:50:17.867Z",
        "LastContactUser": null,
        "ModifiedBy": "340644fc-314d-450e-a45f-33343678cab6",
        "ModifiedOn": "2020-11-03 16:02:50.217203",
      },
      {
        "Address": "123",
        "CreatedBy": "6dcd3606-092a-467c-85d1-3149789cd470",
        "CreatedOn": "2019-06-21 10:50:21.411404",
        "Email": "qvasdaaasd@gmail.com",
        "LastContactAt": "2019-06-25T10:50:17.867Z",
        "LastContactUser": null,
        "ModifiedBy": "340644fc-314d-450e-a45f-33343678cab6",
        "ModifiedOn": "2020-11-03 16:02:50.217203",
      }
    ]
  }
}

Query Parameters

Parameter	Required	Type	Default	Description
page_size	false	int	30
page	false	int	1

Create Record

POST /shops/<SHOP_ID>/crm/<TABLE_NAME>/records?api_key=<api_key> HTTP/1.1

Response

{
  "data": {
    "record": {
      "Address": "123",
      "CreatedBy": "6dcd3606-092a-467c-85d1-3149789cd470",
      "CreatedOn": "2019-06-21 10:50:21.411404",
      "Email": "qvasdaaasd@gmail.com",
      "LastContactAt": "2019-06-25T10:50:17.867Z",
      "LastContactUser": null,
      "ModifiedBy": "340644fc-314d-450e-a45f-33343678cab6",
      "ModifiedOn": "2020-11-03 16:02:50.217203",
    },
    "success": true
  }
}

Query Parameters

Parameter	Required	Type	Default	Description
record.field_name	field.is_required	string OR array	field.default_value	Type: array (field.type IN [10, 14, 15, 17] OR field.association_multi)

Update Record

PUT /shops/<SHOP_ID>/crm/<TABLE_NAME>/records?api_key=<api_key> HTTP/1.1

Response

{
  "data": {
    "record": {
      "Address": "123",
      "CreatedBy": "6dcd3606-092a-467c-85d1-3149789cd470",
      "CreatedOn": "2019-06-21 10:50:21.411404",
      "Email": "qvasdaaasd@gmail.com",
      "LastContactAt": "2019-06-25T10:50:17.867Z",
      "LastContactUser": null,
      "ModifiedBy": "340644fc-314d-450e-a45f-33343678cab6",
      "ModifiedOn": "2020-11-03 16:02:50.217203",
    },
    "success": true
  }
}

Query Parameters

Parameter	Required	Type	Default	Description
record.field_name	field.is_required	string OR array	field.default_value	Type: array (field.type IN [10, 14, 15, 17] OR field.association_multi)

Create Table

POST /shops/<SHOP_ID>/crm/tables?api_key=<api_key> HTTP/1.1

Response

{
  "data": {
    "table": {
      "name": "test",
      "label": "test",
      "auto_create_config": null,
      "can_remove": false,
      "creator_id": "6dcd3606-092a-467c-85d1-3149789cd470",
      "icon": null,
      "inserted_at": "2019-06-25T10:50:17.867Z",
      "updated_at": "2019-06-25T10:50:17.867Z",
      "show_fields": null,
      "sections": [
        {
          "can_remove": false,
          "creator_id": null,
          "fields": [
            {
              "name": "Name",
              "label": "Name",
              "agg_field_id": null,
              "association_multi": true,
              "association_table": null,
              "association_type": null,
              "can_remove": false,
              "creator_id": null,
              "select_options": [],
              "summary_display_field_id": null,
              "summary_field_id": null,
              "summary_type": null,
              "type": 5,
              "order": 1,
              "quick_update": false,
              "is_require": true,
              "is_unique": false,
              "formulas": null
            },
            {
              "name": "Phone",
              "label": "Phone",
              "agg_field_id": null,
              "association_multi": true,
              "association_table": null,
              "association_type": null,
              "can_remove": false,
              "creator_id": null,
              "select_options": [],
              "summary_display_field_id": null,
              "summary_field_id": null,
              "summary_type": null,
              "type": 2,
              "order": 1,
              "quick_update": false,
              "is_require": true,
              "is_unique": false,
              "formulas": null
            }
          ]
        }
      ]
    },
    "success": true
  }
}

Query Parameters

Parameter	Required	Unique	Type
table.name	true	true	string
table.label	true	false	string

List of Profiles

GET /shops/<SHOP_ID>/crm/profile?api_key=<api_key> HTTP/1.1

Response

{
  "data": [
      {
          "can_remove": false,
          "id": "994b620f-ebf6-4386-bea2-c37ed020aae4",
          "is_admin": true,
          "is_removed": false,
          "name": "CEO",
          "reports_to": null,
          "role": 0,
          "shop_id": 403
      },
      {
          "can_remove": true,
          "id": "7ffb87d1-63ed-405e-84f8-5587748889ea",
          "is_admin": false,
          "is_removed": false,
          "name": "Manager",
          "reports_to": "CEO",
          "role": 0,
          "shop_id": 403
      },
      {
          "can_remove": true,
          "id": "3a383661-6031-4ded-ad82-1a5e3e6cf760",
          "is_admin": false,
          "is_removed": false,
          "name": "User",
          "reports_to": "Manager",
          "role": 0,
          "shop_id": 403
      }
  ],
  "success": true
}

Response Parameters

Parameter	Type	Description
shop_id	int	Shop ID
name	string	Profile name
reports_to	string	Reports to
is_admin	string	Admin
can_remove	boolean	Can remove

Record History

GET /shops/<SHOP_ID>/crm/<TABLE_NAME>/history?api_key=<api_key>&record_id=<record_id> HTTP/1.1

Response

{
    "history": [
      {
        "changes": [
          {
            "field_label": "Tag Pancake",
            "new": "Mua hàng, Đã gửi",
            "old": "Mua hàng"
          }
        ],
        "editor_id": "4eab0efc-2994-4b96-acf0-e4c847668555",
        "id": "f673edbb-a008-46dd-a4df-bd4edbc8e41f",
        "record_id": "42958b34-e30c-4126-b00e-e3abf9803de2",
        "shop_id": 275,
        "updated_at": "2022-07-21T07:43:49"
      }
    ],
    "success": true
}

Response Parameters

Parameter	Type	Description
changes.field_label	string	Field label
changes.old	string	Old value
changes.new	string	New value
editor_name	string	Editor name