Pancake POSNhà phát triển
/
llms.txt
VIEN
Sản phẩm & kho

Kho hàng

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

Xem Markdown
Endpoint
GET/shops/{SHOP_ID}/warehousesDanh sách kho hàngPOST/shops/{SHOP_ID}/warehousesTạo kho hàngPUT/shops/{SHOP_ID}/warehouses/{WAREHOUSE_ID}Cập nhật kho hàngGET/shops/{SHOP_ID}/inventory_historiesLịch sử xuất nhập kho

Danh sách kho hàng

GET/shops/{SHOP_ID}/warehouses

Lấy danh sách kho hàng

Tham số đường dẫn

SHOP_IDintegerbắt buộc

Mã shop

Ví dụ: 4

Phản hồi

object
dataarray<Warehouse>

Danh sách kho hàng

Yêu cầu
curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/warehouses?api_key=API_KEY"
Phản hồi 200
{
  "data": [
    {
      "id": "b4cb5897-6e56-4581-96cc-2f12677c7bd8",
      "name": "kho test ecod",
      "address": "hâhhha",
      "full_address": "hâhhha, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu",
      "phone_number": "0999999999",
      "province_id": "717",
      "district_id": "71705",
      "commune_id": "7170510",
      "country_code": "84",
      "shop_id": 26290,
      "allow_create_order": true,
      "custom_id": null,
      "affiliate_shop_id": 26290,
      "affiliate_warehouse": "Kho gia dụng"
    },
    {
      "id": "644b0063-e9a8-43cd-ba08-66a8066d462e",
      "name": "kho 2",
      "address": "19/349 Minh Khai , Hai bà Trưng, Hà Nội",
      "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",
      "phone_number": "01655809949",
      "province_id": "101",
      "district_id": "10107",
      "commune_id": "1010735",
      "country_code": "84",
      "shop_id": 26290,
      "allow_create_order": false,
      "custom_id": null
    },
    {
      "id": "3cfcf3ab-dd77-4237-862f-356b3506fe8a",
      "name": "kho địa chỉ mới",
      "address": "34234234",
      "full_address": "34234234, Xã Cao Đức, Bắc Ninh",
      "phone_number": "0989965976",
      "province_id": "84_VN102",
      "district_id": null,
      "commune_id": "84_VN10236",
      "country_code": "84",
      "shop_id": 26290,
      "allow_create_order": true,
      "custom_id": null
    }
  ]
}

Tạo kho hàng

POST/shops/{SHOP_ID}/warehouses

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 kho hàng cần tạo

object
namestringbắt buộc

Tên kho hàng

shelf_configobjectbắt buộc

Cấu hình kệ

addressstring

Địa chỉ chi tiết kho hàng(số nhà, đường, ...)

phone_numberstring

Số điện thoại kho hàng

province_idstring

Mã tỉnh thành phố. Lấy từ API GET /geo/provinces

district_idstring

Mã quận huyện. Lấy từ API GET /geo/districts

commune_idstring

Mã phường xã. Lấy từ API GET /geo/communes

country_codestring

Mã quốc gia

batch_configobject

Cấu hình lô

custom_shelf_configobject

Cấu hình kệ tùy chỉnh

custom_batch_configobject

Cấu hình lô tùy chỉnh

hide_config_batch_shelfboolean

Mở cấu hình lô kệ tùy chỉnh

Phản hồi

WarehouseThông tin kho hàng
idstring

Mã kho hàng

namestring

Tên kho hàng

addressstring

Địa chỉ chi tiết kho hàng(số nhà, đường, ...)

full_addressstring

Địa chỉ đầy đủ kho hàng

phone_numberstring

Số điện thoại kho hàng

province_idstring

Mã tỉnh thành phố. Với kho Việt Nam dùng địa chỉ mới (2 cấp, sau sáp nhập), đây là mã tỉnh mới (vd 84_VN102)

district_idstringcó thể null

Mã quận huyện. Luôn null với kho Việt Nam dùng địa chỉ mới (không còn cấp huyện)

commune_idstringcó thể null

Mã phường xã. Với kho Việt Nam dùng địa chỉ mới, đây là mã phường xã mới (vd 84_VN10236)

country_codestring

Mã quốc gia

shop_idinteger

Mã cửa hàng

allow_create_orderboolean

Kho hàng có thể tạo đơn hàng

custom_idstring

Mã tuỳ chỉnh kho hàng

affiliate_shop_idinteger

Mã cửa hàng liên kết

affiliate_warehousestring

Tên kho hàng liên kết

Yêu cầu
curl -X POST "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/warehouses?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "kho 2",
  "address": "19/349 Minh Khai , Hai bà Trưng, Hà Nội",
  "phone_number": "098765432",
  "province_id": "101",
  "district_id": "10107",
  "commune_id": "1010735",
  "country_code": "84",
  "shelf_config": {
    "col": "3"
  },
  "batch_config": {
    "col": "0",
    "line": "3",
    "row": "3"
  },
  "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"
    }
  },
  "hide_config_batch_shelf": false
}'
Phản hồi 200
{
  "id": "b4cb5897-6e56-4581-96cc-2f12677c7bd8",
  "name": "kho test ecod",
  "address": "hâhhha",
  "full_address": "hâhhha, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu",
  "phone_number": "0999999999",
  "province_id": "717",
  "district_id": "71705",
  "commune_id": "7170510",
  "country_code": "84",
  "shop_id": 26290,
  "allow_create_order": true,
  "custom_id": null
}

