Pancake POS: Multi-channel Sales Management Software

Endpoints

List of orders

GET/shops/{SHOP_ID}/orders

Get list of orders. Get information of specific order

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Query parameters

page_sizeinteger

Page size

Default: 30 · Example: 30

page_numberinteger

Page number

Default: 1 · Example: 1

searchstring

Phone number, name of customer, note, ....

Example: "0999999999"

filter_status[]array<integer>

Order status

include_removedinteger

Include removed orders

Example: 0

updateStatusstring

Filter orders by time

Values"inserted_at"Order creation time"updated_at"Last update time"partner_inserted_at"Time sent to courier"paid_at"Reconciliation time"estimate_delivery_date"Estimate delivery time"picked_up_at"Courier picked up at"first_delivery_at"First delivery at"transfer_proof"Transfer proof"time_assign_seller"Time assign seller"time_assign_care"Time assign care"time_assign_marketer"Time assign marketer"-1"Last status update"0"New"11"Restocking"20"Purchased"1"Confirmed"12"Wait for printing"13"Printed"8"Packaging"9"Waiting for pick up"2"Shipped"3"Received"16"Collected money"4"Returning"15"Partial return"5"Returned

Default: "inserted_at" · Example: "inserted_at"

startDateTimeinteger · int64

Start date (unix timestamp)

Example: 0

endDateTimeinteger · int64

End date (unix timestamp)

Example: 0

option_sortstring

Orders sequence

Values"inserted_at_desc"Order creation time gradually decreases"inserted_at_asc"Order creation time gradually increases"last_updated_order_desc"Last updated order gradually decreases"last_updated_order_asc"Last updated order gradually increases"last_update_status_at_desc"Last update status at gradually decreases"last_update_status_at_asc"Last update status at gradually increases"order_valuation_desc"Order value gradually decreases"order_valuation_asc"Order value gradually increases"product_quantity_desc"Product quantity gradually decreases"product_quantity_asc"Product quantity gradually increases"product_name_desc"Product name gradually decreases"product_name_asc"Product name gradually increases"sub_status_sort_desc"Delivery delay update gradually decreases"sub_status_sort_asc"Delivery delay update gradually increases"first_undeliverable_at_desc"First undeliverable at gradually decreases"first_undeliverable_at_asc"First undeliverable at gradually increases"customer_sort_desc"Customer name gradually decreases"customer_sort_asc"Customer name gradually increases"estimate_delivery_date_desc"Estimate delivery date gradually decreases"estimate_delivery_date_asc"Estimate delivery date gradually increases"order_source_desc"Order source gradually decreases"order_source_asc"Order source gradually increases

Default: "inserted_at_desc" · Example: "inserted_at_desc"

fields[]array<string>

Response fields

partner_id[]array<integer>

Shipping partner ID on Pancake system

shop_partner_accountinteger

Filter by shipping account ID connected to the shop

customer_idstring

Customer ID

order_sources[]array<array<string>>

Order sources. Format: [[order_source_id, account_id], ...] Example: [["-1", "314"], ["-3"]]

is_filter_exclude_sourceboolean

Exclude order source

Default: false

ad_ids[]array<string>

Advertising IDs

project_idsinteger

Project ID

extra_fields[]array<string>

Extra fields

Values"return_rate"Return rate"conversation_note"Conversation note

Responses

object

dataarray<object>

List of orders

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}/orders?api_key=API_KEY"

Response 200

{
  "data": [
    {
      "id": 1418,
      "system_id": 1,
      "shop_id": 4,
      "inserted_at": "2020-05-12T04:51:42",
      "updated_at": "2020-05-12T04:51:54",
      "status": 0,
      "status_name": "new",
      "bill_full_name": "Hoang Anh",
      "bill_phone_number": "0999999999",
      "bill_email": "customer@example.com",
      "conversation_id": "117967746266487_9306266852780716",
      "page_id": "256469571178082",
      "post_id": "185187094667903_477083092110915",
      "ad_id": "23851252560290199",
      "shipping_fee": 0,
      "cod": 0,
      "cash": 0,
      "account": 1,
      "total_discount": 0,
      "note": "",
      "note_print": null,
      "received_at_shop": false,
      "is_free_shipping": false,
      "is_locked": false,
      "creator_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
      "creator": {
        "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
        "fb_id": "2042723249341651",
        "name": "Hoang Anh",
        "avatar_url": null
      },
      "items": [],
      "partner": {
        "partner_id": 1,
        "cod": 0,
        "extend_code": "S58824.MB25.C3.500020713",
        "total_fee": 0,
        "updated_at": "2020-05-12T05:18:16",
        "delivery_name": null,
        "delivery_tel": null,
        "picked_up_at": null,
        "sort_code": null,
        "paid_at": null,
        "system_created": true,
        "partner_status": "request_received",
        "partner_name": "Shopee Xpress",
        "first_delivery_at": null,
        "first_undeliverable_at": "2025-06-30T06:41:44",
        "count_of_delivery": 1,
        "order_number_vtp": null,
        "printed_form": null,
        "extend_update": [
          {
            "key": "status",
            "status": "delivered",
            "tracking_id": "S58824.MB25.C3.500020713",
            "note": "",
            "update_at": "2020-05-12T05:18:16",
            "webhook_params": null
          }
        ]
      },
      "shipping_address": {
        "full_name": "Hoang Anh",
        "phone_number": "0999999999",
        "address": "90 Cầu Giấy",
        "full_address": "90 Cầu Giấy, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
        "province_id": "101",
        "district_id": "10113",
        "commune_id": "1011309"
      },
      "additional_info": {
        "service_partner": "instant"
      },
      "invoice_info_list": [
        {
          "error": "",
          "invoice_detail": {
            "company_address": "85 lê quý đôn, phường nam định, tỉnh Ninh Bình",
            "company_address_breakdown": {
              "company_additional_info": "",
              "company_barangay": "",
              "company_city": "",
              "company_detailed_address": "85 lê quý đôn, phường nam định, tỉnh Ninh Bình",
              "company_district": "Phường Nam Định",
              "company_full_address": "85 lê quý đôn, phường nam định, tỉnh Ninh Bình",
              "company_postcode": "",
              "company_province": "",
              "company_region": "VietNam",
              "company_state": "Ninh Bình",
              "company_town": "Phường Nam Định"
            },
            "company_email": "acb@gmail.com",
            "company_name": "Công ty cổ phần tư vấn xây dựng điện Hoàng Phát",
            "company_tax_id": "0601043840"
          },
          "invoice_type": "company",
          "is_requested": true,
          "order_sn": "251121BVGU6RVE"
        }
      ],
      "reports_by_phone": {
        "+639175706297": {
          "order_fail": 29,
          "order_success": 20,
          "warning": 0
        }
      },
      "p_utm_source": "fb",
      "p_utm_medium": "paid",
      "p_utm_campaign": "120236828168640593",
      "p_utm_term": "120236828168790593",
      "p_utm_content": "120236828168960593",
      "link": "https://www.myfahathai.com/doc?fbclid=IwZXh0bgNhZW0BMABhZGlkAasqwhnoX"
    }
  ],
  "page_number": 1,
  "page_size": 100,
  "success": true,
  "total_entries": 1418,
  "total_pages": 15
}

Create order

POST/shops/{SHOP_ID}/orders

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Request body

Order information to create

object

shop_idintegerrequired

Shop ID

idinteger

Order ID

system_idinteger

System ID

inserted_atstring · date-time

Order creation time

updated_atstring · date-time

Order update time

statusinteger

Order status

Values0New17Waiting for confirmation11Restocking12Wait for printing13Printed20Purchased1Confirmed8Packaging9Waiting for pick up2Shipped3Received16Collected money4Returning15Partial return5Returned6Canceled7Deleted recently

status_namestring

Order status name

bill_full_namestring

Customer name

bill_phone_numberstring

Phone number of customer

bill_emailstring

Customer email

conversation_idstring

Conversation ID

page_idstring

Facebook page ID

Responses

object

idinteger

Order ID

system_idinteger

System ID

shop_idinteger

Shop ID

inserted_atstring · date-time

Order creation time

updated_atstring · date-time

Order update time

statusinteger

Order status

status_namestring

Order status name

bill_full_namestring

Customer name

bill_phone_numberstring

Phone number of customer

bill_emailstring

Customer email

conversation_idstring

Conversation ID

page_idstring

Facebook page ID

Request

curl -X POST "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "is_abandoned_order": true,
  "bill_full_name": "Hoang Anh",
  "bill_phone_number": "0999999999",
  "conversation_id": "117967746266487_9306266852780716",
  "is_free_shipping": false,
  "received_at_shop": false,
  "page_id": "256469571178082",
  "account": 4,
  "account_name": "facebook321",
  "assigning_seller_id": "340644fc-314d-450e-a45f-33343678cab6",
  "items": [
    {
      "discount_each_product": 0,
      "is_bonus_product": false,
      "is_discount_percent": false,
      "is_wholesale": false,
      "one_time_product": false,
      "quantity": 1,
      "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
      "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
      "variation_info": {
        "detail": null,
        "fields": null,
        "display_id": null,
        "name": "aaaaaa",
        "product_display_id": null,
        "retail_price": 100000,
        "weight": 100
      }
    }
  ],
  "note": "",
  "note_print": null,
  "merge_order": false,
  "returned_reason": 1,
  "warehouse_id": "630744ef-4614-4a70-988c-52e6d78c953c",
  "shipping_address": {
    "address": "aaaaa",
    "commune_id": "2210941",
    "country_code": null,
    "district_id": "22109",
    "full_address": "aaaaa, Xã Bắc Lý, Huyện Hiệp Hòa, Bắc Giang",
    "full_name": "hoang anh",
    "phone_number": "0999999999",
    "post_code": null,
    "province_id": "221"
  },
  "shipping_fee": 0,
  "shop_id": 4,
  "total_discount": 0,
  "warehouse_info": {
    "district_id": "10111",
    "full_address": "kakakaka, Phường Khương Trung, Quận Thanh Xuân, Hà Nội",
    "name": "snappy",
    "phone_number": "0999999999",
    "province_id": "101"
  },
  "custom_id": "Ma0001",
  "activated_promotion_advances": [
    {
      "promotion_advance_id": "fb056b32-9cf6-4c5a-92de-0eb94db71121",
      "is_activated": true
    }
  ],
  "invoice_info_list": [
    {
      "invoice_type": "personal",
      "is_requested": true,
      "invoice_detail": {
        "name": "Hoang Anh",
        "phone_number": "0934283743",
        "identity_code": "029374382740",
        "tax_id": "",
        "email": ""
      }
    }
  ],
  "status": 0,
  "cash": 0
}'

Response 200

