NAV Navbar
http

GIỚI THIÊU

Chào mừng bạn đến với API Pancake Pos! Bạn có thể sử dụng API của chúng tôi để truy cập các điểm cuối API của Pancake Pos, có thể nhận thông tin về các đơn hàng trong cơ sở dữ liệu của chúng tôi.

CẤU HÌNH CHUNG

MÔI TRƯỜNG

XÁC THỰC TÀI KHOẢN

api_key

TẠO API KEY

Vào giao diện Cấu hình -> Cấu hình ứng dụng
Trong khung API KEY, click Thêm mới

Create api

Cửa hàng

Thông tin cửa hàng

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",
      "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 Link hình đại điện
name string Tên cửa hàng
pages array Thông tin pages được gộp trong shop

Địa chỉ

Danh sách tỉnh thành phố

GET /geo/provinces HTTP/1.1

Response

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

HTTP Request

GET /geo/provinces

Query Parameters

Parameter Required Type Default Description
country_code true string 84 Mã quốc gia (ví dụ mã quốc gia Viet Nam là 84)

Danh sách quận huyện

GET /geo/districts HTTP/1.1

Response

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

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

Danh sách phường xã

GET /geo/communes HTTP/1.1

Response

{
    "data": [
        {
            "id": "1010115",
            "name": "Phường Cống Vị",
            "name_en": "cong vi"
        },
        {
            "id": "1010109",
            "name": "Phường Điện Biên",
            "name_en": "dien bien"
        },
        {
            "id": "1010113",
            "name": "Phường Đội Cấn",
            "name_en": "doi can"
        },
        {
            "id": "1010119",
            "name": "Phường Giảng Võ",
            "name_en": "giang vo"
        },
        {
            "id": "1010111",
            "name": "Phường Kim Mã",
            "name_en": "kim ma"
        },
        ...
    ]
}

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

Đơn hàng

Danh sách đơn hàng

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
      },
      "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,
      "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,
          "measure_group_id": 860000034,
          "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,
            "measure_info": {
              "exchange_value": 30,
              "measure_id": 61
            }
          }
        }
      ],
      "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"
    },
      "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"
      }
    }, {}, {},
  ],
  "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 Số điện thoại, tên khách hàng, ghi chú, ...
status false int null Trạng thái đơn hàng
updateStatus false string / int inserted_at Lọc đơn hàng theo thời gian
startDateTime false unix timestamp null Ngày bắt đầu 1699635600
endDateTime false unix timestamp null Ngày kết thúc 1699635600
order_sources false array null [Mã nguồn đơn hàng, Mã TK nguồn đơn hàng] [-1, 314]
updateStatus Lọc đơn hàng theo thời gian
inserted_at Tạo đơn hàng
updated_at Cập nhật cuối
partner_inserted_at Đẩy đơn sang DVVC
paid_at Đối soát
estimate_delivery_date Dự kiến nhận hàng
picked_up_at DVVC lấy hàng lúc
first_delivery_at DVVC giao lần đầu lúc
transfer_proof Xác thực chuyển khoản
time_assign_seller Phân công nhân viên xử lý
time_assign_care Thời điểm phân công NV chăm sóc
time_assign_marketer Thời điểm phân công marketer
-1 Lần cuối cập nhật trạng thái
0 Mới
11 Chờ hàng
20 Đã đặt hàng
1 Đã xác nhận
12 Chờ in
13 Đã in
8 Đang đóng hàng
9 Chờ chuyển hàng
2 Đã gửi hàng
3 Đã nhận
16 Đã thu tiền
4 Đang trả hàng
15 Hoàn 1 phần
5 Đã hoàn

Lấy danh sách đơn hàng thông tin từng đơn hàng cụ thể

Lấy thông tin 1 đơn hàng

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
    },
    "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,
    "received_at_shop": false,
    "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,
        "measure_group_id": 860000034,
        "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,
          "measure_info": {
            "exchange_value": 30,
            "measure_id": 61
          }
        }
      }
    ],
    "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"
  },
    "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"
    }
  }

Tạo đơn hàng

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"
}

Query Parameters

Parameter Required Type Default
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

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

Cập nhật đơn hàng

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": [],
    "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"
}
Parameter Type Description Note
shop_id int Mã shop
bill_phone_number string SĐT khách hàng nhận hàng
bill_full_name string Tên khách hàng nhận hàng
id string Mã đơn hàng
warehouse_id uid Mã kho hàng. Lấy theo api GET /warehouses
is_free_shipping boolean Phí vận chuyển
shipping_fee int Phí vận chuyển
received_at_shop boolean true: Bán hàng tại quầy
false: Bán online
note_print string Ghi chú đơn hàng
items array Danh sách sản phẩm
item.discount_each_product int Khuyến mãi trên từng sản phẩm
item.is_discount_percent boolean Khuyến mãi trên từng sản phẩm theo phần trăm
item.is_bonus_product boolean Sản phẩm tặng kèm
item.quantity int Số lượng sản phẩm
item.one_time_product boolean Sản phẩm thêm nhanh
item.variation_info json Thông tin chi tiết sản phẩm
item.variation_id uid Mã mẫu mã. Lấy theo api GET /variations
item.product_id uid Mã sản phẩm. Lấy theo api GET /variations
province_id string Mã tỉnh thành phố. Lấy theo api GET /geo/provinces
district_id string Mã quận huyện. Lấy theo api GET /geo/districts
commune_id string Mã phường xã. Lấy theo api GET/ geo/communes
shipping_address json Thông tin nhận hàng
shipping_address.address string Địa chỉ chi tiết nhận hàng(số nhà, tên đường, ....)
shipping_address.full_address string Địa chỉ đầy đủ nhận hàng
shipping_address.full_name string Tên khách hàng
shipping_address.phone_number string Số điện thoại, tên khách hàng, ghi chú, ...
warehouse_info json Thông tin kho hàng
note string Ghi chú nội bộ
discount int Giảm giá đơn hàng
is_wholesale boolean Bán sỉ
inserted_at time Thời điểm tạo
updated_at time Thời điểm cập nhật trạng thái
creator json Thông tin người tạo đơn
creator.fb_id string ID facebook người tạo đơn
creator.name string Tên người tạo đơn
last_editor json Thông tin người chỉnh sửa cuối cùng đơn hàng
status int Trạng thái đơn hàng
partner.partner_id int Mã ĐVVC
partner.extend_code string Mã vận đơn
tags array Danh sách thẻ đơn hàng
tag.id string Mã thẻ đơn hàng
tag.name string Tên thẻ đơn hàng
cod int Tổng tiền cần thu
total_price int Tổng giá trị sản phẩm
total_price_after_sub_discount int Tổng giá đơn hàng đã trừ chiết khấu
charged_by_momo int Số tiền khách thanh toán qua MOMO
charged_by_qrpay int Số tiền khách thanh toán qua QRPAY
charged_by_card int Số tiền khách quẹt thẻ
transfer_money int Số tiền khách chuyển khoản
page_id string Mã Facebook page
partner_fee int Phí vận chuyển từ ĐVVC
fee_marketplace int Phí sàn
customer_pay_fee boolean false: Shop trả phí ship
true: Khách trả phí ship
account int Mã nguồn đơn hàng
account_name string Tên mã nguồn đơn
assigning_seller_id uid Mã nhân viên được phân công
arrange_shipment_marketplace boolean Chuẩn bị hàng với đơn từ sàn Shopee, Lazada, TikTok
pick_up_method (1.1) string Phương thức lấy hàng Shopee, Tiktok
picking_shif_marketplace (1.2) string Ca lấy hàng Shopee
(1.1) pick_up_method Phương thức lấy hàng
pick_up ĐVVC lấy hàng
drop_off Mang hàng ra bưu cục
(1.2) picking_shif_marketplace Ca lấy hàng
closest Ngày gần nhất
farthest Ngày xa nhất

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

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 Mã shop
id int / string Mã nguồn đơn hàng / Mã page
name string Tên nguồn đơn hàng / Tên page
parent_id int Mã nguồn đơn hàng cha

Lấy liên kết in đơn sàn

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

Request

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

Response

{
  "data": [
    "https://www.africau.edu/images/default/sample.pdf"
  ],
  "success": true
}

Query Parameters

Parameter Required Type Example
document_type (1.1) true string SL_PL

Request Parameters

Parameter Required Type Description
order_id true string Mã đơn hàng
(1.1) document_type Loại in
SL_PL Nhãn vận chuyển + Phiếu đóng gói
SHIPPING_LABEL Nhãn vận chuyển
PICK_LIST Phiếu đóng gói

Lấy liên kết xác nhận đơn hàng

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

Response

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

Response Parameters

Parameter Type Description
url string Liên kết xác nhận đơn hàng

Thông tin đơn hàng

Response

