Order

Update order

Changed on Oct 26, 2026

Update order

put/shops/{SHOP_ID}/orders/{ORDER_ID}

Request

Base URL
https://pos.pages.fm/api/v1
URL
https://pos.pages.fm/api/v1/shops/{SHOP_ID}/orders/{ORDER_ID}
Auth
API key in query parameter api_key

Path parameters

SHOP_IDinteger required

Example:4

Shop ID

ORDER_IDstring required

Example:1418

Order ID

Request body

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

status0 | 17 | 11 | 12 | 13 | 20 | 1 | 8 | 9 | 2 | 3 | 16 | 4 | 15 | 5 | 6 | 7

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

post_idstring

Post ID

ad_idstring

Ad ID

shipping_feeinteger

Shipping fee

partner_feeinteger

Fee from shipping partner

fee_marketplaceinteger

Fees from e-commerce platforms

customer_pay_feeboolean

Customer pay shipping fee

is_free_shippingboolean

Free shipping

is_livestreamboolean

Is livestream order

is_live_shoppingboolean

Is live shopping order

is_smcboolean

Shopping on Messenger

received_at_shopboolean

true: Sales at counter, false: Sell online

total_discountinteger

Discount total

notestring

Internal note

note_printstring

Note for printing

returned_reasoninteger

Return reason code (1: Customer, 2: Staff, 3: Defective product, 4: Shipping carrier, 5: Exchange). Other values are shop-defined custom reasons, see returned_reason_name for the display name

returned_reason_namestring

Return reason name

sub_statusinteger

Reason for delivery delay

warehouse_idstring

Warehouse ID

creator_idstring

Creator ID

pke_mkterstring

Marketer ID

tracking_linkstring

Link confirm order

payment_linkstring

Payment link

ads_sourcestring

Advertising source

bank_paymentsobject

Payment method

shopify_order_idstring

Shopify order ID

shopify_abandon_checkout_idinteger

Shopify abandon checkout ID

is_abandoned_orderboolean

Abandoned-cart flag for creating or updating an order. Send it directly in the request body, not inside third_party or third_party_infomation. An explicit value, including false, takes precedence over automatic detection. If omitted on creation, the flag is determined automatically; if omitted on update, the current value is preserved. Only boolean true or string "true" is normalized to true; all other submitted values become false.

codinteger

Cash on delivery

cashinteger

Cash payment

accountinteger

Order source ID

account_namestring

Order source name

printing_countinteger

Printing count

money_to_collectinteger

Money to collect

marketplace_id'-2' | '-3' | '-4' | '-9' | '-16' | '-17' | '-20' | '-25' | '-27' | '-28'

Marketplace ID

total_priceinteger

Total price

shop_customer_address_idstring

Customer address ID

total_quantityinteger

Total quantity

time_assign_marketerstring date-time

Time assign marketer

p_utm_sourcestring

UTM Source

p_utm_mediumstring

UTM Medium

p_utm_campaignstring

UTM Campaign

p_utm_termstring

UTM Term

p_utm_contentstring

UTM Content

p_utm_idstring

UTM ID

utm_affiliatestring

Affiliate

linkstring

Link

duplicated_phoneboolean

Duplicated phone

order_currencystring

Order currency

charged_by_vnpayinteger

Charged by VNPay

charged_by_qrpayinteger

Charged by QRPay

custom_idstring

Custom ID

last_editor_idstring

Last editor ID

charged_by_momointeger

Charged by MoMo

bank_transfer_imagesstring[]

Bank transfer images

transfer_moneyinteger

Transfer money

lock_order_by_userstring

Lock order by user ID

assigning_care_idstring

Assigning care ID

time_assign_carestring date-time

Time assign care

charged_by_cardinteger

Charged by card

estimate_delivery_datestring date-time

Estimate delivery date

order_sourcesstring

Order sources ID

charged_by_fundiininteger

Charged by Fundiin

surchargeinteger

Surcharge

is_linked_partnerboolean

Is linked partner