{
  "id": 1418,
  "system_id": 1,
  "shop_id": 4,
  "inserted_at": "2020-05-12T04:51:42",
  "updated_at": "2020-05-12T04:51:54",
  "status": 0,
  "status_name": "new",
  "bill_full_name": "Hoang Anh",
  "bill_phone_number": "0999999999",
  "bill_email": "customer@example.com",
  "page_id": "256469571178082",
  "post_id": "185187094667903_477083092110915",
  "ad_id": "23851252560290199",
  "shipping_fee": 0,
  "cod": 0,
  "cash": 0,
  "account": 1,
  "total_discount": 0,
  "note": "",
  "note_print": null,
  "received_at_shop": false,
  "is_free_shipping": false,
  "is_locked": false,
  "creator_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
  "creator": {
    "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
    "fb_id": "2042723249341651",
    "name": "Hoang Anh",
    "avatar_url": null
  },
  "items": [],
  "partner": {
    "partner_id": 1,
    "cod": 0,
    "extend_code": "S58824.MB25.C3.500020713",
    "total_fee": 0,
    "updated_at": "2020-05-12T05:18:16"
  },
  "shipping_address": {
    "full_name": "Hoang Anh",
    "phone_number": "0999999999",
    "address": "90 Cầu Giấy",
    "full_address": "90 Cầu Giấy, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
    "province_id": "101",
    "district_id": "10113",
    "commune_id": "1011309"
  }
}

Get order information

GET/shops/{SHOP_ID}/orders/{ORDER_ID}

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

ORDER_IDstringrequired

Order ID

Example: "1418"

Responses

object

idinteger

Order ID

system_idinteger

System ID

shop_idinteger

Shop ID

inserted_atstring · date-time

Order creation time

updated_atstring · date-time

Order update time

statusinteger

Order status

status_namestring

Order status name

bill_full_namestring

Customer name

bill_phone_numberstring

Phone number of customer

bill_emailstring

Customer email

conversation_idstring

Conversation ID

page_idstring

Facebook page ID

Request

curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders/{ORDER_ID}?api_key=API_KEY"

Response 200