{
  "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,
  "tags": [61],
  "charged_by_vnpay": 0,
  "charged_by_qrpay": 0,
  "partner_fee": 27000,
  "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": {
    "delivery_name": null,
    "delivery_tel": null,
    "extend_code": "LMP0224531356VNA",
    "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"
  },
  "id": 103973,
  "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": [
    {
      "returned_count": 0,
      "note": "sp dễ vỡ",
      "id": 37956,
      "inserted_at": "2023-11-02T09:13:23.245866",
      "measure_group_id": 58,
      "variation_info": {
        "name": "Áo thời trang Nam Pari",
        "custom_id": "Nam Pari TX",
        "shop_warranty_policy_id": null,
        "inserted_at": "2023-05-17T08:46:39",
        "product_id": "Áo thời trang Nam Pari",
        "detail": "mau: trang, size: X",
        "weight": 700,
        "images": [
          "https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"
        ],
        "is_accessory": false,
        "measure_info": {
          "exchange_value": 30,
          "measure_id": 61
        },
        "barcode": "12392-4",
        "price_at_counter": 0,
        "retail_price": 200000,
      },
      "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,
      "quantity": 2
    }
  ],
  "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,
  "activated_combo_products": [],
  "cost_surcharge": 0,
  "marketer": {
    "avatar_url": "https://statics.pancake.vn/user-content-dev2.pancake.vn/2022/1/4/a913bfe540a71b2a2bdf45429f91074cdcfdb170.png",
    "email": "thanglong96hust@gmail.com",
    "fb_id": "1137015309792644",
    "id": "316dcba2-e4ef-4787-b2d2-b02e83c8522c",
    "name": "Lê Thăng Long",
    "phone_number": null
  },
  "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": []
}
Parameter Type Description
advanced_platform_fee (1.0) json Phí sàn
printing_count int Số lần in
updated_at time Thời điểm cập nhật trạng thái
money_to_collect int Số tiền cần thu
total_price int Tổng giá trị sản phẩm
shop_customer_address_id uid Mã địa chỉ khách hàng
customer (1.1) json Thông tin khách hàng
status int Trạng thái đơn hàng
bill_phone_number string SĐT khách hàng nhận hàng
total_quantity int Tổng số lượng
time_assign_marketer time Thời điểm phân công marketer
is_locked boolean Khóa đơn hàng
note_print string Ghi chú đơn hàng
creator_id uid Mã người tạo
status_history array Lịch sử cập nhật trạng thái
duplicated_phone boolean Trùng số điện thoại
order_currency string Đơn vị tiền tệ
note string Ghi chú nội bộ
warehouse_info json Thông tin kho hàng
is_free_shipping boolean Phí vận chuyển
tags (1.2) array Danh sách thẻ đơn hàng
charged_by_vnpay int Số tiền thanh toán bằng VNPAY
charged_by_qrpay int Số tiền khách thanh toán qua QRPAY
partner_fee int Phí vận chuyển từ ĐVVC
custom_id string Mã đơn hàng
last_editor json Thông tin người chỉnh sửa cuối cùng đơn hàng
charged_by_momo int Số tiền khách thanh toán qua MOMO
bank_transfer_images array Link hình ảnh chuyển khoản
id string Mã đơn hàng
partner (1.3) json Thông tin vận chuyển
page_id string Mã Facebook page
inserted_at time Thời điểm tạo
shop_id int Mã shop
transfer_money int Số tiền khách chuyển khoản
lock_order_by_user uid Mã người khóa đơn hàng
received_at_shop boolean true: Bán hàng tại quầy
false: Bán online
assigning_care json Nhân viên chăm sóc
assigning_seller_id uid Mã nhân viên được phân công
total_discount int Tổng tiền giảm giá
einvoices array Thông tin hóa đơn điện tử
shop_customer_id uid Mã khách hàng
charged_by_card int Số tiền khách quẹt thẻ
items (1.4) array Danh sách sản phẩm
estimate_delivery_date time Dự kiến nhận hàng
order_sources string Mã nguồn đơn hàng
charged_by_fundiin int Số tiền thanh toán bằng Fundiin
warehouse_id uid Mã kho hàng. Lấy theo api GET /warehouses
surcharge int Phụ thu
returned_reason string Lý do trả lại
last_editor_id uid Mã người sửa cuối
is_linked_partner boolean Liên kết ĐVVC
shipping_fee int Phí vận chuyển
call_laters array Gọi lại
last_update_status_at time Thời điểm cập nhật trạng thái cuối
discount_by_customer_level int Giảm giá bởi cấp độ khách hàng
viewing array NV đang xem
creator json Thông tin người tạo đơn
creator.fb_id string ID facebook người tạo đơn
creator.name string Tên người tạo đơn
bill_full_name string Tên khách hàng nhận hàng
order_returned_ids uid Mã đơn trả hàng
activated_combo_products array Thông tin combo được kích hoạt
cost_surcharge int Phụ phí
marketer json Marketer
time_send_partner time Thời điểm đẩy đơn
charged_by_kredivo int Số tiền thanh toán bằng Kredivo
shipping_address (1.5) json Thông tin nhận hàng
discount int Chiết khấu
pke_mkter uid Mã nhân viên marketer
histories array Lịch sử
duplicated_customer boolean Trùng khách hàng
bill_email string Email khách hàng
customer_referral_code json Mã giới thiệu khách hàng
assigning_seller json Nhân viên được phân công
tax int Thuế
time_assign_care time Thời điểm phân công NV chăm sóc
assigning_care_id uid Mã nhân viên chăm sóc
cod int Tổng tiền cần thu
customer_pay_fee boolean false: Shop trả phí ship
true: Khách trả phí ship
cash int Tiền mặt
is_from_ecommerce boolean Đơn từ sàn
account int Mã nguồn đơn hàng
note_image array Link hình ảnh ghi chú

advanced_platform_fee (1.0)

Parameter Type Description
affiliate_commission int Phí hoa hồng (Sàn TMĐT)
diff_shipping_fee int Chênh lệch phí vận chuyển (Sàn TMĐT)
marketplace_voucher int Sàn trợ giá
payment_fee int Phí cố định, giao dịch (Sàn TMĐT)
platform_commission int Phí hoa hồng nền tảng (Sàn TMĐT)
seller_transaction_fee int Phí thanh toán (Sàn TMĐT)
service_fee int Phí dịch vụ (Sàn TMĐT)
sfp_service_fee int Phí dịch vụ SFP (Sàn TMĐT)

customer (1.1)

Parameter Type Description
fb_id string Mã Fb khách hàng
id uid Mã khách hàng
name string Tên khách hàng
page_id string Mã Facebook page

tags (1.2)

Parameter Type Description
id string Mã thẻ đơn hàng
name string Tên thẻ đơn hàng

partner (1.3)

Parameter Type Description
delivery_name string Nhân viên giao hàng
delivery_tel string SDT nhân viên giao hàng
extend_code string Mã vận đơn
partner_id int Mã ĐVVC
picked_up_at time Lấy hàng lúc
sort_code string Mã vận chuyển rút gọn
total_fee int Tổng phí
updated_at time Cập nhật lúc

items (1.4)

Parameter Type Description
note string Ghi chú
inserted_at time Thời điểm tạo
measure_group_id int Mã nhóm ĐVT
discount_each_product int Khuyến mãi trên từng sản phẩm
is_bonus_product boolean Sản phẩm tặng kèm
is_discount_percent boolean Khuyến mãi trên từng sản phẩm theo phần trăm
is_wholesale boolean Bán sỉ
variation_id uid Mã mẫu mã. Lấy theo api GET /variations
product_id uid Mã sản phẩm. Lấy theo api GET /variations
quantity int Số lượng sản phẩm
measure_group_id int Mã nhóm ĐVT
variation_info json Thông tin chi tiết sản phẩm
variation_info.measure_info json Thông tin ĐVT
variation_info.measure_info.measure_id int Mã ĐVT
variation_info.measure_info.exchange_value int Giá trị quy đổi

shipping_address (1.5)

Parameter Type Description
address string Địa chỉ chi tiết nhận hàng(số nhà, tên đường, ....)
commnue_name string Phường / Xã
commune_id string Mã phường xã. Lấy theo api GET/ geo/communes
country_code string Mã quốc gia (ví dụ mã quốc gia Viet Nam là 84)
district_id string Mã quận huyện. Lấy theo api GET /geo/districts
district_name string Quận / Huyện
full_address string Địa chỉ đầy đủ nhận hàng
full_name string Tên khách hàng
phone_number string Số điện thoại, tên khách hàng, ghi chú, ...
province_id string Mã tỉnh thành phố. Lấy theo api GET /geo/provinces
province_name string Tỉnh / thành phố
Status Tên trạng thái
0 Mới
17 Chờ xác nhận
11 Chờ hàng
12 Chờ in
13 Đã in
20 Đã đặt hàng
1 Đã xác nhận
8 Đang đóng hàng
9 Chờ chuyển hàng
2 Đã gửi hàng
3 Đã nhận
16 Đã thu tiền
4 Đang trả hàng
15 Hoàn 1 phần
5 Đã hoàn
6 Đã hủy
7 Đã xóa
10 Đơn Webcake
21 Đơn Storecake
Partner Status Tên trạng thái
request_received Mới
delay_pickup Delay lấy hàng
picking_up Đang lấy hàng
picked_up Đã lấy hàng/ đã nhập kho
on_the_way Hàng đang ở kho trung chuyển
delay_delivery Delay giao hàng
out_for_delivery Đang giao hàng
undeliverable Giao không thành
waiting_for_return Chờ chuyển hoàn
delivered Giao thành công
delivered_cod Đã đối soát nhận hàng
returning Đang trả hàng
returned Đã hoàn
returned_cod Đối soát trả hàng
canceled Đã hủy
PartnerId Tên đơn vị vận chuyển
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 Mô tả lý do hoàn
1 Do khách hàng
2 Do nhân viên
3 Do sản phẩm
4 Do đơn vị vận chuyển
5 Do đổi hàng

Đơn hàng đổi trả

