Pancake POSDevelopers
/
llms.txt
VIEN
Products & inventory

Export

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

View Markdown
Endpoints
GET/shops/{SHOP_ID}/exportList of exportsPOST/shops/{SHOP_ID}/exportCreate exportGET/shops/{SHOP_ID}/export/{EXPORT_ID}Get exportPUT/shops/{SHOP_ID}/export/{EXPORT_ID}Update export

List of exports

GET/shops/{SHOP_ID}/export

Get list of exports

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Query parameters

pageinteger

Page number

Default: 1 · Example: 1
page_sizeinteger

Page size

Default: 30 · Example: 30
statusinteger

Status

Values-1All status0New1Completed2Canceled
Default: -1 · Example: -1
typeinteger

Type of export

Values0Normal export1Product defect export
Default: 0 · Example: 0

Responses

object
dataarray<Export>

List of exports

page_numberinteger

Page number

page_sizeinteger

Page size

successboolean

Success status

total_entriesinteger

Total entries

total_pagesinteger

Total pages

Request
curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/export?api_key=API_KEY"
Response 200
{
  "success": true,
  "data": [
    {
      "id": "8095ca3c-a485-4378-9914-5013e1179d55",
      "display_id": 472,
      "status": 0,
      "type": 0,
      "total": 1,
      "total_price": 0,
      "note": "Xuất bán hàng",
      "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
      "supplier_products_id": 400037328,
      "tags": [
        1
      ],
      "export_items": [
        {
          "id": "78dfe47a-a3dd-4d47-8f8b-16eb1ccd69ee",
          "imported_price": 0,
          "quantity": 1,
          "variation_id": "76887a5b-8a27-472c-a15a-661ea59434dd",
          "display_id": 0,
          "inserted_at": "2024-01-25T16:18:20Z"
        }
      ],
      "images": [
        "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"
      ],
      "user_id": "d6e6a545-f102-439e-9943-8ac8369f9735",
      "user": {
        "id": "d6e6a545-f102-439e-9943-8ac8369f9735",
        "name": "vudzung12",
        "fb_id": "1286585024855632",
        "avatar_url": null
      },
      "inserted_at": "2024-01-25T16:18:20Z",
      "updated_at": "2024-01-25T16:18:20Z"
    }
  ]
}

Create export

POST/shops/{SHOP_ID}/export

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Request body

Request body containing export information to create

object
export_listobjectrequired

Responses

object
successboolean

Success status

Request
curl -X POST "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/export?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "export_list": {
    "note": "",
    "supplier_products_id": 169,
    "tags": [
      1
    ],
    "status": 0,
    "type": 0,
    "shop_id": 20,
    "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
    "change_inserted_at": true,
    "inserted_at": 1651683600,
    "images": [
      "https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"
    ],
    "export_items": [
      {
        "id": "13d7ddf6-4cd9-4e1f-a5c1-ac3cd7a7fc17",
        "imported_price": 100000,
        "quantity": 1,
        "variation_id": "29044dcf-2f4c-492f-a0a9-e447b20e21da"
      }
    ]
  }
}'
Response 200
{
  "success": true
}

Get export

GET/shops/{SHOP_ID}/export/{EXPORT_ID}

Get one export by ID or display ID, in the same shape as an item of the export list. Exports in warehouses the caller cannot view are reported as not found.

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4
EXPORT_IDstringrequired

Export ID (UUID) or display ID

Example: "8095ca3c-a485-4378-9914-5013e1179d55"

Responses

object
dataExport

Export information

successboolean

Success status

Request
curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/export/{EXPORT_ID}?api_key=API_KEY"
Response 200
{
  "success": true,
  "data": {
    "id": "8095ca3c-a485-4378-9914-5013e1179d55",
    "display_id": 472,
    "status": 0,
    "type": 0,
    "total": 1,
    "total_price": 0,
    "note": "Xuất bán hàng",
    "warehouse_id": "c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da",
    "supplier_products_id": 400037328,
    "tags": [
      1
    ],
    "export_items": [
      {
        "id": "78dfe47a-a3dd-4d47-8f8b-16eb1ccd69ee",
        "imported_price": 0,
        "quantity": 1,
        "variation_id": "76887a5b-8a27-472c-a15a-661ea59434dd",
        "display_id": 0,
        "inserted_at": "2024-01-25T16:18:20Z"
      }
    ],
    "user_id": "d6e6a545-f102-439e-9943-8ac8369f9735",
    "inserted_at": "2024-01-25T16:18:20Z",
    "updated_at": "2024-01-25T16:18:20Z"
  }
}

Update export

PUT/shops/{SHOP_ID}/export/{EXPORT_ID}

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4
EXPORT_IDstringrequired

Export ID

Example: "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8"

Request body

Request body containing export information to create

object
export_listobjectrequired

Responses

object
successboolean

Success status

Request
curl -X PUT "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/export/{EXPORT_ID}?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "export_list": {
    "images": [
      "https://content.pancake.vn/user-content-dev2.pancake.vn/2022/5/27/ee3be79d1574735ed35539ca48f7f6e9d7137706.jpg"
    ],
    "inserted_at": 1695142800,
    "note": "xuất bán hàng",
    "status": 0,
    "supplier_products_id": 319,
    "tags": [
      1
    ],
    "export_items": [
      {
        "id": "13d7ddf6-4cd9-4e1f-a5c1-ac3cd7a7fc17",
        "imported_price": 1000,
        "quantity": 1,
        "variation_id": "d1e522eb-2f6f-4d22-b8a1-ec25df4a33a4"
      }
    ]
  }
}'
Response 200
{
  "success": true
}