Categories API - Danh sách nhóm thực đơn dạng phẳng

API lấy danh sách nhóm thực đơn trong hệ thống.

Các thông tin cấu hình cần thiết:

Tên Mô tả
CompanyCode Mã nhà hàng lấy
AccessToken Chuỗi token xác thực

Để lấy các thông tin trên xem bài viết account/login

About

URL Phiên bản
[graphapi.cukcuk.vn 1.0

Schemes

Scheme
https

Endpoints

api/v1/categories/list?{?includeInactive=[true|false]}

GET

Lấy danh sách nhóm thực đơn

Expected Response Types
HttpCode ServiceResult.ErrorType Mô tả
401 Chuỗi AccessToken hết hạn hoặc không hợp lệ cần phải gọi cấp phát lại
200 0 Không có lỗi
200 2 Mã nhà hàng không tồn tại
200 7 Thiết lập kết nối CUKCUK đang ở trạng thái ngắt, không thể lấy dữ liệu
200 100 Lỗi nội bộ API Graph
200 102 Request bị từ chối, do có request cùng loại đang xử lý. Vui lòng chờ xử lý xong hoặc chờ request đang xử lý timeout thì gọi lại.
Parameters
Name In Description Required? Type
includeInactive uri true - lấy toàn bộ bao gồm cả nhóm đã ngừng theo dõi false bool
Headers (gửi lên theo header field)
Name In Description Required? Type
Authorization header Header key cấu hình AccessToken (dạng Bearer AccessToken) true string
CompanyCode header Header key cấu hình mã nhà hàng CompanyCode true string

Ví dụ:

CompanyCode: demoquanviet
Authorization: Bearer utFYFHGRrnz-JWVCViIjy4k3CtKWOJDBY6wvL5X_5k9jm14tLIP6qPgCXdupERxyv78hWzSAF_rtK1RRAbtwc-M96sUIzFQ4bSfeY_2xYCzmZBTPNKbohxMHDbR2F4eeNk_dM_7B5Zod8-qGhT7LDwtE_23cuRWeK_qWkYHk2rMiqJM-vd9dYHANtq4OVI-Y8fYZ4B_Q_wPvsZl6svkSNLX2RQygFMOccGsC_G3dv1MbUf2KWjOHcr_SBPH66jQPs8V3CbZ_Eywo7vShkqdenhvNqdNOg9Gl56tybzW4YfcAvmYMUUOEuc7-ffyHfUnE
Content Types Produced
Produces
application/json
Content Types Consumed
Consumes
application/json
Response

Trả về đối tượng ServiceResult với ServiceResult.Data là Array<InventoryItemCategory> nhóm thực đơn

Example

Ví dụ gọi GET tới

https://graphapi.cukcuk.vn/api/v1/categories/list?includeInactive=true

Hệ thống sẽ trả về ServiceResult với Data là Array<InventoryItemCategory> nhóm thức đơn

JSON response

{
  "Code": 200,
  "Data": [
    {
      "Id": "73d8687e-aaf5-4e26-bb15-14d1ef9c6e50",
      "Code": "COMSUAT",
      "Name": "Cơm suất",
      "Description": "Cơm",
      "IsLeaf": false,
      "Grade": 1,
      "Inactive": false
    },
    {
      "Id": "33d35b16-5e5c-47a5-b37b-152ed8e9cd65",
      "Code": "THUCANMAN",
      "Name": "Thức ăn mặn",
      "Description": "Thức ăn mặn",
      "IsLeaf": false,
      "Grade": 1,
      "Inactive": false
    },
    {
      "Id": "4b5d63ef-e8ba-4198-b34f-92979447c3fc",
      "Code": "TRA",
      "Name": "Trà",
      "Description": "Trà",
      "IsLeaf": false,
      "Grade": 1,
      "Inactive": false
    },
    {
      "Id": "8027441b-5ab0-465d-b812-adeba1685ecf",
      "Code": "DOXAO",
      "Name": "Đồ xào",
      "Description": "Đồ xào",
      "IsLeaf": false,
      "Grade": 1,
      "Inactive": false
    },
    {
      "Id": "fcc832b5-7bdc-4dbd-801e-af0a9097b60d",
      "Code": "CANH",
      "Name": "Canh",
      "Description": "Canh",
      "IsLeaf": false,
      "Grade": 1,
      "Inactive": false
    },
    {
      "Id": "dcdd1e90-690d-4ca5-8139-b4406d673c71",
      "Code": "DOUONGDONGCHAI",
      "Name": "Đồ uống đóng chai",
      "Description": "Đồ uống đóng chai",
      "IsLeaf": false,
      "Grade": 1,
      "Inactive": false
    },
    {
      "Id": "859e8661-1145-4dae-ab6b-c47de19b3c1e",
      "Code": "RAU",
      "Name": "Rau",
      "Description": "Rau",
      "IsLeaf": false,
      "Grade": 1,
      "Inactive": false
    },
    {
      "Id": "3ccfe00a-1340-413f-95d2-d99d52a247fc",
      "Code": "MATHANGKHAC_KHAC",
      "Name": "Khác",
      "Description": "Khác",
      "IsLeaf": false,
      "Grade": 1,
      "Inactive": false
    }
  ],
  "Total": 0,
  "Success": true
}

Definitions

InventoryItemCategory Definition

Property Type Format Mô tả
Id string guid Id nhóm thực đơn
Code string Mã nhóm thực đơn
Name string Tên nhóm thực đơn
Description string Ghi chú
Inactive bool True - ngừng kinh doanh, false - đang kinh doanh
IsLeaf bool True - là nhóm con, false - là nhóm cha cấp cao nhất
Grade int Số thứ tự cấp bậc của nhóm(nhóm cấp 1, cấp 2...cấp 9 max)

ServiceResult Definition

Property Type Format Mô tả
Code int Mã lỗi HttpCode (200, 500...)
ErrorType int Loại lỗi
ErrorMessage string Thông tin lỗi
Success bool True - không có lỗi logic xảy ra
Environment string Môi trường triển khai của api
Data string object Dữ liệu trả về client
Total int Tổng số bản ghi khi lấy dữ liệu phân trang

ErrorType Definition

  • Dải mã lỗi chung
HttpCode ServiceResult.ErrorType Mô tả
401 Chuỗi AccessToken hết hạn hoặc không hợp lệ cần phải gọi cấp phát lại
200 0 Không có lỗi
200 1 Tham số không hợp lệ null or empty
200 2 Mã nhà hàng không tồn tại
200 3 Mã Appid không tồn tại trên hệ thống
200 4 Chuỗi thông tin chữ ký đăng nhập không hợp lệ, timeout
200 5 Tham số lấy phân trang vượt quá số lượng cấu hình cho phép (max 100)
200 6 Tham số ngày giờ không hợp lệ (01/01/1753 - 31/12/9999)
200 7 Thiết lập kết nối CUKCUK đang ở trạng thái ngắt, không thể lấy dữ liệu
  • Dải mã lỗi nghiêm trọng
HttpCode ServiceResult.ErrorType Mô tả
200 100 Lỗi nội bộ API Graph
200 102 Request bị từ chối, do có request cùng loại đang xử lý. Vui lòng chờ xử lý xong hoặc chờ request đang xử lý timeout thì gọi lại.
Ví dụ: Khi đang gọi api login mà api chưa trả về dữ liệu lại tiếp tục gọi request login này sẽ trả về lỗi này.