Danh sách đơn hàng đổi trả

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 Trạng thái
update_status false string / int inserted_at Lọc đơn hàng theo thời gian
start_time false unix timestamp null Ngày bắt đầu 1699635600
end_time false unix timestamp null Ngày kết thúc 1699635600
update_status Lọc đơn hàng theo thời gian
inserted_at Tạo đơn hàng
0 Mới
2 Đã gửi hàng
1 Hoàn tất
4 Đã hủy

Kho hàng

Tạo kho hàng

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 Địa chỉ chi tiết kho hàng(số nhà, đường, ...)
batch_config false json Cấu hình lô
country_code false string Mã quốc gia
commune_id false string Mã phường xã. Lấy theo api GET/ geo/communes
custom_batch_config false json Cấu hình lô tùy chỉnh
custom_shelf_config false json Cấu hình kệ tùy chỉnh
district_id false string Mã quận huyện. Lấy theo api GET /geo/districts
hide_config_batch_shelf false boolean Mở cấu hình lô kệ tùy chỉnh
province_id false string Mã tỉnh thành phố. Lấy theo api GET /geo/provinces
phone_number false string Số điện thoại kho hàng
name true string Tên kho hàng
shelf_config true json Cấu hình kệ

Cập nhật kho hàng

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 Địa chỉ chi tiết kho hàng(số nhà, đường, ...)
batch_config false json Cấu hình lô
country_code false string Mã quốc gia
commune_id false string Mã phường xã. Lấy theo api GET/ geo/communes
custom_batch_config false json Cấu hình lô tùy chỉnh
custom_shelf_config false json Cấu hình kệ tùy chỉnh
district_id false string Mã quận huyện. Lấy theo api GET /geo/districts
hide_config_batch_shelf false boolean Mở cấu hình lô kệ tùy chỉnh
province_id false string Mã tỉnh thành phố. Lấy theo api GET /geo/provinces
phone_number false string Số điện thoại kho hàng
name true string Tên kho hàng
shelf_config true json Cấu hình kệ

Danh sách kho hàng

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 Địa chỉ chi tiết kho hàng(số nhà, đường, ...)
allow_create_order boolean Kho hàng có thể tạo đơn hàng
commune_id string Mã phường xã
district_id string Mã quận huyện
province_id string Mã tỉnh thành phố
country_code string Mã quốc gia
custom_id string Mã tuỳ chỉnh kho hàng
id uid Mã kho hàng
full_address string Địa chỉ đầy đủ kho hàng
name string Tên kho hàng
phone_number string Số điện thoại kho hàng

Danh sách nhân viên

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

Response

{
  "data": [
    {
      "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",
  },
  ],
  "success": true
}

Response Parameters

Parameter Type Description
shop_id int Mã shop
user_id uid Mã nhân viên
user json Thông tin nhân viên
user.email string Email nhân viên
user.fb_id string Mã facebook của nhân viên
user.name string Tên nhân viên
user.phone_number string SĐT nhân viên

Hẹn gọi & nhắc nhở

Danh sách hẹn gọi & nhắc nhở

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 Trạng thái
Status Tên trạng thái
-1 Tất cả trạng thái
0 Chưa xử lý
3 Đang gọi / Đang xử lý
1 Đã xử lý
2 Không nghe máy / Không thành công
7 Đã xóa

Response Parameters

Parameter Type Description
called_at unix timestamp Gọi lúc / Xử lý lúc
creator json Thông tin người tạo
display_id int Mã hẹn gọi & nhắc nhở
need_notify_users array Nhân viên xử lý
needs_call_at unix timestamp Cần gọi lúc / Cần xử lý lúc
notice_created string Thông tin thông báo
order_display_id string Mã đơn hàng
status int Trạng thái
type string Loại thông báo

Tạo hẹn gọi & nhắc nhở

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"
  }
}

Query Parameters

Parameter Required Type Description
status true int Trạng thái
need_notify_users false array Nhân viên xử lý
notice_created false string Thông tin thông báo
needs_call_at true iso 8601 Cần gọi lúc
phone_number true string Số điện thoại

Sản phẩm

Tạo sản phẩm

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

Request

{
  "product": {
    "name": "Tên sản phẩm",
    "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": 0,
        "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"
      }
    ]
  }
}

Query Parameters

Parameter Required Type Default Example
name true string Tên sản phẩm Test
note_product false string Ghi chú sản phẩm
product_attributes false array Thông tin thuộc tính [{name: "Màu", values: ["Đen", "Trắng", "Đỏ"]}, {name: "Size", values: ["S", "M", "L"]}]
tags false array Thẻ sản phẩm [193, 51]
weight true int Khối lượng sản phẩm 100
custom_id false string Mã tuỳ chỉnh sản phẩm TEST1
is_published false boolean Trạng thái StoreCake true
variation.images false array Link hình ảnh mẫu mã "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
variation.last_imported_price false int Giá nhập 30000
variation.retail_price true int Giá sản phẩm 1000000
variation.weight true int Khối lượng mẫu mã 100
variation.barcode false string Mã barcode mẫu mã BAR001
variation.custom_id false string Mã tuỳ chỉnh mẫu mã TEST1001
variation.is_hidden false string Trạng thái StoreCake is_hidden = true -> Ẩn, is_hidden = false -> Hiện false
variation.fields false array Thông tin thuộc tính mẫu mã [{name: "Màu", value: "Trắng"}, {name: "Size", value: "M"}]
variation.variations_warehouses false array Thông tin kho hàng [{remain_quantity: 10, warehouse_id: "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da", batch_position: "lô 1", "shelf_position": "1.2"}]

Cập nhật thông tin sản phẩm

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

Request

{
  "product": {
    "name": "Tên sản phẩm",
    "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  
        "id": "3c3aca82-030e-4708-a75b-b2eaf538a2f5",
        "fields": [{"name": "Màu", "value": "Trắng"}, {"name": "Size", "value": "M"}],
        "images": [],
        "last_imported_price": 30000,
        "retail_price": 0,
        "weight": 0,
        "barcode": "BARCODE123",
        "custom_id": "VCUSTOMID",
        "is_hidden": false
      },
      {
        // Tạo mẫu  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": 0,
        "weight": 0,
        "barcode": "BARCODE123",
        "custom_id": "VCUSTOMID2",
        "is_hidden": false
      }
    ],
    "weight": 1,
    "custom_id": "PCUSTOMID",
    "is_published": true,
    "tags": [193, 51],
    "variations_warehouses": [
      {
        "remain_quantity": 10,
        "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
        "batch_position": "lô 1",
        "shelf_position": "1.2"
      }
    ]
  }
}

Query Parameters