{
  "id": 1,
  "system_id": 1,
  "shop_id": 1,
  "inserted_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "status": 1,
  "status_name": "Đã xác nhận",
  "bill_full_name": "Hoang Anh",
  "bill_phone_number": "0999999999",
  "bill_email": "hoang@example.com",
  "page_id": "104438181227821",
  "post_id": "185187094667903_477083092110915",
  "ad_id": "23851252560290199",
  "shipping_fee": 1,
  "partner_fee": 1,
  "fee_marketplace": 1,
  "customer_pay_fee": true,
  "is_free_shipping": true,
  "is_livestream": true,
  "is_live_shopping": true,
  "is_smc": true,
  "received_at_shop": true,
  "total_discount": 1,
  "note": "",
  "note_print": null,
  "returned_reason": 1,
  "returned_reason_name": "Do khách hàng",
  "sub_status": 1,
  "warehouse_id": "b4cb5897-6e56-4581-96cc-2f12677c7bd8",
  "warehouse_info": {
    "name": "kho test ecod",
    "phone_number": "0999999999",
    "full_address": "hâhhha, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu",
    "address": "hâhhha",
    "province_id": "717",
    "district_id": "71705",
    "commune_id": "7170510",
    "affiliate_id": null,
    "ffm_id": null,
    "has_snappy_service": true,
    "custom_id": null
  },
  "creator_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
  "creator": {
    "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
    "fb_id": "2042723249341651",
    "name": "Hoang Anh",
    "avatar_url": null
  },
  "items": [
    {
      "id": 1,
      "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
      "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
      "quantity": 1,
      "returned_count": 1,
      "assigning_seller_id": "340644fc-314d-450e-a45f-33343678cab6",
      "quantity_by_combo_products": [],
      "discount_each_product": 1,
      "is_bonus_product": true,
      "is_discount_percent": true,
      "is_wholesale": true,
      "is_composite": true,
      "one_time_product": true,
      "note": "",
      "note_product": "",
      "inserted_at": "2024-01-01T00:00:00Z",
      "measure_group_id": 1,
      "variation_info": {
        "id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
        "name": "Ao so mi nam",
        "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
        "retail_price": 140000,
        "detail": "",
        "images": [
          "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
        ],
        "fields": [
          {
            "id": "field-id-1",
            "name": "Màu",
            "value": "Trắng",
            "keyValue": "Màu"
          }
        ],
        "barcode": "BARCODE123",
        "brand_id": null,
        "category_ids": [
          1290021044
        ],
        "display_id": "13109",
        "product_display_id": "a131092025",
        "is_upsale_product": true,
        "last_imported_price": 30000,
        "weight": 0,
        "measure_info": {
          "measure_id": 1,
          "exchange_value": 1
        },
        "avg_price": 30000
      },
      "components": [
        {
          "component_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
          "quantity": 1,
          "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7"
        }
      ]
    }
  ],
  "partner": {
    "partner_id": 1,
    "cod": 0,
    "extend_code": "S58824.MB25.C3.500020713",
    "total_fee": 0,
    "updated_at": "2020-05-12T05:18:16",
    "delivery_name": null,
    "delivery_tel": null,
    "picked_up_at": null,
    "sort_code": null,
    "paid_at": null,
    "system_created": true,
    "partner_status": "request_received",
    "partner_name": "Shopee Xpress",
    "first_delivery_at": null,
    "first_undeliverable_at": "2025-06-30T06:41:44",
    "count_of_delivery": 1,
    "order_number_vtp": null,
    "printed_form": null,
    "extend_update": [
      {
        "key": "status",
        "status": "delivered",
        "tracking_id": "S58824.MB25.C3.500020713",
        "note": "",
        "update_at": "2020-05-12T05:18:16"
      }
    ]
  },
  "shipping_address": {
    "full_name": "Hoang Anh",
    "phone_number": "0999999999",
    "address": "90 Cầu Giấy",
    "full_address": "90 Cầu Giấy, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
    "province_id": "101",
    "district_id": "10113",
    "commune_id": "1011309",
    "commnue_name": "Phường Dịch Vọng",
    "district_name": "Quận Cầu Giấy",
    "province_name": "Hà Nội",
    "country_code": "84",
    "post_code": null
  },
  "payment_purchase_histories": [
    {
      "amount": 1800000,
      "type": "cash",
      "inserted_at": "2024-01-01T00:00:00Z",
      "result_code": "00",
      "ipn_reply": true,
      "voucher_amount": 0,
      "tags": [
        "payment"
      ]
    }
  ],
  "tags": [
    {
      "id": 75,
      "name": "thẻ 4"
    }
  ],
  "marketer": {
    "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "name": "Marketer Name",
    "email": "marketer@example.com",
    "phone_number": "0999999999",
    "fb_id": "2042723249341651",
    "avatar_url": null
  },
  "pke_mkter": "cee3c05e-5f85-43c4-b27e-889b99c50097",
  "activated_combo_products": {
    "combo_product_id": 1,
    "quantity_combo_activated": 1
  },
  "activated_promotion_advances": [
    {
      "id": 1,
      "promotion_advance_id": "fb056b32-9cf6-4c5a-92de-0eb94db71121"
    }
  ],
  "tracking_link": "https://tracking.example.com",
  "payment_link": "https://payment.example.com",
  "ads_source": null,
  "shopify_order_id": null,
  "shopify_abandon_checkout_id": 1,
  "is_abandoned_order": true,
  "cod": 0,
  "cash": 0,
  "account": 1,
  "account_name": "facebook321",
  "advanced_platform_fee": {
    "ads_top_up": 1,
    "affiliate_commission": 1,
    "diff_shipping_fee": 1,
    "marketplace_voucher": 1,
    "payment_fee": 1,
    "platform_commission": 1,
    "seller_transaction_fee": 1,
    "service_fee": 1,
    "sfp_service_fee": 1
  },
  "printing_count": 1,
  "marketplace_id": "-3",
  "money_to_collect": 1,
  "total_price": 1,
  "shop_customer_address_id": "0fefd213-7d0c-4d5b-bdbf-35694da80857",
  "customer": {
    "fb_id": null,
    "id": "96a8e283-3fba-492e-a35a-970f72a30a02",
    "name": "Trần Văn Hoàng",
    "page_id": "104438181227821"
  },
  "total_quantity": 1,
  "time_assign_marketer": "2024-01-01T00:00:00Z",
  "status_history": [
    {
      "avatar_url": null,
      "editor_fb": "2042723249341651",
      "editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
      "name": "Hoang Anh",
      "old_status": 0,
      "status": 1,
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "duplicated_phone": true,
  "order_currency": "VND",
  "charged_by_vnpay": 1,
  "charged_by_qrpay": 1,
  "custom_id": null,
  "last_editor": {
    "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
    "fb_id": "2042723249341651",
    "name": "Hoang Anh",
    "email": "hoang@example.com",
    "avatar_url": null,
    "phone_number": "0999999999"
  },
  "last_editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
  "charged_by_momo": 1,
  "bank_transfer_images": [
    "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
  ],
  "transfer_money": 1,
  "transfer_proofs": [
    {
      "id": 1,
      "order_id": 1,
      "shop_id": 1,
      "payment_id": "64e130e4-012a-45b1-bd88-51811f23ead8",
      "amount": 1,
      "images": [
        "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
      ],
      "note": null,
      "is_income": true,
      "is_verify": true,
      "verify_at": "2024-01-01T00:00:00Z",
      "verifier": {
        "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
        "fb_id": "2042723249341651",
        "name": "Hoang Anh",
        "avatar_url": null
      },
      "creator": {
        "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
        "fb_id": "2042723249341651",
        "name": "Hoang Anh",
        "avatar_url": null
      },
      "last_editor": {
        "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
        "fb_id": "2042723249341651",
        "name": "Hoang Anh",
        "avatar_url": null
      },
      "order_info": null,
      "inserted_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "lock_order_by_user": null,
  "assigning_care": {
    "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "fb_id": "2042723249341651",
    "name": "Care Name",
    "email": "care@example.com",
    "avatar_url": null,
    "phone_number": "0999999999"
  },
  "assigning_care_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
  "time_assign_care": "2024-01-01T00:00:00Z",
  "assigning_seller": {
    "id": "340644fc-314d-450e-a45f-33343678cab6",
    "fb_id": "2042723249341651",
    "name": "Seller Name",
    "email": "seller@example.com",
    "avatar_url": null,
    "phone_number": "0999999999"
  },
  "einvoices": [],
  "charged_by_card": 1,
  "estimate_delivery_date": "2024-01-01T00:00:00Z",
  "order_sources": "-1",
  "charged_by_fundiin": 1,
  "surcharge": 1,
  "is_linked_partner": true,
  "call_laters": [],
  "last_update_status_at": "2024-01-01T00:00:00Z",
  "discount_by_customer_level": 1,
  "viewing": [],
  "order_returned_ids": null,
  "cost_surcharge": 1,
  "time_send_partner": "2024-01-01T00:00:00Z",
  "charged_by_kredivo": 1,
  "discount": 1,
  "histories": [],
  "duplicated_customer": true,
  "tax": 1,
  "is_from_ecommerce": true,
  "note_image": [
    "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
  ],
  "shopify_draft_order_id": null,
  "display_id": 1,
  "shop_partner_id": 1,
  "is_locked": true,
  "additional_info": {
    "service_partner": "instant"
  },
  "invoice_info_list": [
    {
      "error": "",
      "invoice_detail": {
        "company_address": "85 lê quý đôn, phường nam định, tỉnh Ninh Bình",
        "company_address_breakdown": {
          "company_additional_info": "",
          "company_barangay": "",
          "company_city": "",
          "company_detailed_address": "85 lê quý đôn, phường nam định, tỉnh Ninh Bình",
          "company_district": "Phường Nam Định",
          "company_full_address": "85 lê quý đôn, phường nam định, tỉnh Ninh Bình",
          "company_postcode": "",
          "company_province": "",
          "company_region": "VietNam",
          "company_state": "Ninh Bình",
          "company_town": "Phường Nam Định",
          "company_email": "acb@gmail.com",
          "company_name": "Công ty cổ phần tư vấn xây dựng điện Hoàng Phát",
          "company_tax_id": "0601043840"
        }
      },
      "invoice_type": "company",
      "is_requested": true,
      "order_sn": "251121BVGU6RVE"
    }
  ],
  "reports_by_phone": {
    "+639175706297": {
      "order_fail": 29,
      "order_success": 20,
      "warning": 0
    }
  },
  "p_utm_source": "fb",
  "p_utm_medium": "paid",
  "p_utm_campaign": "120236828168640593",
  "p_utm_term": "120236828168790593",
  "p_utm_content": "120236828168960593",
  "link": "https://www.myfahathai.com/doc?fbclid=IwZXh0bgNhZW0BMABhZGlkAasqwhnoX"
}

Update order

PUT/shops/{SHOP_ID}/orders/{ORDER_ID}

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

ORDER_IDstringrequired

Order ID

Example: "1418"

Request body

Order information to update

object

idinteger

Order ID

system_idinteger

System ID

shop_idinteger

Shop ID

inserted_atstring · date-time

Order creation time

updated_atstring · date-time

Order update time

statusinteger

Order status

status_namestring

Order status name

bill_full_namestring

Customer name

bill_phone_numberstring

Phone number of customer

bill_emailstring

Customer email

conversation_idstring

Conversation ID

page_idstring

Facebook page ID

Responses

object

idinteger

Order ID

system_idinteger

System ID

shop_idinteger

Shop ID

inserted_atstring · date-time

Order creation time

updated_atstring · date-time

Order update time

statusinteger

Order status

status_namestring

Order status name

bill_full_namestring

Customer name

bill_phone_numberstring

Phone number of customer

bill_emailstring

Customer email

conversation_idstring

Conversation ID

page_idstring

Facebook page ID

Request

curl -X PUT "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders/{ORDER_ID}?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "is_abandoned_order": true,
  "bill_full_name": "Hoang Anh",
  "bill_phone_number": "0999999999",
  "partner": {
    "partner_id": 1,
    "extend_code": "S58824.MB25.C3.500020713",
    "count_of_delivery": 2
  },
  "is_free_shipping": false,
  "received_at_shop": false,
  "page_id": "256469571178082",
  "account": 4,
  "account_name": "facebook321",
  "assigning_seller_id": "340644fc-314d-450e-a45f-33343678cab6",
  "items": [
    {
      "discount_each_product": 0,
      "is_bonus_product": false,
      "is_discount_percent": false,
      "is_wholesale": false,
      "one_time_product": false,
      "quantity": 1,
      "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
      "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
      "variation_info": {
        "detail": null,
        "fields": null,
        "display_id": null,
        "name": "aaaaaa",
        "product_display_id": null,
        "is_upsale_product": true,
        "retail_price": 100000,
        "weight": 100
      }
    }
  ],
  "note": "",
  "note_print": null,
  "returned_reason": 1,
  "warehouse_id": "630744ef-4614-4a70-988c-52e6d78c953c",
  "shipping_address": {
    "address": "aaaaa",
    "commune_id": "2210941",
    "country_code": null,
    "district_id": "22109",
    "full_address": "aaaaa, Xã Bắc Lý, Huyện Hiệp Hòa, Bắc Giang",
    "full_name": "hoang anh",
    "phone_number": "0999999999",
    "post_code": null,
    "province_id": "221"
  },
  "shipping_fee": 0,
  "shop_id": 4,
  "total_discount": 0,
  "warehouse_info": {
    "district_id": "10111",
    "full_address": "kakakaka, Phường Khương Trung, Quận Thanh Xuân, Hà Nội",
    "name": "snappy",
    "phone_number": "0999999999",
    "province_id": "101"
  },
  "custom_id": "Ma0001",
  "activated_promotion_advances": [
    {
      "promotion_advance_id": "fb056b32-9cf6-4c5a-92de-0eb94db71121",
      "is_activated": true
    }
  ],
  "invoice_info_list": [
    {
      "invoice_type": "personal",
      "is_requested": true,
      "invoice_detail": {
        "name": "Hoang Anh",
        "phone_number": "0934283743",
        "identity_code": "029374382740",
        "tax_id": "",
        "email": ""
      }
    }
  ],
  "status": 0,
  "cash": 0
}'

Response 200

{
  "id": 1,
  "system_id": 1,
  "shop_id": 1,
  "inserted_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "status": 1,
  "status_name": "Đã xác nhận",
  "bill_full_name": "Hoang Anh",
  "bill_phone_number": "0999999999",
  "bill_email": "hoang@example.com",
  "page_id": "104438181227821",
  "post_id": "185187094667903_477083092110915",
  "ad_id": "23851252560290199",
  "shipping_fee": 1,
  "partner_fee": 1,
  "fee_marketplace": 1,
  "customer_pay_fee": true,
  "is_free_shipping": true,
  "is_livestream": true,
  "is_live_shopping": true,
  "is_smc": true,
  "received_at_shop": true,
  "total_discount": 1,
  "note": "",
  "note_print": null,
  "returned_reason": 1,
  "returned_reason_name": "Do khách hàng",
  "sub_status": 1,
  "warehouse_id": "b4cb5897-6e56-4581-96cc-2f12677c7bd8",
  "warehouse_info": {
    "name": "kho test ecod",
    "phone_number": "0999999999",
    "full_address": "hâhhha, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu",
    "address": "hâhhha",
    "province_id": "717",
    "district_id": "71705",
    "commune_id": "7170510",
    "affiliate_id": null,
    "ffm_id": null,
    "has_snappy_service": true,
    "custom_id": null
  },
  "creator_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
  "creator": {
    "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
    "fb_id": "2042723249341651",
    "name": "Hoang Anh",
    "avatar_url": null
  },
  "items": [
    {
      "id": 1,
      "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
      "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
      "quantity": 1,
      "returned_count": 1,
      "assigning_seller_id": "340644fc-314d-450e-a45f-33343678cab6",
      "quantity_by_combo_products": [],
      "discount_each_product": 1,
      "is_bonus_product": true,
      "is_discount_percent": true,
      "is_wholesale": true,
      "is_composite": true,
      "one_time_product": true,
      "note": "",
      "note_product": "",
      "inserted_at": "2024-01-01T00:00:00Z",
      "measure_group_id": 1,
      "variation_info": {
        "id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
        "name": "Ao so mi nam",
        "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
        "retail_price": 140000,
        "detail": "",
        "images": [
          "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
        ],
        "fields": [
          {
            "id": "field-id-1",
            "name": "Màu",
            "value": "Trắng",
            "keyValue": "Màu"
          }
        ],
        "barcode": "BARCODE123",
        "brand_id": null,
        "category_ids": [
          1290021044
        ],
        "display_id": "13109",
        "product_display_id": "a131092025",
        "is_upsale_product": true,
        "last_imported_price": 30000,
        "weight": 0,
        "measure_info": {
          "measure_id": 1,
          "exchange_value": 1
        },
        "avg_price": 30000
      },
      "components": [
        {
          "component_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
          "quantity": 1,
          "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7"
        }
      ]
    }
  ],
  "partner": {
    "partner_id": 1,
    "cod": 0,
    "extend_code": "S58824.MB25.C3.500020713",
    "total_fee": 0,
    "updated_at": "2020-05-12T05:18:16",
    "delivery_name": null,
    "delivery_tel": null,
    "picked_up_at": null,
    "sort_code": null,
    "paid_at": null,
    "system_created": true,
    "extend_update": [
      {
        "key": "status",
        "status": "delivered",
        "tracking_id": "S58824.MB25.C3.500020713",
        "note": "",
        "update_at": "2020-05-12T05:18:16"
      }
    ]
  },
  "shipping_address": {
    "full_name": "Hoang Anh",
    "phone_number": "0999999999",
    "address": "90 Cầu Giấy",
    "full_address": "90 Cầu Giấy, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
    "province_id": "101",
    "district_id": "10113",
    "commune_id": "1011309",
    "commnue_name": "Phường Dịch Vọng",
    "district_name": "Quận Cầu Giấy",
    "province_name": "Hà Nội",
    "country_code": "84",
    "post_code": null
  },
  "payment_purchase_histories": [
    {
      "amount": 1800000,
      "type": "cash",
      "inserted_at": "2024-01-01T00:00:00Z",
      "result_code": "00",
      "ipn_reply": true,
      "voucher_amount": 0,
      "tags": [
        "payment"
      ]
    }
  ],
  "tags": [
    {
      "id": 75,
      "name": "thẻ 4"
    }
  ],
  "marketer": {
    "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "name": "Marketer Name",
    "email": "marketer@example.com",
    "phone_number": "0999999999",
    "fb_id": "2042723249341651",
    "avatar_url": null
  },
  "pke_mkter": "cee3c05e-5f85-43c4-b27e-889b99c50097",
  "activated_combo_products": {
    "combo_product_id": 1,
    "quantity_combo_activated": 1
  },
  "activated_promotion_advances": [
    {
      "id": 1,
      "promotion_advance_id": "fb056b32-9cf6-4c5a-92de-0eb94db71121"
    }
  ],
  "tracking_link": "https://tracking.example.com",
  "payment_link": "https://payment.example.com",
  "ads_source": null,
  "shopify_order_id": null,
  "shopify_abandon_checkout_id": 1,
  "is_abandoned_order": true,
  "cod": 0,
  "cash": 0,
  "account": 1,
  "account_name": "facebook321",
  "advanced_platform_fee": {
    "ads_top_up": 1,
    "affiliate_commission": 1,
    "diff_shipping_fee": 1,
    "marketplace_voucher": 1,
    "payment_fee": 1,
    "platform_commission": 1,
    "seller_transaction_fee": 1,
    "service_fee": 1,
    "sfp_service_fee": 1
  },
  "printing_count": 1,
  "money_to_collect": 1,
  "total_price": 1,
  "shop_customer_address_id": "0fefd213-7d0c-4d5b-bdbf-35694da80857",
  "customer": {
    "fb_id": null,
    "id": "96a8e283-3fba-492e-a35a-970f72a30a02",
    "name": "Trần Văn Hoàng",
    "page_id": "104438181227821"
  },
  "total_quantity": 1,
  "time_assign_marketer": "2024-01-01T00:00:00Z",
  "status_history": [
    {
      "avatar_url": null,
      "editor_fb": "2042723249341651",
      "editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
      "name": "Hoang Anh",
      "old_status": 0,
      "status": 1,
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "duplicated_phone": true,
  "order_currency": "VND",
  "charged_by_vnpay": 1,
  "charged_by_qrpay": 1,
  "custom_id": null,
  "last_editor": {
    "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
    "fb_id": "2042723249341651",
    "name": "Hoang Anh",
    "email": "hoang@example.com",
    "avatar_url": null,
    "phone_number": "0999999999"
  },
  "last_editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
  "charged_by_momo": 1,
  "bank_transfer_images": [
    "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
  ],
  "transfer_money": 1,
  "lock_order_by_user": null,
  "assigning_care": {
    "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "fb_id": "2042723249341651",
    "name": "Care Name",
    "email": "care@example.com",
    "avatar_url": null,
    "phone_number": "0999999999"
  },
  "assigning_care_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
  "time_assign_care": "2024-01-01T00:00:00Z",
  "assigning_seller": {
    "id": "340644fc-314d-450e-a45f-33343678cab6",
    "fb_id": "2042723249341651",
    "name": "Seller Name",
    "email": "seller@example.com",
    "avatar_url": null,
    "phone_number": "0999999999"
  },
  "einvoices": [],
  "charged_by_card": 1,
  "estimate_delivery_date": "2024-01-01T00:00:00Z",
  "order_sources": "-1",
  "charged_by_fundiin": 1,
  "surcharge": 1,
  "is_linked_partner": true,
  "call_laters": [],
  "last_update_status_at": "2024-01-01T00:00:00Z",
  "discount_by_customer_level": 1,
  "viewing": [],
  "order_returned_ids": null,
  "cost_surcharge": 1,
  "time_send_partner": "2024-01-01T00:00:00Z",
  "charged_by_kredivo": 1,
  "discount": 1,
  "histories": [],
  "duplicated_customer": true,
  "tax": 1,
  "is_from_ecommerce": true,
  "note_image": [
    "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
  ],
  "shopify_draft_order_id": null,
  "display_id": 1,
  "shop_partner_id": 1,
  "is_locked": true
}

Get order conversation messages

GET/shops/{SHOP_ID}/orders/{ORDER_ID}/messages

Resolves the conversation associated with the order and returns messages from the entire conversation. Messages in each response are ordered chronologically (oldest to newest).

Pagination follows the Pancake web application semantics:

Omit current_count or set it to 0 to load up to 25 of the newest records, rendered in chronological order.
To load older records, set current_count to the total number of messages already loaded. After the first response use 25; if the next response contains 30 messages, use 55, and continue in the same way.
Calls with a positive current_count return up to 30 older messages.

A valid order without an associated conversation returns {"success":true,"data":[]}.

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

ORDER_IDstringrequired

Order ID

Example: "SOICUN-12943-02"

Query parameters

current_countinteger

Number of messages already loaded. This is an offset count, not a cursor.

Default: 0 · Example: 25

fields[]array<string>

Top-level message fields to include in each item. Repeat the query parameter for multiple fields, for example fields[]=id&fields[]=message. Omit it to return all fields.

Responses

any

Request

curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders/{ORDER_ID}/messages?api_key=API_KEY"

Response 200

{
  "success": true,
  "data": [
    {
      "id": "m_hULhobwR0nAa0NzuQaVc3O",
      "type": "INBOX",
      "message": "<div>Xin chào, shop còn size M không?</div>",
      "original_message": "Xin chào, shop còn size M không?",
      "message_tags": [],
      "from": {
        "id": "9306266852780716",
        "name": "Nguyễn Văn A"
      },
      "seen": true,
      "can_like": false,
      "user_likes": false,
      "like_count": null,
      "can_comment": false,
      "comment_count": null,
      "can_remove": false,
      "is_removed": false,
      "is_hidden": false,
      "can_hide": false,
      "can_reply_privately": false,
      "private_reply_conversation": null,
      "attachments": [],
      "has_phone": false,
      "phone_info": [],
      "is_parent": false,
      "inserted_at": "2026-06-25T02:00:38.675576",
      "page_id": "117967746266487",
      "show_info": true,
      "parent_id": null,
      "is_parent_hidden": false,
      "edit_history": null,
      "removed_by": null,
      "rich_message": null,
      "conversation_id": "117967746266487_9306266852780716",
      "is_livestream_order": null
    }
  ]
}

Print order as PDF

GET/shops/{SHOP_ID}/orders/{ORDER_ID}/print

Fills one of the shop's print templates with the order data and returns a PDF, as when printing the order from POS web.

When label_id is omitted, the template is chosen in this order: the Print template by courier of the order's courier, the shop's default template, then the shop's first template. Shops without templates use the system template. The Print order twice and Attached print template settings of the chosen template also apply.

The page size follows the template's paper size. Roll paper (K80, K58...) returns one page whose height fits the content.
Printing through this endpoint does not increase the order's printing count.
Not supported yet: CRM variables, draft e-invoice data, order tracking and invoice request links, component items of composite products, templates by order source or for returned orders, and printed forms provided by the courier.

The PDF can differ slightly from printing in a browser: fonts that only exist on the user's computer (Segoe UI, Tahoma, Verdana...) are replaced, and templates whose content is longer or wider than the paper can break pages differently. Images are downloaded by the server: images on non-public hosts, larger than 5 MB, slower than 5 seconds, beyond 15 MB in total, beyond the first 30 image URLs of the document, or repeated beyond 20 MB of embedded image data are left blank. Only images in <img> (src/srcset) and CSS url() are downloaded; other external resources (<link> stylesheets, @import, SVG <image href>, background attributes) are not loaded.

Errors are returned as JSON. For the 404 order and print template errors and the 503 error, the message follows the shop's language.

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

ORDER_IDstringrequired

Order ID, system ID or custom order ID

Example: "1418"

Query parameters

label_idinteger

ID of the shop's print template. Omit it to choose the template automatically.

Example: 922009896

Responses

ErrorResponseBusiness or request error response

successbooleanrequired

Success status

Valuesfalse

messagestring

Human-readable error message

errorstring

Stable machine-readable error name, when provided

error_codeinteger

Machine-readable error code, when provided

message_codeinteger

POS business message code, when provided

permissionstring

Required permission, when access is denied

Request

curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders/{ORDER_ID}/print?api_key=API_KEY"

Response 200

{
  "success": false,
  "message": "Missing access_token",
  "error_code": 101
}

List of order sources

GET/shops/{SHOP_ID}/order_source

Get list of order sources

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Responses

object

dataarray<object>

List of order sources

successboolean

Success status

Request

curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/order_source?api_key=API_KEY"

Response 200

{
  "data": [
    {
      "id": -3,
      "inserted_at": "2020-06-10T11:50:07",
      "name": "Shopee",
      "shop_id": 7,
      "updated_at": "2020-06-10T11:50:07"
    },
    {
      "id": 4,
      "inserted_at": "2020-06-17T08:41:54",
      "name": "40999897",
      "parent_id": -3,
      "shop_id": 7,
      "updated_at": "2020-06-17T08:41:54"
    },
    {
      "id": "1471242102982974",
      "inserted_at": "2021-04-22T08:33:15",
      "name": "Pancake.vn",
      "parent_id": -1,
      "shop_id": 20,
      "updated_at": "2024-04-08T03:11:25"
    },
    {
      "id": "987654",
      "inserted_at": "2024-05-01T08:00:00",
      "link": "https://landing.example.com/source-abc",
      "name": "Landing ABC",
      "parent_id": -7,
      "shop_id": 20,
      "updated_at": "2024-05-01T08:00:00"
    }
  ],
  "success": true
}

Get link print label

POST/shops/{SHOP_ID}/products/get_logistics_shipping_document

Get link to print shipping label and packing slips

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Query parameters

document_typestring

Document type

Values"SL_PL"Shipping label + Packing slips"SHIPPING_LABEL"Shipping label"PICK_LIST"Packing slips

Example: "SL_PL"

Request body

Request body containing list of order IDs to print labels

object

paramsarray<object>required

List of order IDs

Responses

object

dataarray<string · uri>

List of print label URLs

successboolean

Success status

Request

curl -X POST "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/products/get_logistics_shipping_document?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "params": [
    {
      "order_id": "576551803772635228"
    }
  ]
}'

Response 200

{
  "data": [
    "https://content.pancake.vn/2-25/2025/3/28/071edc2cc6c728f6c3fa493a2cb033e8f61fb11e.071edc2cc6c728f6c3fa493a2cb033e8f61fb11e"
  ],
  "success": true
}

Get order confirm link

POST/shops/{SHOP_ID}/orders/get_tracking_url

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Request body

Request body containing system ID to get tracking URL

object

system_idintegerrequired

System ID

Responses

object

urlstring · uri

Order confirm link

successboolean

Success status

Request

curl -X POST "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders/get_tracking_url?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "system_id": 862
}'

Response 200

{
  "url": "https://pke.gg/99gjy3r",
  "success": true
}

Prepare order shipment

POST/shops/{SHOP_ID}/orders/arrange_shipment

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Request body

Request body containing order IDs to prepare shipment

object

order_idstringrequired

Order ID

pickup_shiftstring

Pickup shift. Required for Shopee platform.

Values"closest"closest"farthest"farthest

Example: "closest"

pickup_methodstring

Pickup method. Required for Shopee and TikTok platforms.

Values"pick_up"ĐVVC lấy hàng"drop_off"Mang hàng ra bưu cục

Example: "pick_up"

Responses

object

messagestring

Response message

successboolean

Success status

Request

curl -X POST "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders/arrange_shipment?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "order_id": "34123423498237",
  "pickup_shift": "closest",
  "pickup_method": "pick_up"
}'

Response 200

{
  "message": "Arrange shipment successfully",
  "success": true
}

List of advanced promotions of order

POST/shops/{SHOP_ID}/orders/get_promotion_advance_active

Get list of advanced promotions that can be applied to an order

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Request body

Request body containing order information (existing order ID or new order details) to get active promotions

any

Responses

object

idinteger

Order ID

system_idinteger

System ID

shop_idinteger

Shop ID

inserted_atstring · date-time

Order creation time

updated_atstring · date-time

Order update time

statusinteger

Order status

status_namestring

Order status name

bill_full_namestring

Customer name

bill_phone_numberstring

Phone number of customer

bill_emailstring

Customer email

conversation_idstring

Conversation ID

page_idstring

Facebook page ID

Request

curl -X POST "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders/get_promotion_advance_active?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d 'null'

Response 200

{
  "id": 1418,
  "system_id": 1,
  "shop_id": 4,
  "inserted_at": "2020-05-12T04:51:42",
  "updated_at": "2020-05-12T04:51:54",
  "status": 0,
  "status_name": "new",
  "bill_full_name": "Hoang Anh",
  "bill_phone_number": "0999999999",
  "bill_email": "customer@example.com",
  "page_id": "256469571178082",
  "post_id": "185187094667903_477083092110915",
  "ad_id": "23851252560290199",
  "shipping_fee": 0,
  "cod": 0,
  "cash": 0,
  "account": 1,
  "total_discount": 0,
  "note": "",
  "note_print": null,
  "received_at_shop": false,
  "is_free_shipping": false,
  "is_locked": false,
  "creator_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
  "creator": {
    "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
    "fb_id": "2042723249341651",
    "name": "Hoang Anh",
    "avatar_url": null
  },
  "items": [],
  "partner": {
    "partner_id": 1,
    "cod": 0,
    "extend_code": "S58824.MB25.C3.500020713",
    "total_fee": 0,
    "updated_at": "2020-05-12T05:18:16"
  },
  "shipping_address": {
    "full_name": "Hoang Anh",
    "phone_number": "0999999999",
    "address": "90 Cầu Giấy",
    "full_address": "90 Cầu Giấy, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
    "province_id": "101",
    "district_id": "10113",
    "commune_id": "1011309"
  }
}

List of payment methods

GET/shops/{SHOP_ID}/bank_payments

Get list of payment methods

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Responses

object

dataarray<object>

List of payment methods

successboolean

Success status

Request

curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/bank_payments?api_key=API_KEY"

Response 200

{
  "data": [
    {
      "id": "e01fed02-8680-4102-bdf4-343a7e1a00f5",
      "creator_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "name": "Tiền cọc",
      "shop_id": 224,
      "inserted_at": "2025-08-19T02:25:37",
      "updated_at": "2025-08-19T02:25:37"
    }
  ],
  "success": true
}

List of return orders

GET/shops/{SHOP_ID}/orders_returned

Get list of return orders

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

Order status

Default: -1 · Example: -1

update_statusstring

Filter orders by time

Values"inserted_at"Order creation time"updated_at"Last update time"0"New"2"Shipped"1"Completed"4"Canceled

Default: "inserted_at" · Example: "inserted_at"

start_timeinteger

Start date (unix timestamp)

end_timeinteger

End date (unix timestamp)

Responses

object

dataarray<ReturnOrder>

List of return orders

page_numberinteger

Page number

page_sizeinteger

Page size

successboolean

Success status

total_entriesinteger

Total entries

Request

curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders_returned?api_key=API_KEY"

Response 200

{
  "success": true,
  "data": [
    {
      "id": 1,
      "display_id": 1,
      "bill_full_name": "Hoang Anh",
      "bill_phone_number": "0999999999",
      "creator_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
      "custom_id": null,
      "discount": 1,
      "discount_from_order_to_returned": 1,
      "inserted_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "order_id": 1,
      "order_id_to_returned": 1,
      "order": {
        "id": 1,
        "system_id": 1,
        "shop_id": 1,
        "inserted_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-01-01T00:00:00Z",
        "status": 1,
        "status_name": "Đã xác nhận",
        "bill_full_name": "Hoang Anh",
        "bill_phone_number": "0999999999",
        "bill_email": "hoang@example.com",
        "page_id": "104438181227821",
        "post_id": "185187094667903_477083092110915",
        "ad_id": "23851252560290199",
        "shipping_fee": 1,
        "partner_fee": 1,
        "fee_marketplace": 1,
        "customer_pay_fee": true,
        "is_free_shipping": true,
        "is_livestream": true,
        "is_live_shopping": true,
        "is_smc": true,
        "received_at_shop": true,
        "total_discount": 1,
        "note": "",
        "note_print": null,
        "returned_reason": 1,
        "returned_reason_name": "Do khách hàng",
        "sub_status": 1,
        "warehouse_id": "b4cb5897-6e56-4581-96cc-2f12677c7bd8",
        "warehouse_info": {
          "name": "kho test ecod",
          "phone_number": "0999999999",
          "full_address": "hâhhha, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu",
          "address": "hâhhha",
          "province_id": "717",
          "district_id": "71705",
          "commune_id": "7170510",
          "affiliate_id": null,
          "ffm_id": null,
          "has_snappy_service": true,
          "custom_id": null
        },
        "creator_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
        "creator": {
          "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
          "fb_id": "2042723249341651",
          "name": "Hoang Anh",
          "avatar_url": null
        },
        "items": [
          {
            "id": 1,
            "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
            "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
            "quantity": 1,
            "returned_count": 1,
            "assigning_seller_id": "340644fc-314d-450e-a45f-33343678cab6",
            "quantity_by_combo_products": [],
            "discount_each_product": 1,
            "is_bonus_product": true,
            "is_discount_percent": true,
            "is_wholesale": true,
            "is_composite": true,
            "one_time_product": true,
            "note": "",
            "note_product": "",
            "inserted_at": "2024-01-01T00:00:00Z",
            "measure_group_id": 1,
            "variation_info": {
              "id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
              "name": "Ao so mi nam",
              "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
              "retail_price": 140000,
              "detail": "",
              "images": [
                "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
              ],
              "fields": [
                {
                  "id": "field-id-1",
                  "name": "Màu",
                  "value": "Trắng",
                  "keyValue": "Màu"
                }
              ],
              "barcode": "BARCODE123",
              "brand_id": null,
              "category_ids": [
                1290021044
              ],
              "display_id": "13109",
              "product_display_id": "a131092025",
              "last_imported_price": 30000,
              "weight": 0,
              "measure_info": {
                "measure_id": 1,
                "exchange_value": 1
              },
              "avg_price": 30000
            },
            "components": [
              {
                "component_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
                "quantity": 1,
                "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7"
              }
            ]
          }
        ],
        "partner": {
          "partner_id": 1,
          "cod": 0,
          "extend_code": "S58824.MB25.C3.500020713",
          "total_fee": 0,
          "updated_at": "2020-05-12T05:18:16",
          "delivery_name": null,
          "delivery_tel": null,
          "picked_up_at": null,
          "sort_code": null,
          "paid_at": null,
          "system_created": true,
          "extend_update": [
            {
              "key": "status",
              "status": "delivered",
              "tracking_id": "S58824.MB25.C3.500020713",
              "note": "",
              "update_at": "2020-05-12T05:18:16"
            }
          ]
        },
        "shipping_address": {
          "full_name": "Hoang Anh",
          "phone_number": "0999999999",
          "address": "90 Cầu Giấy",
          "full_address": "90 Cầu Giấy, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
          "province_id": "101",
          "district_id": "10113",
          "commune_id": "1011309",
          "commnue_name": "Phường Dịch Vọng",
          "district_name": "Quận Cầu Giấy",
          "province_name": "Hà Nội",
          "country_code": "84",
          "post_code": null
        },
        "payment_purchase_histories": [
          {
            "amount": 1800000,
            "type": "cash",
            "inserted_at": "2024-01-01T00:00:00Z",
            "result_code": "00",
            "ipn_reply": true,
            "voucher_amount": 0,
            "tags": [
              "payment"
            ]
          }
        ],
        "tags": [
          {
            "id": 75,
            "name": "thẻ 4"
          }
        ],
        "marketer": {
          "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
          "name": "Marketer Name",
          "email": "marketer@example.com",
          "phone_number": "0999999999",
          "fb_id": "2042723249341651",
          "avatar_url": null
        },
        "pke_mkter": "cee3c05e-5f85-43c4-b27e-889b99c50097",
        "activated_combo_products": {
          "combo_product_id": 1,
          "quantity_combo_activated": 1
        },
        "activated_promotion_advances": [
          {
            "id": 1,
            "promotion_advance_id": "fb056b32-9cf6-4c5a-92de-0eb94db71121"
          }
        ],
        "tracking_link": "https://tracking.example.com",
        "payment_link": "https://payment.example.com",
        "ads_source": null,
        "shopify_order_id": null,
        "shopify_abandon_checkout_id": 1,
        "is_abandoned_order": true,
        "cod": 0,
        "cash": 0,
        "account": 1,
        "account_name": "facebook321",
        "advanced_platform_fee": {
          "ads_top_up": 1,
          "affiliate_commission": 1,
          "diff_shipping_fee": 1,
          "marketplace_voucher": 1,
          "payment_fee": 1,
          "platform_commission": 1,
          "seller_transaction_fee": 1,
          "service_fee": 1,
          "sfp_service_fee": 1
        },
        "printing_count": 1,
        "money_to_collect": 1,
        "total_price": 1,
        "shop_customer_address_id": "0fefd213-7d0c-4d5b-bdbf-35694da80857",
        "customer": {
          "fb_id": null,
          "id": "96a8e283-3fba-492e-a35a-970f72a30a02",
          "name": "Trần Văn Hoàng",
          "page_id": "104438181227821"
        },
        "total_quantity": 1,
        "time_assign_marketer": "2024-01-01T00:00:00Z",
        "status_history": [
          {
            "avatar_url": null,
            "editor_fb": "2042723249341651",
            "editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
            "name": "Hoang Anh",
            "old_status": 0,
            "status": 1,
            "updated_at": "2024-01-01T00:00:00Z"
          }
        ],
        "duplicated_phone": true,
        "order_currency": "VND",
        "charged_by_vnpay": 1,
        "charged_by_qrpay": 1,
        "custom_id": null,
        "last_editor": {
          "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
          "fb_id": "2042723249341651",
          "name": "Hoang Anh",
          "email": "hoang@example.com",
          "avatar_url": null,
          "phone_number": "0999999999"
        },
        "last_editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
        "charged_by_momo": 1,
        "bank_transfer_images": [
          "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
        ],
        "transfer_money": 1,
        "lock_order_by_user": null,
        "assigning_care": {
          "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
          "fb_id": "2042723249341651",
          "name": "Care Name",
          "email": "care@example.com",
          "avatar_url": null,
          "phone_number": "0999999999"
        },
        "assigning_care_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
        "time_assign_care": "2024-01-01T00:00:00Z",
        "assigning_seller": {
          "id": "340644fc-314d-450e-a45f-33343678cab6",
          "fb_id": "2042723249341651",
          "name": "Seller Name",
          "email": "seller@example.com",
          "avatar_url": null,
          "phone_number": "0999999999"
        },
        "einvoices": [],
        "charged_by_card": 1,
        "estimate_delivery_date": "2024-01-01T00:00:00Z",
        "order_sources": "-1",
        "charged_by_fundiin": 1,
        "surcharge": 1,
        "is_linked_partner": true,
        "call_laters": [],
        "last_update_status_at": "2024-01-01T00:00:00Z",
        "discount_by_customer_level": 1,
        "viewing": [],
        "order_returned_ids": null,
        "cost_surcharge": 1,
        "time_send_partner": "2024-01-01T00:00:00Z",
        "charged_by_kredivo": 1,
        "discount": 1,
        "histories": [],
        "duplicated_customer": true,
        "tax": 1,
        "is_from_ecommerce": true,
        "note_image": [
          "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
        ],
        "shopify_draft_order_id": null,
        "display_id": 1,
        "shop_partner_id": 1,
        "is_locked": true
      },
      "order_to_returned": {
        "id": 1,
        "system_id": 1,
        "shop_id": 1,
        "inserted_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-01-01T00:00:00Z",
        "status": 1,
        "status_name": "Đã xác nhận",
        "bill_full_name": "Hoang Anh",
        "bill_phone_number": "0999999999",
        "bill_email": "hoang@example.com",
        "page_id": "104438181227821",
        "post_id": "185187094667903_477083092110915",
        "ad_id": "23851252560290199",
        "shipping_fee": 1,
        "partner_fee": 1,
        "fee_marketplace": 1,
        "customer_pay_fee": true,
        "is_free_shipping": true,
        "is_livestream": true,
        "is_live_shopping": true,
        "is_smc": true,
        "received_at_shop": true,
        "total_discount": 1,
        "note": "",
        "note_print": null,
        "returned_reason": 1,
        "returned_reason_name": "Do khách hàng",
        "sub_status": 1,
        "warehouse_id": "b4cb5897-6e56-4581-96cc-2f12677c7bd8",
        "warehouse_info": {
          "name": "kho test ecod",
          "phone_number": "0999999999",
          "full_address": "hâhhha, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu",
          "address": "hâhhha",
          "province_id": "717",
          "district_id": "71705",
          "commune_id": "7170510",
          "affiliate_id": null,
          "ffm_id": null,
          "has_snappy_service": true,
          "custom_id": null
        },
        "creator_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
        "creator": {
          "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
          "fb_id": "2042723249341651",
          "name": "Hoang Anh",
          "avatar_url": null
        },
        "items": [
          {
            "id": 1,
            "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
            "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
            "quantity": 1,
            "returned_count": 1,
            "assigning_seller_id": "340644fc-314d-450e-a45f-33343678cab6",
            "quantity_by_combo_products": [],
            "discount_each_product": 1,
            "is_bonus_product": true,
            "is_discount_percent": true,
            "is_wholesale": true,
            "is_composite": true,
            "one_time_product": true,
            "note": "",
            "note_product": "",
            "inserted_at": "2024-01-01T00:00:00Z",
            "measure_group_id": 1,
            "variation_info": {
              "id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
              "name": "Ao so mi nam",
              "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
              "retail_price": 140000,
              "detail": "",
              "images": [
                "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
              ],
              "fields": [
                {
                  "id": "field-id-1",
                  "name": "Màu",
                  "value": "Trắng",
                  "keyValue": "Màu"
                }
              ],
              "barcode": "BARCODE123",
              "brand_id": null,
              "category_ids": [
                1290021044
              ],
              "display_id": "13109",
              "product_display_id": "a131092025",
              "last_imported_price": 30000,
              "weight": 0,
              "measure_info": {
                "measure_id": 1,
                "exchange_value": 1
              },
              "avg_price": 30000
            },
            "components": [
              {
                "component_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
                "quantity": 1,
                "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7"
              }
            ]
          }
        ],
        "partner": {
          "partner_id": 1,
          "cod": 0,
          "extend_code": "S58824.MB25.C3.500020713",
          "total_fee": 0,
          "updated_at": "2020-05-12T05:18:16",
          "delivery_name": null,
          "delivery_tel": null,
          "picked_up_at": null,
          "sort_code": null,
          "paid_at": null,
          "system_created": true,
          "extend_update": [
            {
              "key": "status",
              "status": "delivered",
              "tracking_id": "S58824.MB25.C3.500020713",
              "note": "",
              "update_at": "2020-05-12T05:18:16"
            }
          ]
        },
        "shipping_address": {
          "full_name": "Hoang Anh",
          "phone_number": "0999999999",
          "address": "90 Cầu Giấy",
          "full_address": "90 Cầu Giấy, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
          "province_id": "101",
          "district_id": "10113",
          "commune_id": "1011309",
          "commnue_name": "Phường Dịch Vọng",
          "district_name": "Quận Cầu Giấy",
          "province_name": "Hà Nội",
          "country_code": "84",
          "post_code": null
        },
        "payment_purchase_histories": [
          {
            "amount": 1800000,
            "type": "cash",
            "inserted_at": "2024-01-01T00:00:00Z",
            "result_code": "00",
            "ipn_reply": true,
            "voucher_amount": 0,
            "tags": [
              "payment"
            ]
          }
        ],
        "tags": [
          {
            "id": 75,
            "name": "thẻ 4"
          }
        ],
        "marketer": {
          "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
          "name": "Marketer Name",
          "email": "marketer@example.com",
          "phone_number": "0999999999",
          "fb_id": "2042723249341651",
          "avatar_url": null
        },
        "pke_mkter": "cee3c05e-5f85-43c4-b27e-889b99c50097",
        "activated_combo_products": {
          "combo_product_id": 1,
          "quantity_combo_activated": 1
        },
        "activated_promotion_advances": [
          {
            "id": 1,
            "promotion_advance_id": "fb056b32-9cf6-4c5a-92de-0eb94db71121"
          }
        ],
        "tracking_link": "https://tracking.example.com",
        "payment_link": "https://payment.example.com",
        "ads_source": null,
        "shopify_order_id": null,
        "shopify_abandon_checkout_id": 1,
        "is_abandoned_order": true,
        "cod": 0,
        "cash": 0,
        "account": 1,
        "account_name": "facebook321",
        "advanced_platform_fee": {
          "ads_top_up": 1,
          "affiliate_commission": 1,
          "diff_shipping_fee": 1,
          "marketplace_voucher": 1,
          "payment_fee": 1,
          "platform_commission": 1,
          "seller_transaction_fee": 1,
          "service_fee": 1,
          "sfp_service_fee": 1
        },
        "printing_count": 1,
        "money_to_collect": 1,
        "total_price": 1,
        "shop_customer_address_id": "0fefd213-7d0c-4d5b-bdbf-35694da80857",
        "customer": {
          "fb_id": null,
          "id": "96a8e283-3fba-492e-a35a-970f72a30a02",
          "name": "Trần Văn Hoàng",
          "page_id": "104438181227821"
        },
        "total_quantity": 1,
        "time_assign_marketer": "2024-01-01T00:00:00Z",
        "status_history": [
          {
            "avatar_url": null,
            "editor_fb": "2042723249341651",
            "editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
            "name": "Hoang Anh",
            "old_status": 0,
            "status": 1,
            "updated_at": "2024-01-01T00:00:00Z"
          }
        ],
        "duplicated_phone": true,
        "order_currency": "VND",
        "charged_by_vnpay": 1,
        "charged_by_qrpay": 1,
        "custom_id": null,
        "last_editor": {
          "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
          "fb_id": "2042723249341651",
          "name": "Hoang Anh",
          "email": "hoang@example.com",
          "avatar_url": null,
          "phone_number": "0999999999"
        },
        "last_editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
        "charged_by_momo": 1,
        "bank_transfer_images": [
          "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
        ],
        "transfer_money": 1,
        "lock_order_by_user": null,
        "assigning_care": {
          "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
          "fb_id": "2042723249341651",
          "name": "Care Name",
          "email": "care@example.com",
          "avatar_url": null,
          "phone_number": "0999999999"
        },
        "assigning_care_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
        "time_assign_care": "2024-01-01T00:00:00Z",
        "assigning_seller": {
          "id": "340644fc-314d-450e-a45f-33343678cab6",
          "fb_id": "2042723249341651",
          "name": "Seller Name",
          "email": "seller@example.com",
          "avatar_url": null,
          "phone_number": "0999999999"
        },
        "einvoices": [],
        "charged_by_card": 1,
        "estimate_delivery_date": "2024-01-01T00:00:00Z",
        "order_sources": "-1",
        "charged_by_fundiin": 1,
        "surcharge": 1,
        "is_linked_partner": true,
        "call_laters": [],
        "last_update_status_at": "2024-01-01T00:00:00Z",
        "discount_by_customer_level": 1,
        "viewing": [],
        "order_returned_ids": null,
        "cost_surcharge": 1,
        "time_send_partner": "2024-01-01T00:00:00Z",
        "charged_by_kredivo": 1,
        "discount": 1,
        "histories": [],
        "duplicated_customer": true,
        "tax": 1,
        "is_from_ecommerce": true,
        "note_image": [
          "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
        ],
        "shopify_draft_order_id": null,
        "display_id": 1,
        "shop_partner_id": 1,
        "is_locked": true
      },
      "returned_items": [
        {
          "id": 1,
          "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
          "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
          "returned_quantity": 1,
          "discount_each_product": 1,
          "is_discount_percent": true
        }
      ],
      "returned_fee": 1,
      "shop_customer_id": "96a8e283-3fba-492e-a35a-970f72a30a02",
      "shop_id": 1,
      "status": 1,
      "status_histories": [
        {
          "id": 1,
          "editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
          "old_status": 0,
          "status": 1,
          "inserted_at": "2024-01-01T00:00:00Z",
          "updated_at": "2024-01-01T00:00:00Z"
        }
      ],
      "tags": [
        1
      ],
      "warehouse_id": "b4cb5897-6e56-4581-96cc-2f12677c7bd8"
    }
  ]
}

Create return order

POST/shops/{SHOP_ID}/orders_returned

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Request body

Request body containing return order information

object

order_additionalobjectrequired

Exchange order information

returned_itemsarray<object>required

List of products in returned order

statusintegerrequired

Order status

warehouse_idstringrequired

Warehouse ID

discount_from_order_to_returnedinteger

Discount from order to returned

Default: 0

order_to_returnedobject

Order to be returned

shop_customer_idstring

Customer ID

Responses

ReturnOrderReturn order information

idinteger

Return order ID

display_idinteger

Display ID

bill_full_namestring

Customer name

bill_phone_numberstring

Phone number of customer

creator_idstring

Creator ID

custom_idstring

Custom ID

discountinteger

Discount total

discount_from_order_to_returnedinteger

Discount from order to returned

inserted_atstring · date-time

Created at

updated_atstring · date-time

Updated at

order_idinteger

Order ID

order_id_to_returnedinteger

Order ID to returned

Request

curl -X POST "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders_returned?api_key=API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "discount_from_order_to_returned": 50000,
  "order_additional": {
    "bill_email": "",
    "bill_full_name": "Lê Văn Tám",
    "bill_phone_number": "0384596873",
    "cash": 1,
    "discount": 20000,
    "items": [
      {
        "discount_each_product": 0,
        "product_id": "db7cb77a-64c4-4572-9cca-86e846c0897c",
        "quantity": 1,
        "returned_quantity": 1,
        "variation_id": "749f52be-2bd0-4e76-b9fd-a4914c53192a",
        "variation_info": {
          "detail": "size: XL, color: blue",
          "fields": [
            {
              "id": "25698fb6-158e-472f-a8a7-fa48250337ae",
              "keyValue": "XL",
              "name": "size",
              "value": "XL"
            },
            {
              "id": "c414ff3c-cba7-497c-a6f8-13355605b391",
              "keyValue": "BLUE",
              "name": "color",
              "value": "blue"
            }
          ],
          "images": [
            "https://content.pancake.vn/2/2022/1/19/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"
          ],
          "name": "Sao chép Áo nam thời trang Pari",
          "retail_price": 500000,
          "weight": 100
        }
      }
    ],
    "note": "đơn trả hàng",
    "note_print": "đơn trả hàng",
    "order_currency": "VND",
    "payment_from_customers_exchange_order": 150000,
    "prepaid": 123,
    "received_at_shop": false,
    "shipping_address": {
      "address": "BT2-12 ngõ 178910",
      "commune_id": "1012129",
      "country_code": "84",
      "district_id": "10121",
      "full_address": "BT2-12 ngõ 178, Phường Đại Mỗ, Quận Nam Từ Liêm, Hà Nội",
      "full_name": "Nguyễn Hải Nhạn",
      "new_full_address": "BT2-12 ngõ 178, Hà Nội",
      "phone_number": "0384596873",
      "province_id": "101",
      "render_type": "old"
    },
    "shipping_fee": 0,
    "shop_customer_id": "ef9fc5ef-b4b5-4682-a1b9-b7ea259ae353",
    "surcharge": 0,
    "warehouse_id": "4051d111-a6b6-44fb-aca1-61fb954298cb"
  },
  "order_to_returned": {
    "id": "123157"
  },
  "returned_items": [
    {
      "product_id": "6c998441-146b-4daa-b8e0-313a2a543623",
      "returned_quantity": 1,
      "variation_id": "efac90c8-0ba7-4aa0-bef6-8f4be3c0c6e6",
      "variation_info": {
        "name": "[HỎA TỐC] Phồng Tôm Cà Mau VITOT Bánh Phồng Tôm Loại Cao Cấp Với Tỉ Lệ Tôm 48%, Đậm Đà Vị Tôm",
        "retail_price": 200000,
        "images": [
          "https://content.pancake.vn/user-content-dev2.pancake.vn/2024/12/31/a549582c91f1bee856f8a4383408de4f10585fac.jpg"
        ],
        "fields": [
          {
            "id": "995a0b6d-4e08-493e-b776-0afb2138e8a7",
            "name": "PHÂN LOẠI",
            "value": "1 HỘP CÀ MAU"
          }
        ],
        "detail": "PHÂN LOẠI: 1 HỘP CÀ MAU"
      }
    }
  ],
  "shop_customer_id": "ef9fc5ef-b4b5-4682-a1b9-b7ea259ae353",
  "status": 2,
  "warehouse_id": "4051d111-a6b6-44fb-aca1-61fb954298cb"
}'

