Pancake POSNhà phát triển
/
llms.txt
VIEN
Bán hàng

Thẻ đơn hàng

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

Xem Markdown
Endpoint
GET/shops/{SHOP_ID}/orders/tagsDanh sách thẻ đơn hàngPOST/shops/{SHOP_ID}/orders/tagsTạo thẻ đơn hàngPUT/shops/{SHOP_ID}/orders/tags/{TAG_ID}Cập nhật thẻ đơn hàngGET/shops/{SHOP_ID}/orders/tag_groupsDanh sách nhóm thẻ đơn hàng

Danh sách thẻ đơn hàng

GET/shops/{SHOP_ID}/orders/tags

Lấy danh sách thẻ đơn hàng

Tham số đường dẫn

SHOP_IDintegerbắt buộc

Mã shop

Ví dụ: 4

Phản hồi

object
dataarray<object>

Danh sách thẻ đơn hàng

successboolean

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

Yêu cầu
curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders/tags?api_key=API_KEY"
Phản hồi 200
{
  "data": [
    {
      "id": 75,
      "name": "thẻ 4",
      "color": "#123123",
      "is_system_tag": false,
      "groups": [
        {
          "id": 13,
          "name": "nhom 1"
        },
        {
          "id": 16,
          "name": "nhom 2"
        }
      ]
    },
    {
      "id": 1,
      "name": "Giao không thành",
      "color": "#f04134",
      "is_system_tag": true,
      "groups": [
        {
          "id": -1,
          "name": "Delivery Group"
        },
        {
          "id": 13,
          "name": "nhom 1"
        }
      ]
    },
    {
      "id": 2,
      "name": "Chờ cọc",
      "color": "#096dd9",
      "is_system_tag": true,
      "groups": []
    }
  ],
  "success": true
}

Tạo thẻ đơn hàng

POST/shops/{SHOP_ID}/orders/tags

Tạo mới thẻ đơn hàng

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 thẻ đơn hàng cần tạo

object
namestringbắt buộc

Tên thẻ đơn hàng

tag_colorstring

Mã màu thẻ

groupsarray<integer>

Danh sách mã nhóm thẻ. Lấy từ API GET /shops/{SHOP_ID}/orders/tag_groups

statusesarray<integer>

Danh sách trạng thái đơn hàng áp dụng thẻ

Phản hồi

object
dataobject

Thông tin thẻ đơn hàng đã tạo

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}/orders/tags?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "test 5.1",
  "tag_color": "#000",
  "groups": [
    1
  ],
  "statuses": [
    1,
    2,
    3
  ]
}'
Phản hồi 200
{
  "data": {
    "id": 50,
    "name": "test 5.1",
    "tag_color": "#000",
    "groups": [
      1
    ],
    "statuses": [
      1,
      2,
      3
    ]
  },
  "success": true
}

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

PUT/shops/{SHOP_ID}/orders/tags/{TAG_ID}

Cập nhật thẻ đơn hàng. Chỉ áp dụng cho các thẻ không phải là thẻ hệ thống (is_system_tag = false)

Tham số đường dẫn

SHOP_IDintegerbắt buộc

Mã shop

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

Mã thẻ đơn hàng

Ví dụ: 45

Nội dung yêu cầu

Thông tin yêu cầu chứa thông tin thẻ đơn hàng cần cập nhật

object
namestringbắt buộc

Tên thẻ đơn hàng

tag_colorstring

Mã màu thẻ

groupsarray<integer>

Danh sách mã nhóm thẻ. Lấy từ API GET /shops/{SHOP_ID}/orders/tag_groups

statusesarray<integer>

Danh sách trạng thái đơn hàng áp dụng thẻ

Phản hồi

object
dataobject

Thông tin thẻ đơn hàng đã cập nhật

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}/orders/tags/{TAG_ID}?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "test 4.4",
  "tag_color": "#000",
  "groups": [
    1,
    2
  ],
  "statuses": [
    1,
    2,
    3
  ]
}'
Phản hồi 200
{
  "data": {
    "id": 45,
    "name": "test 4.4",
    "tag_color": "#000",
    "groups": [
      2,
      1
    ],
    "statuses": [
      1,
      2,
      3
    ]
  },
  "success": true
}

Danh sách nhóm thẻ đơn hàng

GET/shops/{SHOP_ID}/orders/tag_groups

Lấy danh sách nhóm thẻ đơn hàng

Tham số đường dẫn

SHOP_IDintegerbắt buộc

Mã shop

Ví dụ: 4

Phản hồi

object
dataarray<object>

Danh sách nhóm thẻ đơn hàng

successboolean

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

Yêu cầu
curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders/tag_groups?api_key=API_KEY"
Phản hồi 200
{
  "data": [
    {
      "id": 1,
      "name": "nhóm 1",
      "add_multiple_tags": true,
      "tags": [
        41,
        50,
        45
      ]
    }
  ],
  "success": true
}