Parameter Type Description Example
name string Tên sản phẩm Test
note_product string Ghi chú sản phẩm
product_attributes array Thông tin thuộc tính [{name: "Màu", values: ["Đen", "Trắng", "Đỏ"]}, {name: "Size", values: ["S", "M", "L"]}]
tags array Thẻ sản phẩm [193, 51]
weight int Khối lượng sản phẩm 100
custom_id string Mã tuỳ chỉnh sản phẩm TEST1
is_published false boolean Trạng thái StoreCake
variations array Mẫu mã sản phẩm
variation.images array Link hình ảnh mẫu mã "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
variation.last_imported_price int Giá nhập 300000
variation.retail_price int Giá sản phẩm 1000000
variation.weight int Khối lượng mẫu mã 100
variation.barcode string Mã barcode mẫu mã BAR001
variation.custom_id string Mã tuỳ chỉnh mẫu mã TEST1001
variation.is_hidden boolean Trạng thái StoreCake is_hidden = true -> Ẩn, is_hidden = false -> Hiện false
variation.fields array Thông tin thuộc tính mẫu mã [{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: Xóa mẫu mã, false: Không xóa mẫu mã false

Cập nhật tồn kho

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 Mã mẫu mã e190db2b-1163-4cc3-b956-7a9528fbf5ef
variations_warehouses array Thông tin tồn kho
variations_warehouses.remain_quantity int Số lượng tồn kho
variations_warehouses.warehouse_id string Mã kho hàng
is_actual_remain_quantity boolean true: Cập nhật tồn kho, false: Cập nhật có thể bán

Cập nhật tồn kho nhiều mẫu mã

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: Cập nhật tồn kho, false: Cập nhật có thể bán
variations_warehouses array Thông tin tồn kho
variations_warehouses.variation_id string Mã mẫu mã
variations_warehouses.remain_quantity int Số lượng tồn kho
variations_warehouses.warehouse_id string Mã kho hàng

Cập nhật sản phẩm cấu thành

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 Mã mẫu mã
composite_products.quantity int Số lượng cấu thành
composite_products.component_id string Mã mẫu mã cấu thành

Danh sách sản phẩm

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"
      ],
      "last_imported_price": 55000,
      "product_id": "3b98a639-9d40-4faa-a692-6662f20e128d",
      "product": {
        "note_product": "Ghi chú sản phẩm",
        "categories": [],
        "display_id": "ADXL",
        "name": "ASOS đen XL",
        "tags": [
          {
            "id": 51,
            "note": "the 3"
          },
          {
            "id": 193,
            "note": "thẻ 1"
          }
        ],
        "is_published": true,
      },
      "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,
          "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 false string Tốc độ bán
product_status false string Trạng thái sản phẩm
category_id false array Mã danh mục
is_filter_categories_by_or false boolean true Lọc danh mục theo điều kiện or
filter_exclude_categories false boolean false Lọc loại trừ danh mục
warehouse_until false time null Lấy thông tin tồn kho tại 1 thời điểm 2024-06-10T17:00:00.000Z
selling_status Description
none Đang thử nghiệm
bad Bán chậm
normal Đã gửi hàng
star Đã nhận
product_status Description
locked Ngừng hoạt động
not_locked Đang hoạt động

Reponse Parameters

Parameter Type Description
display_id string Mã hiển thị sản phẩm
note_product string Ghi chú sản phẩm
is_hidden boolean Trạng thái StoreCake is_hidden = true -> Ẩn, is_hidden = false -> Hiện
is_locked boolean Ghi chú sản phẩm
is_sell_negative_variation boolean Cho phép bán âm
fields json Thông tin cho tiết sản phẩm
field.name string Tên thuộc tính
field.value string Giá trị thuộc tính
id uid Mã mẫu mã
last_imported_price int Giá nhập hàng
product.categories array Danh mục sản phẩm
product.display_id string Mã hiển thị sản phẩm
product.name string Tên sản phẩm
product.tags array Thẻ sản phẩm
product.is_published boolean Trạng thái StoreCake
product_id uid Mã sản phẩm
remain_quantity int Số lượng mẫu mã còn lại
retail_price int Giá bán mẫu mã
total_purchase_price int Tổng tiền còn lại
variations_warehouses array Thông tin tồn kho chi tiết
variations_warehouses.actual_remain_quantity int Tồn kho
variations_warehouses.pending_quantity int Sắp về
variations_warehouses.remain_quantity int Số lượng mẫu mã còn lại trong kho
variations_warehouses.returning_quantity int Số lượng đang hoàn
variations_warehouses.total_quantity int Tổng số lượng
variations_warehouses.warehouse_id uid Mã kho hàng
wholesale_price array Giá bán sỉ
images array Link hình ảnh mẫu mã

Danh mục sản phẩm

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 Mã danh mục
text string Tên danh mục
nodes array Danh mục con

Nhóm đơn vị tính

Danh sách nhóm ĐVT

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 Mã nhóm ĐVT
name string Tên nhóm ĐVT
nodes array Thông tin ĐVT thuộc nhóm
nodes.exchange_value int Giá trị quy đổi
nodes.id int Mã ĐVT
nodes.is_default boolean ĐVT mặc định
nodes.name string Tên ĐVT
nodes.parent_id int Mã nhóm ĐVT

Khách hàng

Danh sách khách hàng

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 Thời gian bắt đầu (Tạo) 1710608400
end_time_inserted_at false unix timestamp Thời gian kết thúc (Tạo) 1713286799
start_time_updated_at false unix timestamp Thời gian bắt đầu (Cập nhật) 1712595600
end_time_updated_at false unix timestamp Thời gian kết thúc (Cập nhật) 1713286799
customer_ids false string null Mã khách hàng "4c74b7cf-f87b-484e-8549-6872d964f78f,d74e7fe9-580e-45e5-9374-7241297bd69d"

Response Parameters

Parameter Type Description
date_of_birth string Ngày sinh nhật
fb_id string facebook id
reward_point int Điểm thưởng
id uid Mã khách hàng
name string Tên khách hàng
order_count int Số lần mua hàng
phone_numbers array Danh sách sđt của khách hàng
emails array Email khách hàng
last_order_at time Lần mua hàng cuối
purchased_amount int Số tiền đã mua hàng
shop_customer_addresses array Thông tin địa chỉ khách hàng
succeed_order_count int Số lần mua hàng thành công
full_address string Địa chỉ đầy đủ kho hàng
tags array Thẻ khách hàng
phone_number string Số điện thoại kho hàng
reward_point float Điểm thưởng
referral_code string Mã giới thiệu
gender string Giới tính

Tạo khách hàng

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 Tên khách hàng Nguyen Van Hoang
phoneNumber true string Số điện thoại 0903924956
createType true string Hình thức tạo ignore
dateOfBirth false string time Ngày sinh 1995-02-01
last_order_at false unix timestamp Lần mua cuối 1715878800
createType Hình thức tạo
ignore Bỏ qua khách hàng với SĐT đã tồn tại
update Cập nhật tất cả khách hàng với SĐT đã tồn tại
force Tạo thêm khách hàng với SĐT đã tồn tại

Cập nhật khách hàng

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",
      }
    ]
  }
}

Query Parameters

Parameter Required Type Description Example
name false string Tên khách hàng 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 Số điện thoại ["0983925966"]
date_of_birth false string Ngày sinh 1995-03-04
reward_point false int Điểm thưởng 20
is_discount_by_level false boolean Giảm giảm giá theo level false
tags false array Thẻ khách hàng ["Hay hoàn"]
is_block false boolean Chặn khách hàng false
assigned_user_id false uid Mã nhân viên được phân công
level_id false uid Mã cấp độ khách hàng
notes (1.1) false array Ghi chú khách hàng
shop_customer_address (1.2) false array Địa chỉ khách hàng

Note (1.1)

Parameter Required Type Description Example
id false uid Mã ghi chú
message false string Nội dung ghi chú
images false array Ghi chú hình ảnh [{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 Mã địa chỉ
country_code false int Mã quốc gia
province_id false string Mã tỉnh thành phố
district_id false string Mã quận huyện
commune_id false string Mã phường xã
address false string Địa chỉ
full_name false string Tên người nhận
phone_number false string Số điện thoại

Ghi chú khách hàng

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",
          "removed_at": null,
          "updated_at": null
        }
      ]
    }
  ]
}

Response Parameters

Parameter Type Description
created_at unix timestamp Thời điểm tạo
created_by json Thông tin người tạo
edit_history array Lịch sử chình sửa
id uid Mã ghi chú
images array Link hình ảnh ghi chú
message string Nội dung ghi chú
order_id string Mã đơn hàng
removed_at unix timestamp Thời điểm xóa
updated_at unix timestamp Thời điểm cập nhật

Lịch sử điểm thưởng khách hàng

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 Mã khách hàng

Response Parameters

Parameter Type Description
amount int Số điểm thay đổi
creator json Thông tin người tạo
current_point int Điểm hiện tại
inserted_at iso 8601 Thời điểm tạo
note string Lý do thay đổi điểm thưởng

Tạo khuyến mãi theo khách hàng

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 Thời gian bắt đầu
end_time false iso 8601 Thời gian kết thúc
warehouse_ids false array Mã kho áp dụng
customer_tags false array Thẻ khách hàng
type true string Loại khuyến mãi
is_activated true boolean Kích hoạt
promo_code_info true json Thông tin khuyến mãi
promo_code_info.discount true int Giá trị giảm giá
promo_code_info.is_percent true boolean true: theo %, false: theo giá trị
max_discount_by_percent false int Số tiền tối đa giảm giá theo %
order_price_min false int Giá trị đơn hàng tối thiểu
order_price_max false int Giá trị đơn hàng tối đa
no_applied_products_in_other_promotions false boolean Không áp dụng cho sản phẩm đã có trong khuyến mãi khác
discount_after_other_discount false boolean Giảm theo giá trị đơn hàng sau khi trừ các chiết khấu khác
shop_customer_ids true array Mã khách hàng áp dụng

Cấp độ khách hàng

Danh sách cấp độ khách hàng

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
}

Response Parameters

Parameter Type Description
color_customer_level string Mã màu của cấp độ
discount int Giá trị giảm giá
discount_type int Loại giảm giá 2: Theo giá trị, 3: Theo phần trăm (%)
id uid Mã cấp độ
name string Tên cấp độ
upgrade_by_order_count int Nâng hạng bởi số đơn
upgrade_by_point int Nâng hạng bởi số điểm
upgrade_by_total_purchase int Nâng hạng bởi số tiền

Thu chi

Danh sách thu chi

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 Trạng thái
startDateTime false unix timestamp null Thời gian bắt đầu 1692810000
endDateTime false unix timestamp null Thời gian kết thúc 1695488399
Status Tên trạng thái
-1 Tất cả trạng thái
0 Mới
1 Có hiệu lực
2 Đã hủy
3 Đã xóa

Response Parameters

Parameter Type Description
advertising_cost_id uid Mã chi phí quảng cáo
amount int Số tiền
creator json Thông tin người tạo
creator_id uid Mã người tạo
display_id string Mã giao dịch
images array Link hình ảnh
inserted_at unix timestamp Thời điểm tạo
is_accounting boolean Hạch toán tài chính
is_locked boolean Khóa
name string Tên giao dịch
note string Ghi chú
payment_debts_to_suppliers boolean Thanh toán công nợ cho nhà cung cấp
payments array Hình thức thanh toán
status int Trạng thái
supplier_products_id int Mã nhà cung cấp
tag_ids array Thẻ giao dịch
time_incurred unix timestamp Thời điểm phát sinh

Tạo phiếu thu chi

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 Tên giao dịch
note false string Ghi chú
amount false int Số tiền
is_locked false boolean Khóa
tag_ids false array Thẻ giao dịch ["193a-e877-359a-b340-01d8-4d2e-2050"]
payments false array Hình thức thanh toán ["transfer_money"]
supplier_products_id false int Mã nhà cung cấp
is_accounting false boolean Hạch toán tài chính
time_incurred false unix timestamp Thời điểm phát sinh
images false array Link hình ảnh ["https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"]
payments Hình thức thanh toán
cash Tiền mặt
transfer_money Chuyển khoản
charged_by_card Quẹt thẻ
charged_by_momo Momo
charged_by_vnpay VNPay
charged_by_kredivo Kredivo
charged_by_fundiin Fundiin
charged_by_qrpay QRpay

