Pancake POSNhà phát triển
/
llms.txt
VIEN
Khách hàng & khuyến mãi

Khuyến mãi

4 endpoint · https://pos.pages.fm/api/v1

Xem Markdown
Endpoint
GET/shops/{SHOP_ID}/promotion_advanceDanh sách khuyến mãiPOST/shops/{SHOP_ID}/promotion_advanceTạo khuyến mãiPUT/shops/{SHOP_ID}/promotion_advance/{PROMOTION_ID}Cập nhật khuyến mãiPOST/shops/{SHOP_ID}/promotion_advance/delete_multiKích hoạt/Vô hiệu hóa/Xóa khuyến mãi

Danh sách khuyến mãi

GET/shops/{SHOP_ID}/promotion_advance

Lấy danh sách khuyến mãi

Tham số đường dẫn

SHOP_IDintegerbắt buộc

Mã shop

Ví dụ: 4

Tham số truy vấn

pageinteger

Số trang

Mặc định: 1 · Ví dụ: 1
page_sizeinteger

Kích thước trang

Mặc định: 10 · Ví dụ: 10
textSearchstring

Tìm kiếm

Ví dụ: "áo sơ mi"

Phản hồi

object
dataarray<Promotion>

Danh sách khuyến mãi

page_numberinteger

Số trang

page_sizeinteger

Kích thước trang

successboolean

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

total_entriesinteger

Tổng số bản ghi

total_pagesinteger

Tổng số trang

Yêu cầu
curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/promotion_advance?api_key=API_KEY"
Phản hồi 200
{
  "success": true,
  "data": [
    {
      "id": "260a0d45-ba88-457b-8b31-afa3fda0ce0e",
      "display_id": 50,
      "name": "km 345",
      "type": "discount_by_product",
      "start_time": "2022-03-10T05:04:11Z",
      "end_time": "2022-03-11T05:04:13Z",
      "warehouse_ids": [],
      "customer_tags": [],
      "order_sources": [],
      "group_name": "Nhóm 1",
      "is_activated": true,
      "is_variation": true,
      "is_used": null,
      "is_free_shipping": false,
      "is_discount_in_birthday_customer": false,
      "coupon_info": {
        "discount": 0,
        "is_percent": false
      },
      "promo_code_info": {
        "discount": 0,
        "is_percent": false,
        "max_discount_by_percent": 0
      },
      "discount_by_quantity": 1,
      "items": [
        {
          "id": "bd11e48a-6fec-4e3a-a1b7-8ef834a98dae",
          "promotion_advance_id": "260a0d45-ba88-457b-8b31-afa3fda0ce0e",
          "shop_id": 3,
          "product_id": null,
          "variation_id": "2f3aea54-5c0c-44db-9f9b-2c987c298795",
          "category_id": null,
          "product": null,
          "variation": {
            "id": "2f3aea54-5c0c-44db-9f9b-2c987c298795",
            "display_id": "SB21-M-DEN",
            "product_id": "d6d13d0b-320e-4651-a368-de2c9e30ae66",
            "retail_price": 250000,
            "retail_price_after_discount": 238000
          },
          "level_info": [
            {
              "discount": 30000,
              "is_percent": false,
              "from_quantity": 1,
              "to_quantity": 4
            }
          ],
          "fixed_prices": 0,
          "coupon_item_info": {
            "discount": 0,
            "is_percent": false
          },
          "limited_quantity": 0,
          "limited_quantity_used": 0,
          "attachment_product_info": [],
          "discount_info_by_attachment_product": null
        }
      ],
      "bonus_items": [],
      "total_quantity_bonus": 0,
      "arr_level_promotion": [],
      "level_order_prices": [],
      "priority_level": null,
      "type_employee": "all",
      "post_ids": [],
      "shop_id": 3,
      "creator_id": "4eab0efc-2994-4b96-acf0-e4c847668555",
      "inserted_at": "2022-03-10T05:04:33Z",
      "updated_at": "2022-04-08T08:14:58Z"
    }
  ]
}

Tạo khuyến mãi

POST/shops/{SHOP_ID}/promotion_advance

Tham số đường dẫn

SHOP_IDintegerbắt buộc

Mã shop

Ví dụ: 4

Nội dung yêu cầu

Thông tin yêu cầu chứa thông tin khuyến mãi cần tạo

object
promotion_advanceobjectbắt buộc

Phản hồi

object
successboolean

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

Yêu cầu
curl -X POST "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/promotion_advance?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "promotion_advance": {
    "name": "string",
    "type": "discount_by_product"
  }
}'
Phản hồi 200
{
  "success": true
}

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

PUT/shops/{SHOP_ID}/promotion_advance/{PROMOTION_ID}

Tham số đường dẫn

SHOP_IDintegerbắt buộc

Mã shop

Ví dụ: 4
PROMOTION_IDstringbắt buộc

Mã khuyến mãi

Ví dụ: "949f1396-f6fa-45d9-93b6-4c37503a9950"

Nội dung yêu cầu

Thông tin yêu cầu chứa thông tin khuyến mãi cần cập nhật

object
promotion_advancePromotionbắt buộc

Thông tin khuyến mãi

Phản hồi

object
successboolean

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

Yêu cầu
curl -X PUT "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/promotion_advance/{PROMOTION_ID}?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "promotion_advance": {
    "id": "string",
    "display_id": "string",
    "name": "string",
    "type": "string",
    "start_time": "2026-01-01T00:00:00Z",
    "end_time": "2026-01-01T00:00:00Z"
  }
}'
Phản hồi 200
{
  "success": true
}

Kích hoạt/Vô hiệu hóa/Xóa khuyến mãi

POST/shops/{SHOP_ID}/promotion_advance/delete_multi

Kích hoạt, vô hiệu hóa hoặc xóa nhiều khuyến mãi

Tham số đường dẫn

SHOP_IDintegerbắt buộc

Mã shop

Ví dụ: 4

Nội dung yêu cầu

Thông tin yêu cầu chứa danh sách mã khuyến mãi cần xóa

object
idsarray<string>bắt buộc

Danh sách mã khuyến mãi

type_actionstringbắt buộc

Loại hành động

Giá trị"DEACTIVE_PROMOTIONS"Vô hiệu hóa khuyến mãi"ACTIVE_PROMOTIONS"Kích hoạt khuyến mãi"DELETE_PROMOTIONS"Xóa khuyến mãi

Phản hồi

object
successboolean

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

Yêu cầu
curl -X POST "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/promotion_advance/delete_multi?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [
    "0fe988a1-26a5-4772-b4b6-a9c17c9f40cd"
  ],
  "type_action": "DEACTIVE_PROMOTIONS"
}'
Phản hồi 200
{
  "success": true
}