Response 200

{
  "id": 1,
  "display_id": 1,
  "bill_full_name": "Hoang Anh",
  "bill_phone_number": "0999999999",
  "creator_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
  "custom_id": null,
  "discount": 1,
  "discount_from_order_to_returned": 1,
  "inserted_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "order_id": 1,
  "order_id_to_returned": 1,
  "order": {
    "id": 1,
    "system_id": 1,
    "shop_id": 1,
    "inserted_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "status": 1,
    "status_name": "Đã xác nhận",
    "bill_full_name": "Hoang Anh",
    "bill_phone_number": "0999999999",
    "bill_email": "hoang@example.com",
    "page_id": "104438181227821",
    "post_id": "185187094667903_477083092110915",
    "ad_id": "23851252560290199",
    "shipping_fee": 1,
    "partner_fee": 1,
    "fee_marketplace": 1,
    "customer_pay_fee": true,
    "is_free_shipping": true,
    "is_livestream": true,
    "is_live_shopping": true,
    "is_smc": true,
    "received_at_shop": true,
    "total_discount": 1,
    "note": "",
    "note_print": null,
    "returned_reason": 1,
    "returned_reason_name": "Do khách hàng",
    "sub_status": 1,
    "warehouse_id": "b4cb5897-6e56-4581-96cc-2f12677c7bd8",
    "warehouse_info": {
      "name": "kho test ecod",
      "phone_number": "0999999999",
      "full_address": "hâhhha, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu",
      "address": "hâhhha",
      "province_id": "717",
      "district_id": "71705",
      "commune_id": "7170510",
      "affiliate_id": null,
      "ffm_id": null,
      "has_snappy_service": true,
      "custom_id": null
    },
    "creator_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
    "creator": {
      "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
      "fb_id": "2042723249341651",
      "name": "Hoang Anh",
      "avatar_url": null
    },
    "items": [
      {
        "id": 1,
        "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
        "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
        "quantity": 1,
        "returned_count": 1,
        "assigning_seller_id": "340644fc-314d-450e-a45f-33343678cab6",
        "quantity_by_combo_products": [],
        "discount_each_product": 1,
        "is_bonus_product": true,
        "is_discount_percent": true,
        "is_wholesale": true,
        "is_composite": true,
        "one_time_product": true,
        "note": "",
        "note_product": "",
        "inserted_at": "2024-01-01T00:00:00Z",
        "measure_group_id": 1,
        "variation_info": {
          "id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
          "name": "Ao so mi nam",
          "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
          "retail_price": 140000,
          "detail": "",
          "images": [
            "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
          ],
          "fields": [
            {
              "id": "field-id-1",
              "name": "Màu",
              "value": "Trắng",
              "keyValue": "Màu"
            }
          ],
          "barcode": "BARCODE123",
          "brand_id": null,
          "category_ids": [
            1290021044
          ],
          "display_id": "13109",
          "product_display_id": "a131092025",
          "last_imported_price": 30000,
          "weight": 0,
          "measure_info": {
            "measure_id": 1,
            "exchange_value": 1
          },
          "avg_price": 30000
        },
        "components": [
          {
            "component_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
            "quantity": 1,
            "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7"
          }
        ]
      }
    ],
    "partner": {
      "partner_id": 1,
      "cod": 0,
      "extend_code": "S58824.MB25.C3.500020713",
      "total_fee": 0,
      "updated_at": "2020-05-12T05:18:16",
      "delivery_name": null,
      "delivery_tel": null,
      "picked_up_at": null,
      "sort_code": null,
      "paid_at": null,
      "system_created": true,
      "extend_update": [
        {
          "key": "status",
          "status": "delivered",
          "tracking_id": "S58824.MB25.C3.500020713",
          "note": "",
          "update_at": "2020-05-12T05:18:16"
        }
      ]
    },
    "shipping_address": {
      "full_name": "Hoang Anh",
      "phone_number": "0999999999",
      "address": "90 Cầu Giấy",
      "full_address": "90 Cầu Giấy, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
      "province_id": "101",
      "district_id": "10113",
      "commune_id": "1011309",
      "commnue_name": "Phường Dịch Vọng",
      "district_name": "Quận Cầu Giấy",
      "province_name": "Hà Nội",
      "country_code": "84",
      "post_code": null
    },
    "payment_purchase_histories": [
      {
        "amount": 1800000,
        "type": "cash",
        "inserted_at": "2024-01-01T00:00:00Z",
        "result_code": "00",
        "ipn_reply": true,
        "voucher_amount": 0,
        "tags": [
          "payment"
        ]
      }
    ],
    "tags": [
      {
        "id": 75,
        "name": "thẻ 4"
      }
    ],
    "marketer": {
      "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "name": "Marketer Name",
      "email": "marketer@example.com",
      "phone_number": "0999999999",
      "fb_id": "2042723249341651",
      "avatar_url": null
    },
    "pke_mkter": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "activated_combo_products": {
      "combo_product_id": 1,
      "quantity_combo_activated": 1
    },
    "activated_promotion_advances": [
      {
        "id": 1,
        "promotion_advance_id": "fb056b32-9cf6-4c5a-92de-0eb94db71121"
      }
    ],
    "tracking_link": "https://tracking.example.com",
    "payment_link": "https://payment.example.com",
    "ads_source": null,
    "shopify_order_id": null,
    "shopify_abandon_checkout_id": 1,
    "is_abandoned_order": true,
    "cod": 0,
    "cash": 0,
    "account": 1,
    "account_name": "facebook321",
    "advanced_platform_fee": {
      "ads_top_up": 1,
      "affiliate_commission": 1,
      "diff_shipping_fee": 1,
      "marketplace_voucher": 1,
      "payment_fee": 1,
      "platform_commission": 1,
      "seller_transaction_fee": 1,
      "service_fee": 1,
      "sfp_service_fee": 1
    },
    "printing_count": 1,
    "money_to_collect": 1,
    "total_price": 1,
    "shop_customer_address_id": "0fefd213-7d0c-4d5b-bdbf-35694da80857",
    "customer": {
      "fb_id": null,
      "id": "96a8e283-3fba-492e-a35a-970f72a30a02",
      "name": "Trần Văn Hoàng",
      "page_id": "104438181227821"
    },
    "total_quantity": 1,
    "time_assign_marketer": "2024-01-01T00:00:00Z",
    "status_history": [
      {
        "avatar_url": null,
        "editor_fb": "2042723249341651",
        "editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
        "name": "Hoang Anh",
        "old_status": 0,
        "status": 1,
        "updated_at": "2024-01-01T00:00:00Z"
      }
    ],
    "duplicated_phone": true,
    "order_currency": "VND",
    "charged_by_vnpay": 1,
    "charged_by_qrpay": 1,
    "custom_id": null,
    "last_editor": {
      "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
      "fb_id": "2042723249341651",
      "name": "Hoang Anh",
      "email": "hoang@example.com",
      "avatar_url": null,
      "phone_number": "0999999999"
    },
    "last_editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
    "charged_by_momo": 1,
    "bank_transfer_images": [
      "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
    ],
    "transfer_money": 1,
    "lock_order_by_user": null,
    "assigning_care": {
      "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "fb_id": "2042723249341651",
      "name": "Care Name",
      "email": "care@example.com",
      "avatar_url": null,
      "phone_number": "0999999999"
    },
    "assigning_care_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "time_assign_care": "2024-01-01T00:00:00Z",
    "assigning_seller": {
      "id": "340644fc-314d-450e-a45f-33343678cab6",
      "fb_id": "2042723249341651",
      "name": "Seller Name",
      "email": "seller@example.com",
      "avatar_url": null,
      "phone_number": "0999999999"
    },
    "einvoices": [],
    "charged_by_card": 1,
    "estimate_delivery_date": "2024-01-01T00:00:00Z",
    "order_sources": "-1",
    "charged_by_fundiin": 1,
    "surcharge": 1,
    "is_linked_partner": true,
    "call_laters": [],
    "last_update_status_at": "2024-01-01T00:00:00Z",
    "discount_by_customer_level": 1,
    "viewing": [],
    "order_returned_ids": null,
    "cost_surcharge": 1,
    "time_send_partner": "2024-01-01T00:00:00Z",
    "charged_by_kredivo": 1,
    "discount": 1,
    "histories": [],
    "duplicated_customer": true,
    "tax": 1,
    "is_from_ecommerce": true,
    "note_image": [
      "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
    ],
    "shopify_draft_order_id": null,
    "display_id": 1,
    "shop_partner_id": 1,
    "is_locked": true
  },
  "order_to_returned": {
    "id": 1,
    "system_id": 1,
    "shop_id": 1,
    "inserted_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "status": 1,
    "status_name": "Đã xác nhận",
    "bill_full_name": "Hoang Anh",
    "bill_phone_number": "0999999999",
    "bill_email": "hoang@example.com",
    "page_id": "104438181227821",
    "post_id": "185187094667903_477083092110915",
    "ad_id": "23851252560290199",
    "shipping_fee": 1,
    "partner_fee": 1,
    "fee_marketplace": 1,
    "customer_pay_fee": true,
    "is_free_shipping": true,
    "is_livestream": true,
    "is_live_shopping": true,
    "is_smc": true,
    "received_at_shop": true,
    "total_discount": 1,
    "note": "",
    "note_print": null,
    "returned_reason": 1,
    "returned_reason_name": "Do khách hàng",
    "sub_status": 1,
    "warehouse_id": "b4cb5897-6e56-4581-96cc-2f12677c7bd8",
    "warehouse_info": {
      "name": "kho test ecod",
      "phone_number": "0999999999",
      "full_address": "hâhhha, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu",
      "address": "hâhhha",
      "province_id": "717",
      "district_id": "71705",
      "commune_id": "7170510",
      "affiliate_id": null,
      "ffm_id": null,
      "has_snappy_service": true,
      "custom_id": null
    },
    "creator_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
    "creator": {
      "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
      "fb_id": "2042723249341651",
      "name": "Hoang Anh",
      "avatar_url": null
    },
    "items": [
      {
        "id": 1,
        "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
        "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
        "quantity": 1,
        "returned_count": 1,
        "assigning_seller_id": "340644fc-314d-450e-a45f-33343678cab6",
        "quantity_by_combo_products": [],
        "discount_each_product": 1,
        "is_bonus_product": true,
        "is_discount_percent": true,
        "is_wholesale": true,
        "is_composite": true,
        "one_time_product": true,
        "note": "",
        "note_product": "",
        "inserted_at": "2024-01-01T00:00:00Z",
        "measure_group_id": 1,
        "variation_info": {
          "id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
          "name": "Ao so mi nam",
          "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
          "retail_price": 140000,
          "detail": "",
          "images": [
            "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
          ],
          "fields": [
            {
              "id": "field-id-1",
              "name": "Màu",
              "value": "Trắng",
              "keyValue": "Màu"
            }
          ],
          "barcode": "BARCODE123",
          "brand_id": null,
          "category_ids": [
            1290021044
          ],
          "display_id": "13109",
          "product_display_id": "a131092025",
          "last_imported_price": 30000,
          "weight": 0,
          "measure_info": {
            "measure_id": 1,
            "exchange_value": 1
          },
          "avg_price": 30000
        },
        "components": [
          {
            "component_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
            "quantity": 1,
            "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7"
          }
        ]
      }
    ],
    "partner": {
      "partner_id": 1,
      "cod": 0,
      "extend_code": "S58824.MB25.C3.500020713",
      "total_fee": 0,
      "updated_at": "2020-05-12T05:18:16",
      "delivery_name": null,
      "delivery_tel": null,
      "picked_up_at": null,
      "sort_code": null,
      "paid_at": null,
      "system_created": true,
      "extend_update": [
        {
          "key": "status",
          "status": "delivered",
          "tracking_id": "S58824.MB25.C3.500020713",
          "note": "",
          "update_at": "2020-05-12T05:18:16"
        }
      ]
    },
    "shipping_address": {
      "full_name": "Hoang Anh",
      "phone_number": "0999999999",
      "address": "90 Cầu Giấy",
      "full_address": "90 Cầu Giấy, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
      "province_id": "101",
      "district_id": "10113",
      "commune_id": "1011309",
      "commnue_name": "Phường Dịch Vọng",
      "district_name": "Quận Cầu Giấy",
      "province_name": "Hà Nội",
      "country_code": "84",
      "post_code": null
    },
    "payment_purchase_histories": [
      {
        "amount": 1800000,
        "type": "cash",
        "inserted_at": "2024-01-01T00:00:00Z",
        "result_code": "00",
        "ipn_reply": true,
        "voucher_amount": 0,
        "tags": [
          "payment"
        ]
      }
    ],
    "tags": [
      {
        "id": 75,
        "name": "thẻ 4"
      }
    ],
    "marketer": {
      "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "name": "Marketer Name",
      "email": "marketer@example.com",
      "phone_number": "0999999999",
      "fb_id": "2042723249341651",
      "avatar_url": null
    },
    "pke_mkter": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "activated_combo_products": {
      "combo_product_id": 1,
      "quantity_combo_activated": 1
    },
    "activated_promotion_advances": [
      {
        "id": 1,
        "promotion_advance_id": "fb056b32-9cf6-4c5a-92de-0eb94db71121"
      }
    ],
    "tracking_link": "https://tracking.example.com",
    "payment_link": "https://payment.example.com",
    "ads_source": null,
    "shopify_order_id": null,
    "shopify_abandon_checkout_id": 1,
    "is_abandoned_order": true,
    "cod": 0,
    "cash": 0,
    "account": 1,
    "account_name": "facebook321",
    "advanced_platform_fee": {
      "ads_top_up": 1,
      "affiliate_commission": 1,
      "diff_shipping_fee": 1,
      "marketplace_voucher": 1,
      "payment_fee": 1,
      "platform_commission": 1,
      "seller_transaction_fee": 1,
      "service_fee": 1,
      "sfp_service_fee": 1
    },
    "printing_count": 1,
    "money_to_collect": 1,
    "total_price": 1,
    "shop_customer_address_id": "0fefd213-7d0c-4d5b-bdbf-35694da80857",
    "customer": {
      "fb_id": null,
      "id": "96a8e283-3fba-492e-a35a-970f72a30a02",
      "name": "Trần Văn Hoàng",
      "page_id": "104438181227821"
    },
    "total_quantity": 1,
    "time_assign_marketer": "2024-01-01T00:00:00Z",
    "status_history": [
      {
        "avatar_url": null,
        "editor_fb": "2042723249341651",
        "editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
        "name": "Hoang Anh",
        "old_status": 0,
        "status": 1,
        "updated_at": "2024-01-01T00:00:00Z"
      }
    ],
    "duplicated_phone": true,
    "order_currency": "VND",
    "charged_by_vnpay": 1,
    "charged_by_qrpay": 1,
    "custom_id": null,
    "last_editor": {
      "id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
      "fb_id": "2042723249341651",
      "name": "Hoang Anh",
      "email": "hoang@example.com",
      "avatar_url": null,
      "phone_number": "0999999999"
    },
    "last_editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
    "charged_by_momo": 1,
    "bank_transfer_images": [
      "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
    ],
    "transfer_money": 1,
    "lock_order_by_user": null,
    "assigning_care": {
      "id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
      "fb_id": "2042723249341651",
      "name": "Care Name",
      "email": "care@example.com",
      "avatar_url": null,
      "phone_number": "0999999999"
    },
    "assigning_care_id": "cee3c05e-5f85-43c4-b27e-889b99c50097",
    "time_assign_care": "2024-01-01T00:00:00Z",
    "assigning_seller": {
      "id": "340644fc-314d-450e-a45f-33343678cab6",
      "fb_id": "2042723249341651",
      "name": "Seller Name",
      "email": "seller@example.com",
      "avatar_url": null,
      "phone_number": "0999999999"
    },
    "einvoices": [],
    "charged_by_card": 1,
    "estimate_delivery_date": "2024-01-01T00:00:00Z",
    "order_sources": "-1",
    "charged_by_fundiin": 1,
    "surcharge": 1,
    "is_linked_partner": true,
    "call_laters": [],
    "last_update_status_at": "2024-01-01T00:00:00Z",
    "discount_by_customer_level": 1,
    "viewing": [],
    "order_returned_ids": null,
    "cost_surcharge": 1,
    "time_send_partner": "2024-01-01T00:00:00Z",
    "charged_by_kredivo": 1,
    "discount": 1,
    "histories": [],
    "duplicated_customer": true,
    "tax": 1,
    "is_from_ecommerce": true,
    "note_image": [
      "https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"
    ],
    "shopify_draft_order_id": null,
    "display_id": 1,
    "shop_partner_id": 1,
    "is_locked": true
  },
  "returned_items": [
    {
      "id": 1,
      "product_id": "3487e126-b0d9-4dae-89a9-ee60bef2f4e9",
      "variation_id": "415040f4-ab63-465e-8699-e9ebfff4c6c7",
      "returned_quantity": 1,
      "discount_each_product": 1,
      "is_discount_percent": true
    }
  ],
  "returned_fee": 1,
  "shop_customer_id": "96a8e283-3fba-492e-a35a-970f72a30a02",
  "shop_id": 1,
  "status": 1,
  "status_histories": [
    {
      "id": 1,
      "editor_id": "8fbe2a6f-b0b2-4227-a698-19d18c43f7c8",
      "old_status": 0,
      "status": 1,
      "inserted_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "tags": [
    1
  ],
  "warehouse_id": "b4cb5897-6e56-4581-96cc-2f12677c7bd8"
}

Partner list

GET/shops/{SHOP_ID}/partners

Get list of shipping partners

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Responses

object

dataarray<object>

List of partners

successboolean

Success status

Request

curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/partners?api_key=API_KEY"

Response 200

{
  "data": [
    {
      "id": 1,
      "name": "Giao hàng tiết kiệm",
      "country_code": "84",
      "accounts": [
        {
          "id": 46036,
          "name": "sonvu8910-224"
        }
      ]
    },
    {
      "id": 2,
      "name": "EMS",
      "country_code": "84",
      "accounts": []
    },
    {
      "id": 3,
      "name": "VTP",
      "country_code": "84",
      "accounts": [
        {
          "id": 10932,
          "name": "hà an"
        }
      ]
    },
    {
      "id": 4,
      "name": "247 Express",
      "country_code": "84",
      "accounts": []
    }
  ],
  "success": true
}

Project list

GET/shops/{SHOP_ID}/projects

Get list of projects

Path parameters

SHOP_IDintegerrequired

Shop ID

Example: 4

Responses

ProjectProject information

idinteger

Project ID

imagestring · urinullable

Project image URL

inserted_atstring · date-time

Created timestamp

namestring

Project name

nodesarray<ProjectNode>

Child source orders of project

shop_idinteger

Shop ID

updated_atstring · date-time

Updated timestamp

Request

curl "https://pos.pages.fm/api/v1/shops/{SHOP_ID}/projects?api_key=API_KEY"

Response 200

{
  "data": [
    {
      "id": 19,
      "image": null,
      "inserted_at": "2025-12-13T10:01:51",
      "name": "Project 1",
      "nodes": [
        {
          "custom_id": null,
          "id": 292,
          "image": null,
          "inserted_at": "2024-03-28T04:52:28",
          "link_source_id": null,
          "name": "Source order 1",
          "nodes": [
            {
              "custom_id": null,
              "id": 366,
              "image": null,
              "inserted_at": "2024-11-08T02:18:52",
              "link_source_id": null,
              "name": "Source order 2",
              "nodes": [],
              "parent_id": 292,
              "project_id": null,
              "shop_id": 20,
              "updated_at": "2025-07-02T02:52:14"
            }
          ],
          "parent_id": null,
          "project_id": 19,
          "shop_id": 20,
          "updated_at": "2025-12-13T10:02:02"
        }
      ],
      "shop_id": 20,
      "updated_at": "2025-12-13T10:01:51"
    }
  ],
  "success": true
}

Order

#List of orders

Path parameters

Query parameters

Responses

#Create order

Path parameters

Request body

Responses

#Get order information

Path parameters

Responses

#Update order

Path parameters

Request body

Responses

#Get order conversation messages

Path parameters

Query parameters

Responses

#Print order as PDF

Path parameters

Query parameters

Responses

#List of order sources

Path parameters

Responses

#Get link print label

Path parameters

Query parameters

Request body

Responses

#Get order confirm link

Path parameters

Request body

Responses

#Prepare order shipment

Path parameters

Request body

Responses

#List of advanced promotions of order

Path parameters

Request body

Responses

#List of payment methods

Path parameters

Responses

#List of return orders

Path parameters

Query parameters

Responses

#Create return order

Path parameters

Request body

Responses

#Partner list

Path parameters

Responses

#Project list

Path parameters

Responses

List of orders

Create order

Get order information

Update order

Get order conversation messages

Print order as PDF

List of order sources

Get link print label

Get order confirm link

Prepare order shipment

List of advanced promotions of order

List of payment methods

List of return orders

Create return order

Partner list

Project list