Tạo chi phí quảng cáo

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,
        "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 Chi phí quảng cáo ngày
transaction true json Thu chi
name true string Tên chi phí quảng cáo
is_locked false boolean Khóa
note false string Ghi chú
status true string Trạng thái
time_incurred false string Thời điểm phát sinh
tags false array Thẻ chi phí quảng cáo
items true array Danh sách chi tiết của chi phí quảng cáo
cost true int Chi phí
warehouse_id false string Mã kho hàng
is_livestream false boolean Livestream
product false string Mã sản phẩm
pke_mkter false string Marketer
source false json Nguồn
is_wholesale false boolean Bán sỉ
post_ids false array Mã bài viết

Thống kê đơn hàng

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

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
            }
        },
        {
            "Time.day": "2020-07-27",
            "returned": null,
            "success": {
                "cod": 570000,
                "discount": 0,
                "order_count": 1,
                "price": 600000,
                "product_count": 6,
                "shipping_fee": 0
            }
        },
        {
            "Time.day": "2020-07-28",
            "returned": null,
            "success": {
                "cod": 5130000,
                "discount": 0,
                "order_count": 9,
                "price": 5400000,
                "product_count": 54,
                "shipping_fee": 0
            }
        },
        {
            "Time.day": "2020-07-30",
            "returned": null,
            "success": {
                "cod": 570000,
                "discount": 0,
                "order_count": 1,
                "price": 600000,
                "product_count": 6,
                "shipping_fee": 0
            }
        },
    ],
    "success": true
  }

Query Parameters

Parameter Required Type Example Description
since false string '2020-08-01 00:00:00' Thời gian bắt đầu thống kê
until false string '2020-08-20 00:00:00' Thời gian kết thúc thống kê
split_by false array ["Time.day", "Order.source", "Variation.id", "Variation.product_id"] Time.day: Theo ngày, Order.source: Theo nguồn đơn hàng, Variation.id: Theo mẫu mã, Variation.product_id: Theo sản phẩm
filter false json {"Variation.id":["08d25e0c-4016-498e-a0c6-48b8e7aad2b4"]} Variation.id: Theo mẫu mã, Variation.product_id: Theo sản phẩm
success_status false string '1' 'send_to_partner': Tính đơn chốt khi đẩy sang ĐVVC
'1': Tính đơn chốt khi cập nhật sang trạng thái đã xác nhận
success_record false string 'inserted_at' 'inserted_at': Doanh thu cộng vào thời điểm tạo đơn
'updated_at': Doanh thu cộng vào thời điểm cập nhật trạng thái
user_type false string 'create' Tính đơn cho nhân viên ('create': Tạo đơn, 'update': Cập nhật trạng thái, 'assign': NV được phân công, 'care': NV chăm sóc, 'marketer': NV Marketing)
returned_status false string '5' Tính hoàn đơn khi ('5': Đã hoàn, '4': Đang hoàn)
returned_record false string 'inserted_at' Doanh thu sẽ trừ vào thời điểm ('inserted_at': Tạo đơn, 'updated_at': Cập nhật trạng thái, 'success_record': Chốt đơn)

Response Parameters

Parameter Type Description
Time.day string Ngày thống kê
returned json Thông tin dữ liệu các đơn hoàn
success json Thông tin dữ liệu các đơn thành công
cod int Tổng tiền cần thu
discount int Chiết khấu
order_count int Số lần mua hàng
price int Giá trị hàng hoá
product_count int Sản phẩm trong các đơn hàng
shipping_fee int Phí vận chuyển

Thẻ đơn hàng

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 Mã thẻ đơn hàng
name string Tên thẻ đơn hàng
color string Mã màu thẻ
is_system_tag boolean true - Thẻ hệ thống
groups array Thông tin nhóm thẻ

Phiếu nhập kho

Danh sách phiếu nhập kho

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,
          "note_purchase": "áo nam thời trang",
          "product_name": "Áo nam",
          "quantity": 1,
          "selling_status": "bad",
          "variation_id": "20e7d183-c70c-445e-8ce2-4d7e3a378e34"
        }
      ],
      "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,
      "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 Trạng thái
type true string product
preload_items false boolean true
Status Tên trạng thái
-2 Tất cả trạng thái
-1 Mới
0 Đã xác nhận
1 Đã nhập hàng
2 Đã hủy

Response Parameters

Parameter Type Description
auto_create_debts boolean Tạo công nợ theo nhà cung cấp
total_remain_quantity int Tổng số lượng còn lại
status int Trạng thái
display_id int Mã phiếu nhập
total_quantity int Tổng số lượng
bill_images array Link hình ảnh hóa đơn
not_create_transaction boolean Không tạo phiếu chi
inserted_at unix timestamp Thời điểm tạo
transport_fee int Phí vận chuyển
items array Thông tin mẫu mã
is_lock boolean Khóa
images array Link hình ảnh ghi chú
user_id uid Mã người tạo
prepaid_debt int Trả trước NCC
total_price int Tổng giá nhập
received_at unix timestamp Ngày về dự kiến
updated_at unix timestamp Cập nhật lúc
total_remain_price int Tổng giá còn lại
tags array Mã thẻ
warehouse_id uid Mã kho hàng
supplier_products_id int Mã nhà cung cấp
discount int Chiết khấu
created_type string Loại phiếu nhập kho
user json Thông tin người tạo
separate_by_display_ids int Mã phiếu nhập được tách ra
note string Ghi chú

items

Parameter Type Description
imported_price int Giá nhập
note_purchase int Ghi chú
product_name string Tên sản phẩm
quantity int Số lượng nhập
selling_status string Trạng thái bán
variation_id uid Mã mẫu mã

Tạo phiếu nhập kho

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,
        "quantity": 1,
        "variation_id": "29044dcf-2f4c-492f-a0a9-e447b20e21da",
        "index": 0,
      }
    ]
  }
}

Request Parameters

Parameter Type Description
note string Ghi chú
status int Trạng thái phiếu nhập
not_create_transaction boolean Không tạo phiếu chi
auto_create_debts boolean Tạo công nợ theo nhà cung cấp
supplier_products_id int Mã nhà cung cấp
shop_id int Mã shop
warehouse_id string Mã kho hàng
change_received_at boolean Đổi ngày về dự kiến
received_at unix timestamp Ngày về dự kiến
images array Link hình ảnh phập hàng
items array Danh sách sản phầm
items.imported_price int Giá nhập
items.quantity int Số lượng nhập
items.variation_id string Mã mẫu mã

Cập nhật phiếu nhập kho

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 Ghi chú
status false int Trạng thái phiếu nhập
not_create_transaction false boolean Không tạo phiếu chi
auto_create_debts false boolean Tạo công nợ theo nhà cung cấp
supplier_products_id false int Mã nhà cung cấp
warehouse_id true string Mã kho hàng
change_received_at false boolean Đổi ngày về dự kiến
received_at false unix timestamp Ngày về dự kiến
images false array Link hình ảnh phập hàng
items false array Danh sách sản phầm
items.imported_price true int Giá nhập
items.quantity false int Số lượng nhập
items.variation_id false string Mã mẫu mã
Status Tên trạng thái
-1 Mới
0 Đã xác nhận
1 Đã nhập hàng
2 Đã hủy

Tách phiếu nhập kho

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

Lưu ý: newPurchase và oldPurchase dùng chung các request parameters

Parameter Required Type Description
newPurchase true json Phiếu nhập mới
oldPurchase true json Phiếu nhập cần tách
auto_create_debts false boolean Tạo công nợ theo nhà cung cấp
discount false int Chiết khấu
id true string Mã phiếu nhập / chỉ dùng cho oldPurchase
images false array Link hình ảnh phập hàng
items true array Danh sách sản phầm
items.imported_price true int Giá nhập
items.quantity true int Số lượng nhập
items.variation_id true string Mã mẫu mã
items.index false int Thứ tự sản phẩm
not_create_transaction false boolean Không tạo phiếu chi
note false string Ghi chú
prepaid_debt false int Trả trước NCC
received_at false unix timestamp Ngày về dự kiến
status true int Trạng thái phiếu nhập
supplier_products_id false int Mã nhà cung cấp
tags false array Thẻ nhập hàng
transport_fee false int Phí vận chuyển
warehouse_id true string Mã kho hàng

Phiếu xuất kho

Danh sách phiếu xuất kho

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 Trạng thái
type true int 0
Status Tên trạng thái
-1 Tất cả trạng thái
0 Mới
1 Hoàn tất
2 Đã hủy

Response Parameters

Parameter Type Description
display_id int Mã phiếu xuất
export_items array Danh sách sản phầm
images array Link hình ảnh xuất hàng
inserted_at unix timestamp Thời điểm tạo
note string Ghi chú
status int Trạng thái
supplier_products_id int Mã nhà cung cấp
tags array Mã thẻ
total int Tổng số lượng
total_price int Tổng giá xuất
updated_at unix timestamp Cập nhật lúc
user json Thông tin người tạo
warehouse_id uid Mã kho hàng

export_items

Parameter Type Description
id uid Mã hạng mục xuất
imported_price int Giá xuất
quantity int Số lượng xuất
variation_id string Mã mẫu mã