Cập nhật kho hàng

PUT/shops/{SHOP_ID}/warehouses/{WAREHOUSE_ID}

Tham số đường dẫn

SHOP_IDintegerbắt buộc

Mã shop

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

Mã kho hàng

Ví dụ: "b4cb5897-6e56-4581-96cc-2f12677c7bd8"

Nội dung yêu cầu

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

object
namestringbắt buộc

Tên kho hàng

shelf_configobjectbắt buộc

Cấu hình kệ

addressstring

Địa chỉ chi tiết kho hàng(số nhà, đường, ...)

phone_numberstring

Số điện thoại kho hàng

province_idstring

Mã tỉnh thành phố. Lấy từ API GET /geo/provinces

district_idstring

Mã quận huyện. Lấy từ API GET /geo/districts

commune_idstring

Mã phường xã. Lấy từ API GET /geo/communes

country_codestring

Mã quốc gia

batch_configobject

Cấu hình lô

custom_shelf_configobject

Cấu hình kệ tùy chỉnh

custom_batch_configobject

Cấu hình lô tùy chỉnh

hide_config_batch_shelfboolean

Mở cấu hình lô kệ tùy chỉnh

Phản hồi

WarehouseThông tin kho hàng
idstring

Mã kho hàng

namestring

Tên kho hàng

addressstring

Địa chỉ chi tiết kho hàng(số nhà, đường, ...)

full_addressstring

Địa chỉ đầy đủ kho hàng

phone_numberstring

Số điện thoại kho hàng

province_idstring

Mã tỉnh thành phố. Với kho Việt Nam dùng địa chỉ mới (2 cấp, sau sáp nhập), đây là mã tỉnh mới (vd 84_VN102)

district_idstringcó thể null

Mã quận huyện. Luôn null với kho Việt Nam dùng địa chỉ mới (không còn cấp huyện)

commune_idstringcó thể null

Mã phường xã. Với kho Việt Nam dùng địa chỉ mới, đây là mã phường xã mới (vd 84_VN10236)

country_codestring

Mã quốc gia

shop_idinteger

Mã cửa hàng

allow_create_orderboolean

Kho hàng có thể tạo đơn hàng

custom_idstring

Mã tuỳ chỉnh kho hàng

affiliate_shop_idinteger

Mã cửa hàng liên kết

affiliate_warehousestring

Tên kho hàng liên kết

Yêu cầu
curl -X PUT "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/warehouses/{WAREHOUSE_ID}?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Kho mặc định",
  "address": "190 La Thành",
  "phone_number": "0366452565",
  "province_id": "101",
  "district_id": "10113",
  "commune_id": "1011309",
  "country_code": "84",
  "shelf_config": {
    "col": "3"
  },
  "batch_config": {
    "col": "0",
    "line": "3",
    "row": "3"
  },
  "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"
    }
  },
  "hide_config_batch_shelf": false
}'
Phản hồi 200
{
  "id": "b4cb5897-6e56-4581-96cc-2f12677c7bd8",
  "name": "kho test ecod",
  "address": "SCB",
  "full_address": "SCB, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu",
  "phone_number": "0999999999",
  "province_id": "717",
  "district_id": "71705",
  "commune_id": "7170510",
  "country_code": "84",
  "shop_id": 26290,
  "allow_create_order": true,
  "custom_id": null
}

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

GET/shops/{SHOP_ID}/inventory_histories

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

Tham số đường dẫn

SHOP_IDintegerbắt buộc

Mã shop

Ví dụ: 4

Tham số truy vấn

pageintegerbắt buộc

Số trang

Mặc định: 1 · Ví dụ: 1
page_sizeintegerbắt buộc

Kích thước trang

Mặc định: 30 · Ví dụ: 30
warehouse_idstring

Mã kho

Ví dụ: "b4cb5897-6e56-4581-96cc-2f12677c7bd8"
variation_ids[]array<string>

Danh sách mã mẫu mã

startDateinteger

Ngày bắt đầu

Ví dụ: 0
endDateinteger

Ngày kết thúc

Ví dụ: 0

Phản hồi

object
dataarray<object>

Danh sách lịch sử xuất nhập kho

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}/inventory_histories?api_key=API_KEY&page=1&page_size=30"
Phản hồi 200
{
  "success": true,
  "data": [
    {
      "avg_price": 1,
      "current_inventory": [
        {
          "actual_remain_quantity": 1,
          "avg_price": 1,
          "id": "b4cb5897-6e56-4581-96cc-2f12677c7bd8",
          "name": "kho test ecod",
          "remain_quantity": 1,
          "total_quantity": 1
        }
      ],
      "editor_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "id": 1,
      "inserted_at": "2024-01-01T00:00:00Z",
      "quantity": 1,
      "ref_display_id": "12345",
      "remain_quantity": 1,
      "table_name": "Purchase",
      "type": "import",
      "variation_now": {
        "barcode": "BARCODE123",
        "display_id": "13109",
        "fields": [
          {
            "id": "field-id-1",
            "keyValue": "Màu",
            "name": "Màu",
            "value": "Trắng"
          }
        ],
        "id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
        "images": [
          "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
        ],
        "is_hidden": true,
        "is_locked": true,
        "is_sell_negative_variation": true,
        "last_imported_price": 1,
        "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
        "retail_price": 1,
        "weight": 1
      },
      "warehouse": {
        "custom_id": null,
        "ffm_id": null,
        "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"
      }
    }
  ]
}