InventoryItems API - Chi tiết món ăn

API lấy thông tin chi tiết món ăn từ id

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/inventoryitems/detail/{inventoryItemId}

GET

Lấy chi tiết món ăn theo id

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
param uri Id món ăn true string
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<InventoryItem> món ăn chi tiết

Example

Ví dụ gọi GET tới

https://graphapi.CUKCUK.vn/api/v1/inventoryitems/detail/f3ad8d97-cc7f-4e1b-8187-06d760ef7d27

Hệ thống sẽ trả về ServiceResult với Data là InventoryItem món ăn chi tiết

JSON response

{
  "Code": 200,
  "Data": {
    "Id": "f3ad8d97-cc7f-4e1b-8187-06d760ef7d27",
    "Children": [],
    "AdditionCategories": [
      {
        "Additions": [
          {
            "AdditionId": "18baca13-67e7-4148-b572-98bab323a07f",
            "Description": "Cốc to",
            "Price": 3000.0,
            "InActive": false
          }
        ]
      }
    ],
    "Code": "TRADA",
    "ItemType": 6,
    "Name": "Trà đá",
    "CategoryID": "4b5d63ef-e8ba-4198-b34f-92979447c3fc",
    "CategoryName": "Trà",
    "Price": 2000.0,
    "Inactive": false,
    "UnitID": "47817d1f-c393-4a4c-af57-0d7fe3f29c5f",
    "UnitName": "Cốc",
    "Description": "",
    "IsSeftPrice": false,
    "AllowAdjustPrice": false
  },
  "Total": 0,
  "Success": true
}

Definitions

InventoryItem Definition

Property Type Format Mô tả
Id string guid Id món ăn
Code string Mã món ăn
Name string Tên món ăn
Children InventoryItem danh sách các món ăn thành phần
AdditionCategories InventoryItemAddtionCategory Danh sách sở thích phục vụ
ItemType int Loại món, xem tại đây
SellingPrice decimal Giá
Price decimal Giá bán
Description string Ghi chú
Inactive bool true - ngừng kinh doanh, false - đang kinh doanh
UnitId string guid Id đơn vị tính
UnitName string Tên đơn vị tính
IsSeftPrice bool Thay đổi theo thời giá
AllowAdjustPrice bool Cho phép điều chỉnh giá bán

ItemType Definition

Giá trị Loại
1 Món ăn
2 Món ăn theo nguyên liệu
3 Món ăn theo nhóm
4 Combo
5 Đồ uống đóng chai
6 Đồ uống pha chế
7 Mặt hàng khác
8 Nguyên vật liệu
10 Đồ uống theo nhóm
12 Combo tùy chọn

InventoryItemInStockInfo Definition

Property Type Format Mô tả
ProductId string guid Id món ăn
ProductCode string Mã món ăn
ProductName string Tên món ăn
BranchId string guid Id chi nhánh tồn
BranchName string Tên chi nhánh tồn
SellingPrice decimal Giá bán
OnHand decimal Số lượng tồn
Ordered decimal Số lượng đặt hàng

InventoryItemAddtionCategory Definition

Property Type Format Mô tả
Id string guid Id nhóm sở thích phục vụ
Name string Tên nhóm sở thích phục vụ
Additions Array<InventoryItemAddition> Danh sách sở thích phục vụ

InventoryItemAddtion Definition

Property Type Format Mô tả
Id string guid Id sở thích phục vụ
Description string Tên sở thích phục vụ
Price decimal Giá bán cộng thêm
InActive bool Ngừng phục vụ

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.