Tạo phiếu xuất kho

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 Ghi chú
supplier_products_id int Mã nhà cung cấp
tags array Thẻ xuất hàng
status int Trạng thái phiếu xuất
type int Loại phiếu xuất
shop_id int Mã shop
warehouse_id string Mã kho hàng
images array Link hình ảnh xuất hàng
change_inserted_at boolean Đổi ngày tạo phiếu
inserted_at unix timestamp Ngày tạo phiếu
export_items array Danh sách sản phầm
export_items.id uid Mã hạng mục xuất
export_items.imported_price int Giá xuất
export_items.quantity int Số lượng xuất
export_items.variation_id string Mã mẫu mã

Cập nhật phiếu xuất

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 hình ảnh xuất hàng
inserted_at false unix timestamp Ngày tạo phiếu
note false string Ghi chú
status (1.1) false int Trạng thái phiếu xuất
supplier_products_id false int Mã nhà cung cấp
tags false array Thẻ xuất hàng
export_items false array Danh sách sản phầm
export_items.id true uid Mã hạng mục xuất
export_items.imported_price true int Giá xuất
export_items.quantity true int Số lượng xuất
export_items.variation_id true string Mã mẫu mã
(1.1) status Trạng thái
0 Mới
1 Hoàn tất
2 Đã hủy

Hàng lỗi (theo phiếu xuất)

Tạo phiếu xuất hàng lỗi

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 Ghi chú
supplier_products_id int Mã nhà cung cấp
status int Trạng thái phiếu xuất
type int Loại phiếu xuất
shop_id int Mã shop
warehouse_id string Mã kho hàng
images array Link hình ảnh xuất hàng
change_inserted_at boolean Đổi ngày tạo phiếu
inserted_at unix timestamp Ngày tạo phiếu
export_items array Danh sách sản phầm
export_items.imported_price int Giá xuất
export_items.quantity int Số lượng xuất
export_items.variation_id string Mã mẫu mã

Cập nhật phiếu xuất hàng lỗi

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 hình ảnh xuất hàng
inserted_at false unix timestamp Ngày tạo phiếu
note false string Ghi chú
status (1.1) false int Trạng thái phiếu xuất
supplier_products_id false int Mã nhà cung cấp
export_items false array Danh sách sản phầm
export_items.id true uid Mã hạng mục xuất
export_items.imported_price true int Giá xuất
export_items.quantity true int Số lượng xuất
export_items.variation_id true string Mã mẫu mã
(1.1) status Trạng thái
0 Xuất hàng lỗi
1 Xuất bỏ
2 Đã hủy

Chuyển kho

Danh sách chuyển kho

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 Trạng thái

Response Parameters

Parameter Type Description
creator_id uid Mã người tạo
display_id int Mã phiếu chuyển kho
from_warehouse_id uid Mã kho gốc
from_warehouse_name string Tên kho gốc
images array Link hình ảnh chuyển kho
inserted_at time Thời điểm tạo
items array Danh sách sản phầm
note string Ghi chú
shipping_fee int Phí vận chuyển
shop_id int Mã shop
status int Trạng thái
to_warehouse_id uid Mã kho nhận
to_warehouse_name string Tên kho nhận
total_quantity int Tổng số lượng
updated_status_at time Cập nhật lúc

items

Parameter Type Description
product_display_id string Mã sản phẩm
product_name string Tên sản phẩm
quantity int Số lượng chuyển kho
variation_display_id string Mã mẫu mã
variation_fields array Thông tin thuộc tính mẫu mã

Tạo phiếu chuyển kho

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": 1694710800
  }
}

Request Parameters

Parameter Required Type Description
from_warehouse_id true uid Mã kho gốc
to_warehouse_ids true array Mã kho nhận
shipping_fee false int Phí vận chuyển
note false string Ghi chú
images false array Link hình ảnh chuyển kho
inserted_at false unix timestamp Thời điểm tạo
items true array Danh sách sản phẩm
item.quantity true int Số lượng
item.variation_id true uid Mã mẫu mã

Cập nhật phiếu chuyển kho

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": 1718902800,
    "change_inserted_at": true
  }
}

Request Parameters

Parameter Required Type Description
status true int Trạng thái
from_warehouse_id true uid Mã kho gốc
shipping_fee false int Phí vận chuyển
note false string Ghi chú
images false array Link hình ảnh chuyển kho
inserted_at false unix timestamp Thời điểm tạo
change_inserted_at false / (true nếu có params inserted_at) boolean Thay đổi ngày tạo
items false array Danh sách sản phẩm
items.variation_id true string Mã mẫu mã
items.quantity true int Số lượng chuyển kho
Status Tên trạng thái
0 Chờ chuyển hàng
1 Đang chuyển hàng
2 Hoàn tất
2 Đã hủy

Kiểm hàng

Danh sách kiểm hàng

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",
      "items": null,
      "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 Trạng thái
Status Tên trạng thái
-2 Tất cả trạng thái
-1 Đang tạo
0 Kiểm hàng
1 Đã kiểm hàng
2 Đã hủy

Response Parameters

Parameter Type Description
creator_id uid Mã người tạo
display_id int Mã phiếu kiểm
inserted_at unix timestamp Thời điểm tạo
note string Ghi chú
progress int Phần trăm xử lý
shop_id int Mã shop
status int Trạng thái
stocktaking_at unix timestamp Kiểm hàng lúc
stocktaking_by (1.0) string Kiểm hàng theo
stocktaking_by_value array Mã danh mục / Mã nhà cung cấp / Mã thương hiệu
updated_at unix timestamp Cập nhật lúc
updated_status_at unix timestamp Cập nhật trạng thái lúc
warehouse_id uid Mã kho hàng
(1.0) stocktaking_by Kiểm hàng theo
category_ids Danh mục
supplier_product_ids Nhà cung cấp
brand_id Thương hiệu

Tạo phiếu kiểm hàng

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,
    "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 Mã kho hàng
items true array Danh sách sản phầm
items.variation_id true string Mã mẫu mã
items.changed_quantity true int Chênh lệch
note false string Ghi chú
status true int Trạng thái phiếu xuất
stocktaking_at false unix timestamp Kiểm hàng lúc
stocktaking_by (1.0) false string Kiểm hàng theo
stocktaking_by_value false array Mã danh mục / Mã nhà cung cấp / Mã thương hiệu

Cập nhật kiểm hàng

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 Mã người tạo
id true uid Mã phiếu kiểm
items true array Danh sách sản phầm
items.changed_quantity true int Chênh lệch
items.id true (Cập nhật) / false (Tạo) uid Mã hạng mục kiểm hàng
items.variation_id true string Mã mẫu mã
note false string Ghi chú
status true int Trạng thái phiếu xuất
stocktaking_at false unix timestamp Kiểm hàng lúc
stocktaking_by (1.0) false string Kiểm hàng theo
stocktaking_by_value false array Mã danh mục / Mã nhà cung cấp / Mã thương hiệu
warehouse_id true uid Mã kho hàng

Lịch sử xuất nhập kho

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 Mã kho hàng
variation_ids false array ["76887a5b-8a27-472c-a15a-661ea59434dd"] Mã mẫu mã
startDate false unix timestamp 1716310800 Ngày bắt đầu
endDate false unix timestamp 1718989199 Ngày kết thúc

Response Parameters

Parameter Type Description
avg_price int Giá nhập trung bình
current_inventory array Thông tin tồn kho hiện tại
editor_id uid Mã nhân viên cập nhật
id int Mã xuất nhập kho
inserted_at unix timestamp Thời điểm tạo
quantity int Số lượng thay đổi
remain_quantity int Tồn kho
variation_now json Thông tin mẫu mã
warehouse json Kho thay đổi tồn

Phiếu giảm giá

Danh sách phiếu giảm giá

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 Mã giảm giá
start_time unix timestamp Ngày bắt đầu áp dụng
end_time unix timestamp Ngày kết thúc áp dụng
promo_code_info json Thông tin giảm giá
is_free_shipping boolean Miễn phí vận chuyển
is_activated boolean Đã kích hoạt
is_used boolean Đã sử dụng
creator_id int Người tạo phiếu
inserted_at unix timestamp Thời điểm tạo phiếu
updated_at unix timestamp Thời điểm cập nhật phiếu
display_id int Mã hiển thị phiếu giảm giá
id int Id phiếu giảm giá
shop_id int Mã shop
type string Loại phiếu giảm giá
customer_tags Array Thẻ khách hàng

promo_code_info

Parameter Type Description
discount int Số tiền giảm giá
is_percent boolean Giảm giá theo phần trăm
max_discount_by_percent int Phần trăm giảm tối đa

Lấy thông tin phiếu giảm giá

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"
}

Tạo phiếu giảm giá

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 Mã giảm giá
start_time unix timestamp Ngày bắt đầu áp dụng
end_time unix timestamp Ngày kết thúc áp dụng
promo_code_info json Thông tin giảm giá
is_free_shipping boolean Miễn phí vận chuyển
is_activated boolean Đã kích hoạt
customer_tags Array Thẻ khách hàng

Tạo hàng loạt phiếu giảm giá

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 Số lượng phiếu giảm giá
start_time unix timestamp Ngày bắt đầu áp dụng
end_time unix timestamp Ngày kết thúc áp dụng
promo_code_info json Thông tin giảm giá
is_free_shipping boolean Miễn phí vận chuyển
is_activated boolean Đã kích hoạt
customer_tags Array Thẻ khách hàng

Khuyến mãi

Danh sách khuyến mãi

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

Response