call_latersobject[]

Call laters

last_update_status_atstring date-time

Last update status at

discount_by_customer_levelinteger

Discount by customer level

viewingobject[]

Viewing

order_returned_idsstring

Order returned IDs

cost_surchargeinteger

Cost surcharge

time_send_partnerstring date-time

Time send partner

charged_by_kredivointeger

Charged by Kredivo

discountinteger

Discount

historiesobject[]

Histories

duplicated_customerboolean

Duplicated customer

taxinteger

Tax

is_from_ecommerceboolean

Is from e-commerce

note_imagestring[]

Note images

shopify_draft_order_idstring

Shopify draft order ID

display_idinteger

Display ID

shop_partner_idinteger

Shop partner ID

is_lockedboolean

Order lock

merge_orderboolean

Allows merging orders

Example request

{
  "partner": {
    "count_of_delivery": 2
  },
  "invoice_info_list": [
    {
      "invoice_detail": {
        "name": "Hoang Anh",
        "phone_number": "0934283743",
        "identity_code": "029374382740"
      },
      "invoice_type": "personal",
      "is_requested": true
    }
  ],
  "reports_by_phone": {
    "+639175706297": {
      "order_fail": 29,
      "order_success": 20,
      "warning": 0
    }
  },
  "is_abandoned_order": true,
  "prepaid_by_point": {
    "money": 15000,
    "point": 15
  },
  "additional_info": {
    "delivery_deadline": "2026-06-03T10:00:00",
    "ship_by_date": 1793000000
  },
  "customer_referral_code": {
    "active": "true",
    "customer_id": "09bb9399-45f3-4897-a53a-85dde2f886fe",
    "discount": "10",
    "format": "{PHONE_NUMBER}",
    "free_products_priced_between_approx": {
      "active": "true",
      "operator": "GreaterOrEqual",
      "price": "150000"
    },
    "is_percent": "true",
    "only_customers_with_level_will_have_referral_code": "true",
    "referral_code": "982843759",
    "reward_points_for_old_customers": {
      "active": "true",
      "money": "10000",
      "point": "1"
    },
    "shop_customer_id": "f8160a4c-dfa7-4ee8-b540-d245755ea1f1"
  }
}

Response

Success

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

status0 | 17 | 11 | 12 | 13 | 20 | 1 | 8 | 9 | 2 | 3 | 16 | 4 | 15 | 5 | 6 | 7

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

post_idstring

Post ID

ad_idstring

Ad ID

shipping_feeinteger

Shipping fee

partner_feeinteger

Fee from shipping partner

fee_marketplaceinteger

Fees from e-commerce platforms

customer_pay_feeboolean

Customer pay shipping fee

is_free_shippingboolean

Free shipping

is_livestreamboolean

Is livestream order

is_live_shoppingboolean

Is live shopping order

is_smcboolean

Shopping on Messenger

received_at_shopboolean

true: Sales at counter, false: Sell online

total_discountinteger

Discount total

notestring

Internal note

note_printstring

Note for printing

returned_reasoninteger

Return reason code (1: Customer, 2: Staff, 3: Defective product, 4: Shipping carrier, 5: Exchange). Other values are shop-defined custom reasons, see returned_reason_name for the display name

returned_reason_namestring

Return reason name

sub_statusinteger

Reason for delivery delay

warehouse_idstring

Warehouse ID

creator_idstring

Creator ID

pke_mkterstring

Marketer ID

tracking_linkstring

Link confirm order

payment_linkstring

Payment link

ads_sourcestring

Advertising source

bank_paymentsobject

Payment method

shopify_order_idstring

Shopify order ID

shopify_abandon_checkout_idinteger

Shopify abandon checkout ID

is_abandoned_orderboolean

codinteger

Cash on delivery

cashinteger

Cash payment

accountinteger

Order source ID

account_namestring

Order source name

printing_countinteger

Printing count

money_to_collectinteger

Money to collect

marketplace_id'-2' | '-3' | '-4' | '-9' | '-16' | '-17' | '-20' | '-25' | '-27' | '-28'