{
  "data": [
    {
      "arr_level_promotion": [],
      "arr_promotion_products": [
        {
          "discount_each_product": 0,
          "images": [
            "https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/5/24/fffa8e0be4ff6aa55b5c1caa8d2bc3eca51ddcac.png"
          ],
          "is_discount_percent": false,
          "key": "710da0c2-87ab-4686-b62c-cec219de9833",
          "one_time_product": false,
          "price_original": 0,
          "product_id": "9ddb474a-9a93-4a53-aac5-b7e190685371",
          "quantity": 2,
          "variation_id": "710da0c2-87ab-4686-b62c-cec219de9833",
          "variation_info": {
            "bonus_products": [
              {
                "price_original": "50000",
                "quantity": "1",
                "variation_id": "a3f18eca-f4bc-41ff-a616-3f476767a799",
                "variation_info": {
                  "id": "1",
                  "name": "sp1",
                  "product_id": "sp1",
                  "retail_price": "0",
                  "weight": "0"
                }
              }
            ],
            "brand_id": "f0da0fe6-c585-48af-b570-d2767900789d",
            "categories": [
              {
                "id": 1,
                "name": "ffff"
              }
            ],
            "category_ids": [
              1
            ],
            "custom_id": "xinchao",
            "description": null,
            "display_id": 82,
            "display_id_original": null,
            "fields": [
              {
                "id": "c1164d8f-f3fe-431f-8229-8fb26bd5daf5",
                "keyValue": "s",
                "name": "size",
                "value": "s"
              },
              {
                "id": "17eee851-f9f6-4d24-b4da-27bb9eb063df",
                "keyValue": "do",
                "name": "màu",
                "value": "do"
              }
            ],
            "id": 1,
            "ignore_awarded_point": null,
            "inserted_at": "2021-05-26T07:12:14",
            "is_sell_negative": null,
            "limit_quantity_to_warn": 0,
            "manipulation_warehouses": [],
            "name": "xinchao",
            "note_product": "",
            "offline_id": null,
            "product_attributes": [
              {
                "id": "4f0c6fe1-fed7-4d6b-bc5d-4809856c6ac6",
                "keyword": [
                  {
                    "keyValue": "do",
                    "value": "do"
                  },
                  {
                    "keyValue": "vang",
                    "value": "vang"
                  }
                ],
                "name": "màu",
                "values": [
                  "do",
                  "vang"
                ]
              },
              {
                "id": "4861715c-eba9-47ec-be3f-14cc143b4bf5",
                "keyword": [
                  {
                    "keyValue": "s",
                    "value": "s"
                  },
                  {
                    "keyValue": "x",
                    "value": "x"
                  }
                ],
                "name": "size",
                "values": [
                  "s",
                  "x"
                ]
              }
            ],
            "product_id": "xinchao",
            "product_links": [],
            "retail_price": 0,
            "shop_warranty_policy_id": null,
            "supplier_product_ids": [],
            "tags": [
              {
                "id": 2,
                "note": "dan choi 2*"
              }
            ],
            "third_parties": null,
            "warning_by_variation": null,
            "warranty_period": null
          },
          "variations_warehouses": [
            {
              "actual_remain_quantity": 34,
              "adjustments": [
                {
                  "actual_remain_changed": 10,
                  "edited_at": "2021-05-26T08:14:10.517835",
                  "editor": {
                    "fb_id": "1302588949892988",
                    "id": "84616be7-7a6b-4f58-af37-2c64d9ee04a9",
                    "name": "Huỳnh Đăng"
                  },
                  "note": null,
                  "remain_changed": 10,
                  "stocktaking_display_id": null,
                  "total_changed": 10,
                  "warehouse_id": "7442b538-002b-42e3-8520-64425897e2f5",
                  "warehouse_name": "Kho mặc định"
                },
                {
                  "actual_remain_changed": -20,
                  "edited_at": "2021-05-26T07:33:38.055815",
                  "editor": {
                    "fb_id": "1302588949892988",
                    "id": "84616be7-7a6b-4f58-af37-2c64d9ee04a9",
                    "name": "Huỳnh Đăng"
                  },
                  "note": null,
                  "remain_changed": -20,
                  "stocktaking_display_id": null,
                  "total_changed": 0,
                  "warehouse_id": "7442b538-002b-42e3-8520-64425897e2f5",
                  "warehouse_name": "Kho mặc định"
                }
              ],
              "batch_position": "1.A.1",
              "defect_quantity": 0,
              "id": "ae19c130-1a99-4aa8-b53f-0e42b387abe1",
              "pending_quantity": 0,
              "pending_transfer_quantity": 0,
              "quantity_in_batch": 18,
              "remain_quantity": 34,
              "returning_quantity": 0,
              "shelf_position": "1.A.2",
              "shelf_quantity": 0,
              "shipping_quantity": 0,
              "total_quantity": 73,
              "total_quantity_transfer": 0,
              "transfer_quantity": 0,
              "variation_id": "710da0c2-87ab-4686-b62c-cec219de9833",
              "waitting_quantity": 0,
              "warehouse_id": "7442b538-002b-42e3-8520-64425897e2f5"
            }
          ]
        }
      ],
      "brands": [],
      "categories": [],
      "char_name_product": "",
      "creator_id": null,
      "discount_amount": 0,
      "discount_categories": [],
      "end_price_product": 0,
      "id": 11,
      "inserted_at": "2021-10-13T02:22:04",
      "is_active": false,
      "is_free_shipping": false,
      "is_use_percent": false,
      "max_promotion_by_percent": 0,
      "name": "test1",
      "product_tags": [],
      "promotion_percent": 0,
      "quantity_product": 0,
      "quantity_same_product": 8,
      "shop_id": 3,
      "start_price_product": 0,
      "total_orders": 0,
      "updated_at": "2021-10-22T08:57:00"
    }
  ],
  "success": true
}

Query Parameters

Parameter Required Type Default Description
textSearch false string null Từ khóa tìm kiếm

Reponse Parameters

Parameter Type Description
arr_level_promotion array Mức độ khuyến mãi
arr_promotion_products array Sản phẩm khuyến mãi
brands array Thương hiệu
categories array Danh mục
char_name_product string Tên sản phẩm không chứa kí tự
creator_id string Người tạo
discount_amount int Số tiền giảm giá
discount_categories array Danh mục sản phẩm khuyến mãi
end_price_product int Giá lớn nhất sản phẩm khuyến mãi
id int Mã khuyến mãi
inserted_at string Thời điểm tạo
is_active boolean Đã kích hoạt
is_free_shipping boolean Miễn phí vận chuyển
is_use_percent boolean Giảm giá theo phần trăm
max_promotion_by_percent int Phần trăm giảm tối đa
name string Tên khuyến mãi
product_tags array Thẻ sản phẩm
promotion_percent int Phần trăm giảm giá
quantity_product int Số lượng sản phẩm
quantity_same_product int Số lượng cùng loại sản phẩm
shop_id int Mã shop
start_price_product int Giá nhỏ nhất sản phẩm khuyến mãi
total_orders int Tổng số đơn hàng
updated_at string Thời điểm cập nhật

Tạo khuyến mãi

POST /shops/<SHOP_ID>/promotion_products?api_key=<api_key> HTTP/1.1
{
  "promotion_product": {
    "arr_level_promotion": [],
    "arr_promotion_products": [],
    "brands": [],
    "categories": [],
    "char_name_product": "",
    "discount_amount": 600,
    "discount_categories": [],
    "discount_promotion": 0,
    "end_price_product": 500,
    "is_active": true,
    "is_free_shipping": false,
    "is_use_percent": false,
    "max_promotion_by_percent": 0,
    "name": "km_thu2",
    "product_tags": [],
    "promotion_percent": 0,
    "quantity_product": 3,
    "quantity_same_product": 0,
    "start_price_product": 300,
    "total_orders": 1000
  }
}

Cập nhật khuyến mãi

PUT /shops/<SHOP_ID>/promotion_products/<ID>?api_key=<api_key> HTTP/1.1
{
  "promotion_product": {
    "arr_level_promotion": [],
    "arr_promotion_products": [],
    "brands": [],
    "categories": [],
    "char_name_product": "",
    "discount_amount": 600,
    "discount_categories": [],
    "discount_promotion": 0,
    "end_price_product": 500,
    "is_active": true,
    "is_free_shipping": false,
    "is_use_percent": false,
    "max_promotion_by_percent": 0,
    "name": "update_km_thu2",
    "product_tags": [],
    "promotion_percent": 0,
    "quantity_product": 3,
    "quantity_same_product": 0,
    "start_price_product": 300,
    "total_orders": 1000
  }
}

Danh sách khuyến mãi nâng cao

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 Thứ tự trang
page_size false int 10 Số bản ghi hiển thị trong 1 trang
textSearch false string null Từ khóa tìm kiếm

Reponse Parameters

Parameter Type Description
arr_level_promotion array Mức độ khuyến mãi
bonus_items array Sản phẩm tặng thêm
coupon_info json Thông tin phiếu giảm giá
creator_id string Người tạo
customer_tags array Thẻ khách hàng
discount_by_quantity int Số lượng giảm giá
display_id string Mã hiển thị khuyến mãi
end_time string Thời gian kết thúc
group_name string Nhóm khuyến mãi
id string Mã khuyến mãi
inserted_at string Thời điểm tạo
is_activated boolean Đã kích hoạt
is_discount_in_birthday_customer boolean Khuyến mãi cho sinh nhật
is_free_shipping boolean Miễn phí vận chuyển
is_used boolean Đã sử dụng
is_variation boolean Khuyến mãi theo mẫu mã
level_order_prices json Mức khuyến mãi đơn hàng
name string Tên khuyến mãi
order_sources array Nguồn đơn hàng
post_ids array Mã bài viết
priority_level int Mức độ ưu tiên
promo_code_info json Thông tin mã khuyến mãi
discount int Chiết khấu
is_percent boolean Giảm giá theo phần trăm
max_discount_by_percent int Phần trăm giảm tối đa
shop_id int Mã shop
start_time string Thời gian bắt đầu
total_quantity_bonus int Tổng số lượng khuyến mãi
type string Loại khuyến mãi
type_employee string Phân loại nhân viên
updated_at string Thời điểm cập nhật
warehouse_ids array Mã kho hàng

Tạo khuyến mãi nâng cao

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

Request

{
  "promotion_advance": {
    "name": "wert234454",
    "start_time": null,
    "end_time": null,
    "warehouse_ids": [
        "-1"
    ],
    "customer_tags": [],
    "order_sources": [],
    "type_employee": "all",
    "type": "discount_by_product",
    "level_order_prices": [],
    "group_name": "Nhóm 1",
    "is_activated": true,
    "is_variation": true,
    "coupon_info": {
        "discount": 0,
        "is_percent": false
    },
    "promo_code_info": {
        "discount": 0,
        "is_percent": false,
        "max_discount_by_percent": 0
    },
    "items": [],
    "is_free_shipping": false,
    "discount_by_quantity": 0,
    "bonus_items": [],
    "is_discount_in_birthday_customer": false,
    "arr_level_promotion": [],
    "total_quantity_bonus": 0,
    "priority_level": null,
    "isLoadingItem": false,
    "post_ids": []
  }
}

Loại khuyến mãi

Type Description
discount_by_coupon_id Khuyến mãi theo mã
discount_by_product Khuyến mãi theo sản phẩm
fixed_prices Khuyến mãi theo giá cố định
coupon Phiếu giảm giá
double_reward_point Nhân đôi điểm thưởng
discount_by_entire_or_category_product Giảm giá toàn bộ hoặc theo danh mục
discount_by_order_price Giảm giá theo giá trị đơn hàng

Cập nhật khuyến mãi nâng cao

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
      },
      "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": []
  }
}

Combo sản phẩm

Danh sách combo

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": {
            "creator_id": "ad584de3-8c39-4cb8-bdcb-325e40d5b957",
            "product_attributes": [
              {
                "id": "3b3fe83f-cd98-4f1a-80c6-9141e8737cba",
                "name": "Size",
                "values": ["S"]
              },
              {
                "id": "14a9d29a-d1dc-4f02-a705-0df9b068b8a5",
                "name": "Color",
                "values": ["red"]
              }
            ],
            "manipulation_warehouses": [],
            "retail_price": 0,
            "is_sell_negative": null,
            "id": "XXL-yellow",
            "removed": false,
            "category_ids": [
              564
            ],
            "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",
            "fields": [
              {
                "id": "17ca5a3d-3cad-4d49-863a-251aa12e4651",
                "keyValue": "XXL",
                "name": "Size",
                "value": "XXL"
              },
              {
                "id": "c71836c4-a8ac-44e8-8b3f-1b66fada74ac",
                "keyValue": "YELLOW",
                "name": "Color",
                "value": "yellow"
              }
            ],
            "name": "áo phông nam",
            "keyword": null,
            "description": null,
            "brand_id": "a205de96-1d36-443e-9dd8-5f12f1b26909",
            "bonus_products": [
              {
                "images": {
                  "0": "https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/8d678fdb1491c8114c7fedcfc853c82307da2435.jpg"
                },
                "price_original": "0",
                "quantity": "1",
                "variation_id": "29044dcf-2f4c-492f-a0a9-e447b20e21da",
                "variation_info": {
                  "id": "2",
                  "name": "SP N",
                  "product_id": "SP N",
                  "retail_price": "0",
                  "weight": "300"
                }
              }
            ],
            "limit_quantity_to_warn": 0,
            "note_product": "asd",
            "tags": [
              {
                "id": 95,
                "note": "thẻ 3. 2"
              }
            ],
            "updated_at": "2023-11-09T08:53:34",
            "display_id": 11772
          }
        }
      ]
    }
  ],
  "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 Đơn vị tiền tệ
custom_id string Mã tùy chỉnh
discount_amount int Số tiền giảm giá
discount_by_percent int Giảm giá theo phần trăm
end_time unix timestamp Thời gian kết thúc
id string Mã combo
inserted_at unix timestamp Thời điểm tạo
is_free_shipping boolean Miễn phí vận chuyển
is_use_percent boolean Áp dụng giảm giá theo phần trăm
is_value_combo boolean Áp dụng giá trị combo
is_variation boolean Áp dụng cho mẫu mã
max_discount_by_percent int Số tiền tối đa giảm giá theo phần trăm
name string Tên combo
order_sources array Nguồn đơn hàng áp dụng
order_types string Loại đơn hàng áp dụng
start_time unix timestamp Thời gian bắt đầu
updated_at unix timestamp Cập nhật lúc
value_combo int Giá trị combo
bonus_products array Danh sách sản phẩm trong combo

Tính phí vận chuyển

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 Mã tỉnh/thành phố nhận hàng
des_district true string Mã quận/huyện nhận hàng
des_commune true string Mã phường/xã nhận hàng
weight true string Khối lượng
warehouse_id true string Mã kho hàng
shop_id true string Mã shop
quantity true string Số lượng
price_product true string Giá sản phẩm
cod true string Tổng tiền cần thu
service_vtp false string Mã dịch vụ VTP
service_vnpost false string Mã dịch vụ VNPOST
service_best false string Mã dịch vụ BEST
service_ghn false string Mã dịch vụ GHN

Mã dịch vụ VTP

Service code Description
LCOD LCOD - Thương mại điện tử đường bộ
NCOD NCOD - Thương mại điện tử đường bay
VCN VCN Chuyển phát nhanh
VTK VTK Tiết kiệm
V60 V60 Dịch vụ Nhanh 60h
VVT VVT Dịch vụ vận tải
VHT VHT Phát hỏa tốc
PTN PTN Phát trong ngày nội tỉnh
PHT PHT Phát hỏa tốc nội tỉnh
PHS PHS Phát hôm sau nội tỉnh
VBE VBE Tiết kiệm theo hộp
VBS VBS Nhanh theo hộp
SCOD SCOD Giao hàng thu tiền
ECOD ECOD Giao hàng thu tiền tiết kiệm
V20 V20
V25 V25
V30 V30
V35 V35
VCBA VCBA chuyển phát đường bay
VCBO VCBO chuyển phát đường bộ

Mã dịch vụ VNPOST

Service code Description
EMS EMS - Chuyển phát nhanh
BK BK - Chuyển phát thường
ECOD ECOD - Chuyển phát tiết kiệm
BKCOD BKCOD - TMĐT đến 5kg (VP2)
DONG_GIA DONG_GIA - Dịch vụ thỏa thuận riêng giữa khách hàng và VNPost
TMDT_EMS TMĐT-Chuyển phát nhanh EMS
TMDT_BK TMĐT-Chuyển phát tiêu chuẩn
TMDT_EMS_TK TMĐT-Chuyển phát nhanh EMS tiết kiệm (liên vùng)

Mã dịch vụ BEST

Service code Description
12490 Giao hàng nhanh (Express)
12491 Giao hàng tiết kiệm (Eco)

Mã dịch vụ GHN

Service code Description
1 Nhanh
2 Chuẩn
3 Tiết kiệm

Response Parameters

Parameter Type Description
partner_fee int Phí vận chuyển từ ĐVVC
partner_id int Mã ĐVVC
partner_name string Tên đơn vị vận chuyển

Đơn vị vận chuyển

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 Mã ĐVVC
name string Tên ĐVVC

WEBHOOK

Vào giao diện Cấu hình -> Cấu hình ứng dụng
Trong khung WEBHOOK URL bật ứng dụng, cấu hình các thông tin:
- Webhook URL (bắt buộc)
- Email thông báo lỗi
- Request Headers
- Dữ liệu - Đơn hàng(POS), Dữ liệu bảng(CRM), Khách hàng(POS, CRM), Tồn kho(POS)

Webhook

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 Bật/Tắt Webhook
webhook_url string Đường dẫn
webhook_email string Email thông báo lỗi
webhook_types array Dữ liệu Webhook
webhook_partner string Đối tác

Đơn hàng

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,
    "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"
  },
    "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"
    }
  }

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
  }
}

Khách hàng

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,
  "shop_id": 10,
  "type": "customers"
}

Tồn kho

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 SL tồn kho
remain_quantity int Số lượng mẫu mã còn lại
variation_id uid Mã mẫu mã
warehouse_id uid Mã kho hàng
change_quantity int Số lượng thay đổi
is_actual_remain_quantity boolean False: Là hành động thay đổi số lượng hàng có thể bán, True: Là hành động thay đổi số lượng hàng tồn
inserted_at string Thời điểm tạo

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 Mã shop
name string Tên profile
reports_to string Báo cáo cho
is_admin string Admin
can_remove boolean Được phép xóa

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 Nhãn trường
changes.old string Giá trị cũ
changes.new string Giá trị mới
editor_name string Người chỉnh sửa