Marketplace ID

total_priceinteger

Total price

shop_customer_address_idstring

Customer address ID

total_quantityinteger

Total quantity

time_assign_marketerstring date-time

Time assign marketer

p_utm_sourcestring

UTM Source

p_utm_mediumstring

UTM Medium

p_utm_campaignstring

UTM Campaign

p_utm_termstring

UTM Term

p_utm_contentstring

UTM Content

p_utm_idstring

UTM ID

utm_affiliatestring

Affiliate

linkstring

Link

duplicated_phoneboolean

Duplicated phone

order_currencystring

Order currency

charged_by_vnpayinteger

Charged by VNPay

charged_by_qrpayinteger

Charged by QRPay

custom_idstring

Custom ID

last_editor_idstring

Last editor ID

charged_by_momointeger

Charged by MoMo

bank_transfer_imagesstring[]

Bank transfer images

transfer_moneyinteger

Transfer money

lock_order_by_userstring

Lock order by user ID

assigning_care_idstring

Assigning care ID

time_assign_carestring date-time

Time assign care

charged_by_cardinteger

Charged by card

estimate_delivery_datestring date-time

Estimate delivery date

order_sourcesstring

Order sources ID

charged_by_fundiininteger

Charged by Fundiin

surchargeinteger

Surcharge

is_linked_partnerboolean

Is linked partner

call_latersobject[]

Call laters

last_update_status_atstring date-time

Last update status at

discount_by_customer_levelinteger

Discount by customer level

viewingobject[]

Viewing

order_returned_idsstring

Order returned IDs

cost_surchargeinteger

Cost surcharge

time_send_partnerstring date-time

Time send partner

charged_by_kredivointeger

Charged by Kredivo

discountinteger

Discount

historiesobject[]

Histories

duplicated_customerboolean

Duplicated customer

taxinteger

Tax

is_from_ecommerceboolean

Is from e-commerce

note_imagestring[]

Note images

shopify_draft_order_idstring

Shopify draft order ID

display_idinteger

Display ID

shop_partner_idinteger

Shop partner ID

is_lockedboolean

Order lock

merge_orderboolean

Allows merging orders

Example response

{
  "partner": {
    "count_of_delivery": 2
  },
  "invoice_info_list": [
    {
      "invoice_detail": {
        "name": "Hoang Anh",
        "phone_number": "0934283743",
        "identity_code": "029374382740"
      },
      "invoice_type": "personal",
      "is_requested": true
    }
  ],
  "reports_by_phone": {
    "+639175706297": {
      "order_fail": 29,
      "order_success": 20,
      "warning": 0
    }
  },
  "is_abandoned_order": true,
  "prepaid_by_point": {
    "money": 15000,
    "point": 15
  },
  "additional_info": {
    "delivery_deadline": "2026-06-03T10:00:00",
    "ship_by_date": 1793000000
  },
  "customer_referral_code": {
    "active": "true",
    "customer_id": "09bb9399-45f3-4897-a53a-85dde2f886fe",
    "discount": "10",
    "format": "{PHONE_NUMBER}",
    "free_products_priced_between_approx": {
      "active": "true",
      "operator": "GreaterOrEqual",
      "price": "150000"
    },
    "is_percent": "true",
    "only_customers_with_level_will_have_referral_code": "true",
    "referral_code": "982843759",
    "reward_points_for_old_customers": {
      "active": "true",
      "money": "10000",
      "point": "1"
    },
    "shop_customer_id": "f8160a4c-dfa7-4ee8-b540-d245755ea1f1"
  }
}

Changes

Oct 26, 202622642b4b9381 Revision changes
- info
  added the optional property / to the response with the status
Oct 13, 2026e8241b8d7791 Revision changes
- info
  added the new optional request property /
- info
  added the optional property / to the response with the status

Operation history (4 revisions)

Update order

Request

Path parameters

Request body

Example request

Response 200OK

Example response

Changes

Response