@pancake-pos/app-cli 2026.1.6 → 2026.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/dist/cli.js +411 -27
  2. package/docs/llms-full.txt +323 -28
  3. package/docs/openapi.json +1 -0
  4. package/package.json +2 -2
  5. package/runtime/frame.js +2 -1
  6. package/runtime/frame.js.map +1 -1
  7. package/runtime/worker.js +219 -18
  8. package/runtime/worker.js.map +3 -3
package/docs/openapi.json ADDED
@@ -0,0 +1 @@
1
+ {"openapi":"3.1.0","info":{"title":"Pancake POS Open API","version":"1.0.0"},"servers":[{"url":"https://pos.pages.fm/api/v1","description":"Production server"}],"x-tagGroups":[{"name":"Shop","x-name-i18n":{"vie":"Cửa hàng"},"tags":["Shop","Employee","Address","Webhook"]},{"name":"Sales","x-name-i18n":{"vie":"Bán hàng"},"tags":["Order","Order tag","Call Later","eCommerce","Livestream","E-Invoice","Auto Voice"]},{"name":"Products & inventory","x-name-i18n":{"vie":"Sản phẩm & kho"},"tags":["Product","Combo","Lot","Warehouse","Purchase","Export","Warehouse Transfer","Stocktaking","Supplier"]},{"name":"Customers & promotions","x-name-i18n":{"vie":"Khách hàng & khuyến mãi"},"tags":["Customer","Promotion","Voucher"]},{"name":"Finance","x-name-i18n":{"vie":"Tài chính"},"tags":["Transaction","Debt","Reconciliation"]},{"name":"Reports & ads","x-name-i18n":{"vie":"Báo cáo & quảng cáo"},"tags":["Statistics","Statistics inventory analytics","Statistics customer analytics","Ads Manager"]}],"paths":{"/shops":{"get":{"summary":"Shop information","x-summary-i18n":{"vie":"Thông tin cửa hàng"},"description":"Get shop information","tags":["Shop"],"x-tags-i18n":{"vie":["Cửa hàng"]},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"shops":{"type":"array","items":{"$ref":"#/components/schemas/Shop"}},"success":{"type":"boolean"}}},"examples":{"default":{"value":{"shops":[{"avatar_url":"https://statics.pancake.vn/user-content-dev2.pancake.vn/2022/7/6/8678250807b2285e2752ac2cbbf43925f19a677c.jpeg","name":"Shop thời trang","id":6036602,"link_post_marketer":[{"ad_account_id":null,"id":"949f1396-f6fa-45d9-93b6-4c37503a9950","inserted_at":"2025-08-21T03:02:04","marketer":"cee3c05e-5f85-43c4-b27e-889b99c50097","multiple_post":[],"multiple_source":[{"account":"2284322048329488","key":"-1","page_id":"2284322048329488"}],"shop_id":6036602,"type":"source"}],"pages":[{"id":"104438181227821","name":"Quần áo","platform":"facebook","settings":{"auto_create_order":true},"shop_id":20}]}],"success":true}}}}}}}}},"/geo/provinces":{"get":{"summary":"List of provinces and cities","x-summary-i18n":{"vie":"Danh sách tỉnh thành phố"},"description":"Get list of provinces and cities","tags":["Address"],"x-tags-i18n":{"vie":["Địa chỉ"]},"parameters":[{"name":"country_code","in":"query","required":true,"schema":{"type":"string","default":"84","example":"84"},"description":"Country code (for example, Vietnam country code is 84)","example":"84"},{"name":"is_new","in":"query","required":false,"schema":{"type":"boolean","default":false,"example":false},"description":"New province (for country Viet Nam)","example":false},{"name":"all","in":"query","required":false,"schema":{"type":"boolean","default":false,"example":false},"description":"All provinces including old and new (for country Viet Nam)","example":false}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Province ID"},"name":{"type":"string","description":"Province name"},"name_en":{"type":"string","description":"Province name in English"},"new_id":{"type":"string","description":"New province ID (for country Viet Nam)"}}}}}},"examples":{"default":{"value":{"data":[{"id":"101","name":"Hà Nội","name_en":"ha noi","new_id":"84_VN101"},{"id":"701","name":"Hồ Chí Minh","name_en":"ho chi minh","new_id":"84_VN129"}]}}}}}}}}},"/geo/districts":{"get":{"summary":"List of districts","x-summary-i18n":{"vie":"Danh sách quận huyện"},"description":"Get list of districts","tags":["Address"],"x-tags-i18n":{"vie":["Địa chỉ"]},"parameters":[{"name":"province_id","in":"query","required":true,"schema":{"type":"string","example":"101"},"description":"Province ID of districts you want to retrieve. Get province ID in api GET /geo/provinces","example":"101"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"District ID"},"name":{"type":"string","description":"District name"},"name_en":{"type":"string","description":"District name in English"},"province_id":{"type":"string","description":"Province ID"}}}}}},"examples":{"default":{"value":{"data":[{"id":"10101","name":"Quận Ba Đình","name_en":"ba dinh","province_id":"101"}]}}}}}}}}},"/geo/communes":{"get":{"summary":"List of communes","x-summary-i18n":{"vie":"Danh sách phường xã"},"description":"Get list of communes","tags":["Address"],"x-tags-i18n":{"vie":["Địa chỉ"]},"parameters":[{"name":"district_id","in":"query","required":true,"schema":{"type":"string"},"description":"District ID of communes you want to retrieve. Get district ID in api GET /geo/districts","example":"10101"},{"name":"province_id","in":"query","required":true,"schema":{"type":"string"},"description":"Province ID of communes you want to retrieve. Get province ID in api GET /geo/provinces","example":"101"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Commune ID"},"name":{"type":"string","description":"Commune name"},"name_en":{"type":"string","description":"Commune name in English"},"district_id":{"type":"string","description":"District ID"},"province_id":{"type":"string","description":"Province ID"},"new_id":{"type":"string","description":"New commune/ward ID (for country Viet Nam)"},"postcode":{"type":"string","description":"Postal code"}}}}}},"examples":{"default":{"value":{"data":[{"district_id":"10101","id":"1010115","name":"Phường Cống Vị","name_en":"cong vi","new_id":null,"postcode":null,"province_id":"101"}]}}}}}}}}},"/shops/{SHOP_ID}/warehouses":{"get":{"summary":"Warehouse list","x-summary-i18n":{"vie":"Danh sách kho hàng"},"description":"Get list of warehouses","tags":["Warehouse"],"x-tags-i18n":{"vie":["Kho hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Warehouses list","properties":{"data":{"type":"array","description":"List of warehouses","items":{"$ref":"#/components/schemas/Warehouse"}}}},"examples":{"default":{"value":{"data":[{"id":"b4cb5897-6e56-4581-96cc-2f12677c7bd8","name":"kho test ecod","address":"hâhhha","full_address":"hâhhha, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu","phone_number":"0999999999","province_id":"717","district_id":"71705","commune_id":"7170510","country_code":"84","shop_id":26290,"allow_create_order":true,"custom_id":null,"affiliate_shop_id":26290,"affiliate_warehouse":"Kho gia dụng"},{"id":"644b0063-e9a8-43cd-ba08-66a8066d462e","name":"kho 2","address":"19/349 Minh Khai , Hai bà Trưng, Hà Nội","full_address":"19/349 Minh Khai , Hai bà Trưng, Hà Nội, Phường Minh Khai, Quận Hai Bà Trưng, Hà Nội","phone_number":"01655809949","province_id":"101","district_id":"10107","commune_id":"1010735","country_code":"84","shop_id":26290,"allow_create_order":false,"custom_id":null},{"id":"3cfcf3ab-dd77-4237-862f-356b3506fe8a","name":"kho địa chỉ mới","address":"34234234","full_address":"34234234, Xã Cao Đức, Bắc Ninh","phone_number":"0989965976","province_id":"84_VN102","district_id":null,"commune_id":"84_VN10236","country_code":"84","shop_id":26290,"allow_create_order":true,"custom_id":null}]}}}}}}}},"post":{"summary":"Create warehouse","x-summary-i18n":{"vie":"Tạo kho hàng"},"description":"Create warehouses","tags":["Warehouse"],"x-tags-i18n":{"vie":["Kho hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","shelf_config"],"properties":{"name":{"type":"string","description":"Warehouse name"},"address":{"type":"string","description":"Warehouse address"},"phone_number":{"type":"string","description":"Warehouse phone number"},"province_id":{"type":"string","description":"Province ID. Get by API GET /geo/provinces"},"district_id":{"type":"string","description":"District ID. Get by API GET /geo/districts"},"commune_id":{"type":"string","description":"Commune ID. Get by API GET /geo/communes"},"country_code":{"type":"string","description":"Country code"},"shelf_config":{"type":"object","description":"Shelf config","properties":{"col":{"type":"string","description":"Column"}}},"batch_config":{"type":"object","description":"Batch config","properties":{"col":{"type":"string","description":"Column"},"line":{"type":"string","description":"Line"},"row":{"type":"string","description":"Row"}}},"custom_shelf_config":{"type":"object","description":"Custom shelf config","properties":{"custom_config":{"type":"object","description":"Custom config"}}},"custom_batch_config":{"type":"object","description":"Custom batch config","properties":{"custom_config":{"type":"object","description":"Custom config"}}},"hide_config_batch_shelf":{"type":"boolean","description":"Open custom batch shelf config"}},"example":{"name":"kho 2","address":"19/349 Minh Khai , Hai bà Trưng, Hà Nội","phone_number":"098765432","province_id":"101","district_id":"10107","commune_id":"1010735","country_code":"84","shelf_config":{"col":"3"},"batch_config":{"col":"0","line":"3","row":"3"},"custom_batch_config":{"custom_config":{"0":"lô 1"}},"custom_shelf_config":{"custom_config":{"0":"1.1","1":"1.2","2":"1.3","3":"1.4"}},"hide_config_batch_shelf":false}}}},"description":"Request body containing warehouse information to create"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Warehouse"},"examples":{"default":{"value":{"id":"b4cb5897-6e56-4581-96cc-2f12677c7bd8","name":"kho test ecod","address":"hâhhha","full_address":"hâhhha, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu","phone_number":"0999999999","province_id":"717","district_id":"71705","commune_id":"7170510","country_code":"84","shop_id":26290,"allow_create_order":true,"custom_id":null}}}}}}}}},"/shops/{SHOP_ID}/warehouses/{WAREHOUSE_ID}":{"put":{"summary":"Update warehouse","x-summary-i18n":{"vie":"Cập nhật kho hàng"},"description":"Update warehouse","tags":["Warehouse"],"x-tags-i18n":{"vie":["Kho hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"WAREHOUSE_ID","in":"path","required":true,"schema":{"type":"string","example":"b4cb5897-6e56-4581-96cc-2f12677c7bd8"},"description":"Warehouse ID"}],"requestBody":{"required":true,"description":"Request body containing warehouse information to update","content":{"application/json":{"schema":{"type":"object","required":["name","shelf_config"],"properties":{"name":{"type":"string","description":"Warehouse name"},"address":{"type":"string","description":"Warehouse address"},"phone_number":{"type":"string","description":"Warehouse phone number"},"province_id":{"type":"string","description":"Province ID. Get by API GET /geo/provinces"},"district_id":{"type":"string","description":"District ID. Get by API GET /geo/districts"},"commune_id":{"type":"string","description":"Commune ID. Get by API GET /geo/communes"},"country_code":{"type":"string","description":"Country code"},"shelf_config":{"type":"object","description":"Shelf config","properties":{"col":{"type":"string","description":"Column"}}},"batch_config":{"type":"object","description":"Batch config","properties":{"col":{"type":"string","description":"Column"},"line":{"type":"string","description":"Line"},"row":{"type":"string","description":"Row"}}},"custom_shelf_config":{"type":"object","description":"Custom shelf config","properties":{"custom_config":{"type":"object","description":"Custom config"}}},"custom_batch_config":{"type":"object","description":"Custom batch config","properties":{"custom_config":{"type":"object","description":"Custom config"}}},"hide_config_batch_shelf":{"type":"boolean","description":"Open custom batch shelf config"}},"example":{"name":"Kho mặc định","address":"190 La Thành","phone_number":"0366452565","province_id":"101","district_id":"10113","commune_id":"1011309","country_code":"84","shelf_config":{"col":"3"},"batch_config":{"col":"0","line":"3","row":"3"},"custom_batch_config":{"custom_config":{"0":"lô 1"}},"custom_shelf_config":{"custom_config":{"0":"1.1","1":"1.2","2":"1.3","3":"1.4"}},"hide_config_batch_shelf":false}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Warehouse"},"examples":{"default":{"value":{"id":"b4cb5897-6e56-4581-96cc-2f12677c7bd8","name":"kho test ecod","address":"SCB","full_address":"SCB, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu","phone_number":"0999999999","province_id":"717","district_id":"71705","commune_id":"7170510","country_code":"84","shop_id":26290,"allow_create_order":true,"custom_id":null}}}}}}}}},"/shops/{SHOP_ID}/inventory_histories":{"get":{"summary":"Inventory histories","x-summary-i18n":{"vie":"Lịch sử xuất nhập kho"},"description":"Get inventory history","tags":["Warehouse"],"x-tags-i18n":{"vie":["Kho hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":true,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"page_size","in":"query","required":true,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"},{"name":"warehouse_id","in":"query","required":false,"schema":{"type":"string","example":"b4cb5897-6e56-4581-96cc-2f12677c7bd8"},"description":"Warehouse ID"},{"name":"variation_ids[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"example":["415040f4-ab63-465e-8699-e9ebfff4c6c7"]},"description":"Variation IDs"},{"name":"startDate","in":"query","required":false,"schema":{"type":"integer","example":0},"description":"Start date (unix timestamp)"},{"name":"endDate","in":"query","required":false,"schema":{"type":"integer","example":0},"description":"End date (unix timestamp)"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of inventory histories","items":{"type":"object","properties":{"avg_price":{"type":"integer","description":"Average import price"},"current_inventory":{"type":"array","description":"Current inventory information","items":{"type":"object","properties":{"actual_remain_quantity":{"type":"integer","description":"Actual remain quantity"},"avg_price":{"type":"number","description":"Average price"},"id":{"type":"string","description":"Warehouse ID"},"name":{"type":"string","description":"Warehouse name"},"remain_quantity":{"type":"integer","description":"Remain quantity"},"total_quantity":{"type":"integer","description":"Total quantity"}}}},"editor_id":{"type":"string","description":"Updated employee ID"},"id":{"type":"integer","description":"Inventory history ID"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"quantity":{"type":"integer","description":"Change quantity"},"ref_display_id":{"type":"string","description":"Reference display ID"},"remain_quantity":{"type":"integer","description":"In stock"},"table_name":{"type":"string","description":"Table name"},"type":{"type":"string","description":"Type"},"variation_now":{"type":"object","description":"Variation information","properties":{"barcode":{"type":"string"},"display_id":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"keyValue":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"id":{"type":"string"},"images":{"type":"array","items":{"type":"string","format":"uri"}},"is_hidden":{"type":"boolean"},"is_locked":{"type":"boolean"},"is_sell_negative_variation":{"type":"boolean"},"last_imported_price":{"type":"integer"},"product_id":{"type":"string"},"retail_price":{"type":"integer"},"weight":{"type":"integer"}}},"warehouse":{"type":"object","description":"Warehouse change inventory","properties":{"custom_id":{"type":"string"},"ffm_id":{"type":"string"},"full_address":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"}}}}}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"avg_price":1,"current_inventory":[{"actual_remain_quantity":1,"avg_price":1,"id":"b4cb5897-6e56-4581-96cc-2f12677c7bd8","name":"kho test ecod","remain_quantity":1,"total_quantity":1}],"editor_id":"cee3c05e-5f85-43c4-b27e-889b99c50097","id":1,"inserted_at":"2024-01-01T00:00:00Z","quantity":1,"ref_display_id":"12345","remain_quantity":1,"table_name":"Purchase","type":"import","variation_now":{"barcode":"BARCODE123","display_id":"13109","fields":[{"id":"field-id-1","keyValue":"Màu","name":"Màu","value":"Trắng"}],"id":"415040f4-ab63-465e-8699-e9ebfff4c6c7","images":["https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"],"is_hidden":true,"is_locked":true,"is_sell_negative_variation":true,"last_imported_price":1,"product_id":"3487e126-b0d9-4dae-89a9-ee60bef2f4e9","retail_price":1,"weight":1},"warehouse":{"custom_id":null,"ffm_id":null,"full_address":"hâhhha, Xã Bình Trung, Huyện Châu Đức, Bà Rịa-Vũng Tàu","id":"b4cb5897-6e56-4581-96cc-2f12677c7bd8","name":"kho test ecod","phone_number":"0999999999"}}]}}}}}}}}},"/shops/{SHOP_ID}/orders":{"get":{"summary":"List of orders","x-summary-i18n":{"vie":"Danh sách đơn hàng"},"description":"Get list of orders. Get information of specific order","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size","example":100},{"name":"page_number","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number","example":1},{"name":"search","in":"query","required":false,"schema":{"type":"string","example":"0999999999"},"description":"Phone number, name of customer, note, ....","example":"0999999999"},{"name":"filter_status[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer"},"example":[1,2]},"description":"Order status","example":[0,1]},{"name":"include_removed","in":"query","required":false,"schema":{"type":"integer","example":0},"description":"Include removed orders","example":1},{"name":"updateStatus","in":"query","required":false,"schema":{"type":"string","default":"inserted_at","enum":["inserted_at","updated_at","partner_inserted_at","paid_at","estimate_delivery_date","picked_up_at","first_delivery_at","transfer_proof","time_assign_seller","time_assign_care","time_assign_marketer","-1","0","11","20","1","12","13","8","9","2","3","16","4","15","5"],"x-enum-descriptions":["Order creation time","Last update time","Time sent to courier","Reconciliation time","Estimate delivery time","Courier picked up at","First delivery at","Transfer proof","Time assign seller","Time assign care","Time assign marketer","Last status update","New","Restocking","Purchased","Confirmed","Wait for printing","Printed","Packaging","Waiting for pick up","Shipped","Received","Collected money","Returning","Partial return","Returned"],"example":"inserted_at"},"description":"Filter orders by time"},{"name":"startDateTime","in":"query","required":false,"schema":{"type":"integer","format":"int64","example":0},"description":"Start date (unix timestamp)","example":1699635600},{"name":"endDateTime","in":"query","required":false,"schema":{"type":"integer","format":"int64","example":0},"description":"End date (unix timestamp)","example":1699635600},{"name":"option_sort","in":"query","required":false,"schema":{"type":"string","default":"inserted_at_desc","enum":["inserted_at_desc","inserted_at_asc","last_updated_order_desc","last_updated_order_asc","last_update_status_at_desc","last_update_status_at_asc","order_valuation_desc","order_valuation_asc","product_quantity_desc","product_quantity_asc","product_name_desc","product_name_asc","sub_status_sort_desc","sub_status_sort_asc","first_undeliverable_at_desc","first_undeliverable_at_asc","customer_sort_desc","customer_sort_asc","estimate_delivery_date_desc","estimate_delivery_date_asc","order_source_desc","order_source_asc"],"x-enum-descriptions":["Order creation time gradually decreases","Order creation time gradually increases","Last updated order gradually decreases","Last updated order gradually increases","Last update status at gradually decreases","Last update status at gradually increases","Order value gradually decreases","Order value gradually increases","Product quantity gradually decreases","Product quantity gradually increases","Product name gradually decreases","Product name gradually increases","Delivery delay update gradually decreases","Delivery delay update gradually increases","First undeliverable at gradually decreases","First undeliverable at gradually increases","Customer name gradually decreases","Customer name gradually increases","Estimate delivery date gradually decreases","Estimate delivery date gradually increases","Order source gradually decreases","Order source gradually increases"],"example":"inserted_at_desc"},"description":"Orders sequence"},{"name":"fields[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"Response fields","example":["id","bill_phone_number"]},{"name":"partner_id[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer"}},"description":"Shipping partner ID on Pancake system","example":[1,3]},{"name":"shop_partner_account","in":"query","required":false,"schema":{"type":"integer"},"description":"Filter by shipping account ID connected to the shop","example":46036},{"name":"customer_id","in":"query","required":false,"schema":{"type":"string"},"description":"Customer ID","example":"96a8e283-3fba-492e-a35a-970f72a30a02"},{"name":"order_sources[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"array","items":{"type":"string"}}},"description":"Order sources. Format: [[order_source_id, account_id], ...]\nExample: [[\"-1\", \"314\"], [\"-3\"]]\n","example":[["-1","314"],["-3"]]},{"name":"is_filter_exclude_source","in":"query","required":false,"schema":{"type":"boolean","default":false},"description":"Exclude order source","example":true},{"name":"ad_ids[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"Advertising IDs","example":["1784439461476385","1784439461473489"]},{"name":"project_ids","in":"query","required":false,"schema":{"type":"integer"},"description":"Project ID","example":1},{"name":"extra_fields[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["return_rate","conversation_note"],"x-enum-descriptions":["Return rate","Conversation note"]}},"description":"Extra fields","example":["return_rate","conversation_note"]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of orders","items":{"type":"object","properties":{"id":{"type":"integer","description":"Order ID"},"system_id":{"type":"integer","description":"System ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Order creation time"},"updated_at":{"type":"string","format":"date-time","description":"Order update time"},"status":{"type":"integer","description":"Order status","enum":[0,17,11,12,13,20,1,8,9,2,3,16,4,15,5,6,7],"x-enum-descriptions":["New","Waiting for confirmation","Restocking","Wait for printing","Printed","Purchased","Confirmed","Packaging","Waiting for pick up","Shipped","Received","Collected money","Returning","Partial return","Returned","Canceled","Deleted recently"]},"status_name":{"type":"string","description":"Order status name"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"bill_email":{"type":"string","description":"Customer email"},"conversation_id":{"type":"string","description":"Conversation ID"},"page_id":{"type":"string","description":"Facebook page ID"},"post_id":{"type":"string","description":"Post ID"},"ad_id":{"type":"string","description":"Ad ID"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"partner_fee":{"type":"integer","description":"Fee from shipping partner"},"fee_marketplace":{"type":"integer","description":"Fees from e-commerce platforms"},"customer_pay_fee":{"type":"boolean","description":"Customer pay shipping fee"},"is_free_shipping":{"type":"boolean","description":"Free shipping"},"is_livestream":{"type":"boolean","description":"Is livestream order"},"is_live_shopping":{"type":"boolean","description":"Is live shopping order"},"is_smc":{"type":"boolean","description":"Shopping on Messenger"},"received_at_shop":{"type":"boolean","description":"true: Sales at counter, false: Sell online"},"total_discount":{"type":"integer","description":"Discount total"},"note":{"type":"string","description":"Internal note"},"note_print":{"type":"string","description":"Note for printing"},"returned_reason":{"type":"integer","description":"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_name":{"type":"string","description":"Return reason name"},"sub_status":{"type":"integer","description":"Reason for delivery delay"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"warehouse_info":{"type":"object","description":"Warehouse information","properties":{"name":{"type":"string","description":"Warehouse name"},"phone_number":{"type":"string","description":"Warehouse phone number"},"full_address":{"type":"string","description":"Warehouse full address"},"address":{"type":"string","description":"Warehouse address"},"province_id":{"type":"string","description":"Province ID"},"district_id":{"type":"string","description":"District ID"},"commune_id":{"type":"string","description":"Commune ID"},"affiliate_id":{"type":"string","description":"Affiliate ID"},"ffm_id":{"type":"string","description":"FFM ID"},"has_snappy_service":{"type":"boolean","description":"Has Snappy service"},"custom_id":{"type":"string","description":"Custom ID"}}},"creator_id":{"type":"string","description":"Creator ID"},"creator":{"type":"object","description":"Order creator","properties":{"id":{"type":"string","description":"Creator ID"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"name":{"type":"string","description":"Creator name"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"items":{"type":"array","description":"Product list. When creating or updating an order, each entry must include `variation_id` and `quantity`. `variation_info` is optional — if omitted, the backend treats it as an empty object; send it (with `retail_price`) when you need the line price to be explicit.","items":{"type":"object","required":["variation_id","quantity"],"properties":{"product_id":{"type":"string","description":"Product ID"},"quantity":{"type":"integer","description":"Quantity"},"returned_count":{"type":"integer","description":"Returned count"},"assigning_seller_id":{"type":"string","description":"Assigning seller ID"},"quantity_by_combo_products":{"type":"array","description":"Quantity by combo products","items":{"type":"object"}},"discount_each_product":{"type":"integer","description":"Discount for each product"},"is_bonus_product":{"type":"boolean","description":"Is bonus product"},"is_discount_percent":{"type":"boolean","description":"Is discount by percent"},"is_wholesale":{"type":"boolean","description":"Is wholesale"},"is_composite":{"type":"boolean","description":"Is composite product"},"one_time_product":{"type":"boolean","description":"One time product"},"note":{"type":"string","description":"Product note"},"note_product":{"type":"string","description":"Product note"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"measure_group_id":{"type":"integer","description":"Measure group ID"},"variation_info":{"type":"object","description":"Variation information. Optional when creating/updating an order (the backend defaults it to an empty object if omitted). Its inner fields are not individually required, but sending `retail_price` is recommended so the line price is correct.","properties":{"id":{"type":"string","description":"Variation ID"},"name":{"type":"string","description":"Product name"},"product_id":{"type":"string","description":"Product ID"},"retail_price":{"type":"integer","description":"Retail price. Not strictly required, but recommended when creating/updating an order so the line price is correct."},"detail":{"type":"string","description":"Variation detail"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"},"keyValue":{"type":"string","description":"Key value"}}}},"barcode":{"type":"string","description":"Barcode"},"brand_id":{"type":"string","description":"Brand ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"display_id":{"type":"string","description":"Display ID"},"product_display_id":{"type":"string","description":"Product display ID"},"last_imported_price":{"type":"integer","description":"Last imported price"},"is_upsale_product":{"type":"boolean","description":"Upsale product"},"weight":{"type":"integer","description":"Weight"},"measure_info":{"type":"object","description":"Measure information","properties":{"measure_id":{"type":"integer","description":"Measure ID"},"exchange_value":{"type":"integer","description":"Exchange value"}}},"avg_price":{"type":"integer","description":"Average import price"}}},"components":{"type":"array","description":"Product components","items":{"type":"object","properties":{"component_id":{"type":"string","description":"Component ID"},"quantity":{"type":"integer","description":"Quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information"}}}},"id":{"type":"integer","description":"Item ID"},"variation_id":{"type":"string","description":"Variation ID"}}}},"partner":{"type":"object","description":"Partner information\nWhen updating an order that already has shipping info, only the fields you send are written; omitted fields keep their current values. Send `null` to clear `partner_id`, `extend_code` or `shop_partner_id`.\n","properties":{"partner_id":{"type":"integer","description":"Partner ID"},"cod":{"type":"integer","description":"Reconciliation COD"},"extend_code":{"type":"string","description":"Shipping order ID on partner system"},"total_fee":{"type":"integer","description":"Total fee"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"delivery_name":{"type":"string","description":"Shipper name"},"delivery_tel":{"type":"string","description":"Delivery phone"},"picked_up_at":{"type":"string","format":"date-time","description":"Picked up at"},"sort_code":{"type":"string","description":"Sort code"},"paid_at":{"type":"string","format":"date-time","description":"Paid at"},"system_created":{"type":"boolean","description":"System created"},"extend_update":{"type":"array","description":"Update from courier","items":{"type":"object","properties":{"key":{"type":"string","description":"Update key"},"status":{"type":"string","description":"Status"},"tracking_id":{"type":"string","description":"Partner extend code"},"note":{"type":"string","description":"Courier notes"},"update_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"partner_status":{"type":"string","nullable":true,"description":"Partner shipping status","enum":["waiting","request_received","processing_picked_up","picking_up","delay_pickup","picked_up","waiting_on_the_way","on_the_way","contact_delivery_company","out_for_delivery","delay_delivery","inform_recipient","undeliverable","waiting_for_return","delivered","delivered_cod","returning","returned","returned_cod","canceled"],"x-enum-descriptions":["Waiting for processing","Carrier received the request","Processing pickup","Picking up","Delayed pickup","Picked up","Waiting for transit","In transit","Contact the carrier","Out for delivery","Delayed delivery","Notify the recipient","Undeliverable","Waiting for return","Delivered","Delivered, COD reconciled","Returning","Returned","Returned, COD reconciled","Canceled"]},"partner_name":{"type":"string","nullable":true,"description":"Partner name"},"first_delivery_at":{"type":"string","format":"date-time","nullable":true,"description":"First delivery time"},"first_undeliverable_at":{"type":"string","format":"date-time","nullable":true,"description":"First failed delivery time"},"count_of_delivery":{"type":"integer","nullable":true,"minimum":0,"maximum":32767,"description":"Number of delivery attempts. Courier updates add 1 each time the shipment moves to `out_for_delivery` or `delay_delivery`.\nCan be set when creating or updating an order (integer 0-32767); omitted or invalid values keep the current value, and later courier updates keep counting from the value you set.\n","example":2},"order_number_vtp":{"type":"string","nullable":true,"description":"Viettel Post tracking number"},"printed_form":{"type":"object","nullable":true,"description":"Printed form"}}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"payment_purchase_histories":{"type":"array","description":"Payment histories","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount of money"},"type":{"type":"string","description":"Payment type"},"inserted_at":{"type":"string","format":"date-time","description":"Transaction time"},"result_code":{"type":"string","description":"Result code"},"ipn_reply":{"type":"boolean","description":"IPN reply"},"voucher_amount":{"type":"integer","description":"Voucher amount"},"tags":{"type":"array","description":"Tags","items":{"type":"string"}}}}},"tags":{"type":"array","description":"Tags list","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"}}}},"marketer":{"type":"object","description":"Marketer information","properties":{"id":{"type":"string","description":"Marketer ID"},"name":{"type":"string","description":"Marketer name"},"email":{"type":"string","description":"Marketer email"},"phone_number":{"type":"string","description":"Marketer phone number"},"fb_id":{"type":"string","description":"Marketer Facebook ID"},"avatar_url":{"type":"string","description":"Marketer avatar URL"}}},"pke_mkter":{"type":"string","description":"Marketer ID"},"activated_combo_products":{"type":"object","description":"Activated combo products information","properties":{"combo_product_id":{"type":"integer","description":"Combo product ID"},"quantity_combo_activated":{"type":"integer","description":"Quantity combo activated"},"combo_product_info":{"type":"object","description":"Combo product information"}}},"activated_promotion_advances":{"type":"array","description":"Activated promotion advances information","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"promotion_advance_id":{"type":"string","description":"Promotion advance ID"},"promotion_advance_info":{"type":"object","description":"Promotion advance information"}}}},"invoice_info_list":{"type":"array","description":"Invoice information list","items":{"type":"object","properties":{"error":{"type":"string","description":"Error message if any"},"invoice_detail":{"type":"object","description":"Invoice detail information. The fields to send depend on `invoice_type`:\n- `company`: use `company_name`, `company_tax_id`, `company_address`, `company_email` (and optionally `company_address_breakdown`).\n- `personal`: use `name`, `phone_number`, `identity_code`, `tax_id`, `email`.\n","properties":{"name":{"type":"string","description":"Full name of the individual requesting the invoice (`invoice_type` = `personal`)","example":"Hoang Anh"},"phone_number":{"type":"string","description":"Phone number of the individual (`invoice_type` = `personal`)","example":"0934283743"},"identity_code":{"type":"string","description":"Citizen identity card / ID number of the individual (`invoice_type` = `personal`)","example":"029374382740"},"tax_id":{"type":"string","description":"Personal tax ID of the individual, if any (`invoice_type` = `personal`)","example":""},"email":{"type":"string","description":"Email of the individual to receive the e-invoice (`invoice_type` = `personal`)","example":""},"company_address":{"type":"string","description":"Company address (`invoice_type` = `company`)"},"company_address_breakdown":{"type":"object","description":"Company address breakdown","properties":{"company_additional_info":{"type":"string","description":"Company additional information"},"company_barangay":{"type":"string","description":"Company barangay"},"company_city":{"type":"string","description":"Company city"},"company_detailed_address":{"type":"string","description":"Company detailed address"},"company_district":{"type":"string","description":"Company district"},"company_full_address":{"type":"string","description":"Company full address"},"company_postcode":{"type":"string","description":"Company postcode"},"company_province":{"type":"string","description":"Company province"},"company_region":{"type":"string","description":"Company region"},"company_state":{"type":"string","description":"Company state"},"company_town":{"type":"string","description":"Company town"}}},"company_email":{"type":"string","description":"Company email (`invoice_type` = `company`)"},"company_name":{"type":"string","description":"Company name (`invoice_type` = `company`)"},"company_tax_id":{"type":"string","description":"Company tax ID (`invoice_type` = `company`)"}}},"invoice_type":{"type":"string","enum":["company","personal"],"description":"Invoice type: `company` for an organization, `personal` for an individual.\nDetermines which `invoice_detail` fields are used.\n","example":"personal"},"is_requested":{"type":"boolean","description":"Customer requests an e-invoice for this order. Set `true` together with `invoice_type` and `invoice_detail` to request invoice issuance.","example":true},"order_sn":{"type":"string","description":"Order code on the marketplace"}}}},"reports_by_phone":{"type":"object","description":"Reports by phone number","properties":{"order_fail":{"type":"integer","description":"Number of failed orders"},"order_success":{"type":"integer","description":"Number of successful orders"},"warning":{"type":"integer","description":"Number of warnings orders"}},"example":{"+639175706297":{"order_fail":29,"order_success":20,"warning":0}}},"tracking_link":{"type":"string","description":"Link confirm order"},"payment_link":{"type":"string","description":"Payment link"},"ads_source":{"type":"string","description":"Advertising source"},"bank_payments":{"type":"object","description":"Payment method"},"transfer_proofs":{"type":"array","description":"Bank transfer payment proofs, including verification time, amount and receipt images","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transfer proof ID"},"order_id":{"type":"integer","description":"Order ID"},"shop_id":{"type":"integer","description":"Shop ID"},"payment_id":{"type":"string","description":"Bank payment method ID (matches a key in `bank_payments`)"},"amount":{"type":"integer","description":"Transferred amount"},"images":{"type":"array","description":"Transfer receipt images","items":{"type":"string"}},"note":{"type":"string","nullable":true,"description":"Note"},"is_income":{"type":"boolean","description":"Money received (true) or paid out (false)"},"is_verify":{"type":"boolean","description":"Whether the transfer has been verified"},"verify_at":{"type":"string","format":"date-time","nullable":true,"description":"Verification time"},"verifier":{"type":"object","nullable":true,"description":"Verifier information","properties":{"id":{"type":"string","description":"Verifier ID"},"name":{"type":"string","description":"Verifier name"},"fb_id":{"type":"string","description":"Facebook ID of verifier"},"avatar_url":{"type":"string","description":"Verifier avatar URL"}}},"creator":{"type":"object","nullable":true,"description":"Creator information","properties":{"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"last_editor":{"type":"object","nullable":true,"description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Editor name"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"avatar_url":{"type":"string","description":"Editor avatar URL"}}},"order_info":{"type":"object","nullable":true,"description":"Additional order information"},"inserted_at":{"type":"string","format":"date-time","description":"Transfer proof creation time"},"updated_at":{"type":"string","format":"date-time","description":"Transfer proof update time"}}}},"shopify_order_id":{"type":"string","description":"Shopify order ID"},"shopify_abandon_checkout_id":{"type":"integer","description":"Shopify abandon checkout ID"},"is_abandoned_order":{"type":"boolean","description":"Abandoned-cart flag for creating or updating an order. Send it directly in the request body, not inside `third_party` or `third_party_infomation`.\nAn 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.\nOnly boolean `true` or string `\"true\"` is normalized to `true`; all other submitted values become `false`.\n","example":true},"cod":{"type":"integer","description":"Cash on delivery"},"cash":{"type":"integer","description":"Cash payment"},"account":{"type":"integer","description":"Order source ID"},"account_name":{"type":"string","description":"Order source name"},"advanced_platform_fee":{"type":"object","description":"Fees from e-commerce platforms","properties":{"ads_top_up":{"type":"integer","description":"Ads wallet top-up"},"affiliate_commission":{"type":"integer","description":"Affiliate commission"},"diff_shipping_fee":{"type":"integer","description":"Difference shipping fee"},"marketplace_voucher":{"type":"integer","description":"Marketplace voucher"},"payment_fee":{"type":"integer","description":"Payment fee"},"platform_commission":{"type":"integer","description":"Platform commission"},"seller_transaction_fee":{"type":"integer","description":"Seller transaction fee"},"service_fee":{"type":"integer","description":"Service fee"},"sfp_service_fee":{"type":"integer","description":"SFP service fee"}}},"printing_count":{"type":"integer","description":"Printing count"},"money_to_collect":{"type":"integer","description":"Money to collect"},"marketplace_id":{"type":"string","description":"Marketplace ID","enum":["-2","-3","-4","-9","-16","-17","-20","-25","-27","-28"],"x-enum-descriptions":{"-2":"Tiki","-3":"Shopee","-4":"Lazada","-9":"TikTok","-16":"WooCommerce","-17":"Shopify","-20":"Line Shopping","-25":"Tokopedia","-27":"Mercado Libre","-28":"Tiendanube"}},"total_price":{"type":"integer","description":"Total price"},"shop_customer_address_id":{"type":"string","description":"Customer address ID"},"customer":{"type":"object","description":"Customer information","properties":{"fb_id":{"type":"string","description":"Customer Facebook ID"},"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Customer name"},"page_id":{"type":"string","description":"Page ID"}}},"total_quantity":{"type":"integer","description":"Total quantity"},"time_assign_marketer":{"type":"string","format":"date-time","description":"Time assign marketer"},"p_utm_source":{"type":"string","description":"UTM Source"},"p_utm_medium":{"type":"string","description":"UTM Medium"},"p_utm_campaign":{"type":"string","description":"UTM Campaign"},"p_utm_term":{"type":"string","description":"UTM Term"},"p_utm_content":{"type":"string","description":"UTM Content"},"p_utm_id":{"type":"string","description":"UTM ID"},"utm_affiliate":{"type":"string","description":"Affiliate"},"link":{"type":"string","description":"Link"},"status_history":{"type":"array","description":"Status update history","items":{"type":"object","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"editor":{"type":"object","description":"Editor information"},"editor_fb":{"type":"string","description":"Editor Facebook ID"},"editor_id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Name"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Status"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"duplicated_phone":{"type":"boolean","description":"Duplicated phone"},"order_currency":{"type":"string","description":"Order currency"},"charged_by_vnpay":{"type":"integer","description":"Charged by VNPay"},"charged_by_qrpay":{"type":"integer","description":"Charged by QRPay"},"custom_id":{"type":"string","description":"Custom ID"},"last_editor":{"type":"object","description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"name":{"type":"string","description":"Editor name"},"email":{"type":"string","description":"Editor email"},"avatar_url":{"type":"string","description":"Editor avatar URL"},"phone_number":{"type":"string","description":"Editor phone number"}}},"last_editor_id":{"type":"string","description":"Last editor ID"},"charged_by_momo":{"type":"integer","description":"Charged by MoMo"},"prepaid_by_point":{"type":"object","description":"Prepaid by point","properties":{"money":{"type":"integer","description":"Money amount","example":15000},"point":{"type":"integer","description":"Point amount","example":15}},"example":{"money":15000,"point":15}},"bank_transfer_images":{"type":"array","description":"Bank transfer images","items":{"type":"string","format":"uri"}},"transfer_money":{"type":"integer","description":"Transfer money"},"lock_order_by_user":{"type":"string","description":"Lock order by user ID"},"assigning_care":{"type":"object","description":"Assigning care information","properties":{"id":{"type":"string","description":"Care ID"},"fb_id":{"type":"string","description":"Facebook ID of care"},"name":{"type":"string","description":"Care name"},"email":{"type":"string","description":"Care email"},"avatar_url":{"type":"string","description":"Care avatar URL"},"phone_number":{"type":"string","description":"Care phone number"}}},"assigning_care_id":{"type":"string","description":"Assigning care ID"},"time_assign_care":{"type":"string","format":"date-time","description":"Time assign care"},"assigning_seller":{"type":"object","description":"Assigning seller information","properties":{"id":{"type":"string","description":"Seller ID"},"fb_id":{"type":"string","description":"Facebook ID of seller"},"name":{"type":"string","description":"Seller name"},"email":{"type":"string","description":"Seller email"},"avatar_url":{"type":"string","description":"Seller avatar URL"},"phone_number":{"type":"string","description":"Seller phone number"}}},"einvoices":{"type":"array","items":{"$ref":"#/components/schemas/EInvoice"}},"charged_by_card":{"type":"integer","description":"Charged by card"},"estimate_delivery_date":{"type":"string","format":"date-time","description":"Estimate delivery date"},"order_sources":{"type":"string","description":"Order sources ID"},"charged_by_fundiin":{"type":"integer","description":"Charged by Fundiin"},"surcharge":{"type":"integer","description":"Surcharge"},"is_linked_partner":{"type":"boolean","description":"Is linked partner"},"call_laters":{"type":"array","description":"Call laters","items":{"type":"object"}},"last_update_status_at":{"type":"string","format":"date-time","description":"Last update status at"},"discount_by_customer_level":{"type":"integer","description":"Discount by customer level"},"viewing":{"type":"array","description":"Viewing","items":{"type":"object"}},"additional_info":{"type":"object","description":"Additional info","properties":{"service_partner":{"type":"string","description":"Service partner","enum":["instant"],"x-enum-descriptions":["Instant"]},"delivery_deadline":{"type":"string","format":"date-time","description":"Delivery deadline (ISO8601, no timezone).","example":"2026-06-03T10:00:00"},"ship_by_date":{"type":"integer","nullable":true,"readOnly":true,"description":"Marketplace ship-by deadline (Unix timestamp, seconds) for Shopee/TikTok orders — the order must be handed over to the carrier before this time, otherwise the marketplace may cancel it automatically. Shopee `ship_by_date`, TikTok `collection_due_time`. `0` = the marketplace has not returned it yet; `null` for non-marketplace orders.","example":1793000000}}},"order_returned_ids":{"type":"string","description":"Order returned IDs"},"cost_surcharge":{"type":"integer","description":"Cost surcharge"},"time_send_partner":{"type":"string","format":"date-time","description":"Time send partner"},"charged_by_kredivo":{"type":"integer","description":"Charged by Kredivo"},"discount":{"type":"integer","description":"Discount"},"histories":{"type":"array","description":"Histories","items":{"type":"object"}},"duplicated_customer":{"type":"boolean","description":"Duplicated customer"},"customer_referral_code":{"type":"object","description":"Customer referral code","properties":{"active":{"type":"string","description":"Active status","example":"true"},"customer_id":{"type":"string","format":"uuid","description":"Customer ID","example":"09bb9399-45f3-4897-a53a-85dde2f886fe"},"discount":{"type":"string","description":"Discount value","example":"10"},"format":{"type":"string","description":"Referral code format","example":"{PHONE_NUMBER}"},"free_products_priced_between_approx":{"type":"object","description":"Free products priced between approximately","properties":{"active":{"type":"string","description":"Active status","example":"true"},"operator":{"type":"string","description":"Comparison operator","example":"GreaterOrEqual"},"price":{"type":"string","description":"Price threshold","example":"150000"}}},"is_percent":{"type":"string","description":"Discount is percentage","example":"true"},"only_customers_with_level_will_have_referral_code":{"type":"string","description":"Only customers with level will have referral code","example":"true"},"referral_code":{"type":"string","description":"Referral code","example":"982843759"},"reward_points_for_old_customers":{"type":"object","description":"Reward points for customers","properties":{"active":{"type":"string","description":"Active status","example":"true"},"money":{"type":"string","description":"Money reward","example":"10000"},"point":{"type":"string","description":"Point reward","example":"1"}}},"shop_customer_id":{"type":"string","format":"uuid","description":"Shop customer ID","example":"f8160a4c-dfa7-4ee8-b540-d245755ea1f1"}},"example":{"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"}},"tax":{"type":"integer","description":"Tax"},"is_from_ecommerce":{"type":"boolean","description":"Is from e-commerce"},"note_image":{"type":"array","description":"Note images","items":{"type":"string","format":"uri"}},"shopify_draft_order_id":{"type":"string","description":"Shopify draft order ID"},"display_id":{"type":"integer","description":"Display ID"},"shop_partner_id":{"type":"integer","description":"Shop partner ID"},"is_locked":{"type":"boolean","description":"Order lock"},"merge_order":{"type":"boolean","description":"Allows merging orders"}}}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"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}}}}}}}},"post":{"summary":"Create order","x-summary-i18n":{"vie":"Tạo đơn hàng"},"description":"Create order","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Order information to create","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Order ID"},"system_id":{"type":"integer","description":"System ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Order creation time"},"updated_at":{"type":"string","format":"date-time","description":"Order update time"},"status":{"type":"integer","description":"Order status","enum":[0,17,11,12,13,20,1,8,9,2,3,16,4,15,5,6,7],"x-enum-descriptions":["New","Waiting for confirmation","Restocking","Wait for printing","Printed","Purchased","Confirmed","Packaging","Waiting for pick up","Shipped","Received","Collected money","Returning","Partial return","Returned","Canceled","Deleted recently"]},"status_name":{"type":"string","description":"Order status name"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"bill_email":{"type":"string","description":"Customer email"},"conversation_id":{"type":"string","description":"Conversation ID"},"page_id":{"type":"string","description":"Facebook page ID"},"post_id":{"type":"string","description":"Post ID"},"ad_id":{"type":"string","description":"Ad ID"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"partner_fee":{"type":"integer","description":"Fee from shipping partner"},"fee_marketplace":{"type":"integer","description":"Fees from e-commerce platforms"},"customer_pay_fee":{"type":"boolean","description":"Customer pay shipping fee"},"is_free_shipping":{"type":"boolean","description":"Free shipping"},"is_livestream":{"type":"boolean","description":"Is livestream order"},"is_live_shopping":{"type":"boolean","description":"Is live shopping order"},"is_smc":{"type":"boolean","description":"Shopping on Messenger"},"received_at_shop":{"type":"boolean","description":"true: Sales at counter, false: Sell online"},"total_discount":{"type":"integer","description":"Discount total"},"note":{"type":"string","description":"Internal note"},"note_print":{"type":"string","description":"Note for printing"},"returned_reason":{"type":"integer","description":"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_name":{"type":"string","description":"Return reason name"},"sub_status":{"type":"integer","description":"Reason for delivery delay"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"warehouse_info":{"type":"object","description":"Warehouse information","properties":{"name":{"type":"string","description":"Warehouse name"},"phone_number":{"type":"string","description":"Warehouse phone number"},"full_address":{"type":"string","description":"Warehouse full address"},"address":{"type":"string","description":"Warehouse address"},"province_id":{"type":"string","description":"Province ID"},"district_id":{"type":"string","description":"District ID"},"commune_id":{"type":"string","description":"Commune ID"},"affiliate_id":{"type":"string","description":"Affiliate ID"},"ffm_id":{"type":"string","description":"FFM ID"},"has_snappy_service":{"type":"boolean","description":"Has Snappy service"},"custom_id":{"type":"string","description":"Custom ID"}}},"creator_id":{"type":"string","description":"Creator ID"},"creator":{"type":"object","description":"Order creator","properties":{"id":{"type":"string","description":"Creator ID"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"name":{"type":"string","description":"Creator name"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"items":{"type":"array","description":"Product list","items":{"type":"object","required":["variation_id","quantity"],"properties":{"product_id":{"type":"string","description":"Product ID"},"quantity":{"type":"integer","description":"Quantity"},"returned_count":{"type":"integer","description":"Returned count"},"assigning_seller_id":{"type":"string","description":"Assigning seller ID"},"quantity_by_combo_products":{"type":"array","description":"Quantity by combo products","items":{"type":"object"}},"discount_each_product":{"type":"integer","description":"Discount for each product"},"is_bonus_product":{"type":"boolean","description":"Is bonus product"},"is_discount_percent":{"type":"boolean","description":"Is discount by percent"},"is_wholesale":{"type":"boolean","description":"Is wholesale"},"is_composite":{"type":"boolean","description":"Is composite product"},"one_time_product":{"type":"boolean","description":"One time product"},"note":{"type":"string","description":"Product note"},"note_product":{"type":"string","description":"Product note"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"measure_group_id":{"type":"integer","description":"Measure group ID"},"variation_info":{"type":"object","description":"Variation information. Optional when creating/updating an order (the backend defaults it to an empty object if omitted). Its inner fields are not individually required, but sending `retail_price` is recommended so the line price is correct.","properties":{"id":{"type":"string","description":"Variation ID"},"name":{"type":"string","description":"Product name"},"product_id":{"type":"string","description":"Product ID"},"retail_price":{"type":"integer","description":"Retail price. Not strictly required, but recommended when creating/updating an order so the line price is correct."},"detail":{"type":"string","description":"Variation detail"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"},"keyValue":{"type":"string","description":"Key value"}}}},"barcode":{"type":"string","description":"Barcode"},"brand_id":{"type":"string","description":"Brand ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"display_id":{"type":"string","description":"Display ID"},"product_display_id":{"type":"string","description":"Product display ID"},"last_imported_price":{"type":"integer","description":"Last imported price"},"is_upsale_product":{"type":"boolean","description":"Upsale product"},"weight":{"type":"integer","description":"Weight"},"measure_info":{"type":"object","description":"Measure information","properties":{"measure_id":{"type":"integer","description":"Measure ID"},"exchange_value":{"type":"integer","description":"Exchange value"}}},"avg_price":{"type":"integer","description":"Average import price"}}},"components":{"type":"array","description":"Product components","items":{"type":"object","properties":{"component_id":{"type":"string","description":"Component ID"},"quantity":{"type":"integer","description":"Quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information"}}}},"variation_id":{"type":"string","description":"Variation ID (SKU of the variation can also be used)"}}}},"partner":{"type":"object","description":"Partner information\nWhen updating an order that already has shipping info, only the fields you send are written; omitted fields keep their current values. Send `null` to clear `partner_id`, `extend_code` or `shop_partner_id`.\n","properties":{"partner_id":{"type":"integer","description":"Partner ID"},"cod":{"type":"integer","description":"Reconciliation COD"},"extend_code":{"type":"string","description":"Shipping order ID on partner system"},"total_fee":{"type":"integer","description":"Total fee"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"delivery_name":{"type":"string","description":"Shipper name"},"delivery_tel":{"type":"string","description":"Delivery phone"},"picked_up_at":{"type":"string","format":"date-time","description":"Picked up at"},"sort_code":{"type":"string","description":"Sort code"},"paid_at":{"type":"string","format":"date-time","description":"Paid at"},"system_created":{"type":"boolean","description":"System created"},"extend_update":{"type":"array","description":"Update from courier","items":{"type":"object","properties":{"key":{"type":"string","description":"Update key"},"status":{"type":"string","description":"Status"},"tracking_id":{"type":"string","description":"Partner extend code"},"note":{"type":"string","description":"Courier notes"},"update_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"partner_status":{"type":"string","nullable":true,"description":"Partner shipping status","enum":["waiting","request_received","processing_picked_up","picking_up","delay_pickup","picked_up","waiting_on_the_way","on_the_way","contact_delivery_company","out_for_delivery","delay_delivery","inform_recipient","undeliverable","waiting_for_return","delivered","delivered_cod","returning","returned","returned_cod","canceled"],"x-enum-descriptions":["Waiting for processing","Carrier received the request","Processing pickup","Picking up","Delayed pickup","Picked up","Waiting for transit","In transit","Contact the carrier","Out for delivery","Delayed delivery","Notify the recipient","Undeliverable","Waiting for return","Delivered","Delivered, COD reconciled","Returning","Returned","Returned, COD reconciled","Canceled"]},"partner_name":{"type":"string","nullable":true,"description":"Partner name"},"first_delivery_at":{"type":"string","format":"date-time","nullable":true,"description":"First delivery time"},"first_undeliverable_at":{"type":"string","format":"date-time","nullable":true,"description":"First failed delivery time"},"count_of_delivery":{"type":"integer","nullable":true,"minimum":0,"maximum":32767,"description":"Number of delivery attempts. Courier updates add 1 each time the shipment moves to `out_for_delivery` or `delay_delivery`.\nCan be set when creating or updating an order (integer 0-32767); omitted or invalid values keep the current value, and later courier updates keep counting from the value you set.\n","example":2},"order_number_vtp":{"type":"string","nullable":true,"description":"Viettel Post tracking number"},"printed_form":{"type":"object","nullable":true,"description":"Printed form"}}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"payment_purchase_histories":{"type":"array","description":"Payment histories","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount of money"},"type":{"type":"string","description":"Payment type"},"inserted_at":{"type":"string","format":"date-time","description":"Transaction time"},"result_code":{"type":"string","description":"Result code"},"ipn_reply":{"type":"boolean","description":"IPN reply"},"voucher_amount":{"type":"integer","description":"Voucher amount"},"tags":{"type":"array","description":"Tags","items":{"type":"string"}}}}},"tags":{"type":"array","description":"Tags list","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"}}}},"marketer":{"type":"object","description":"Marketer information","properties":{"id":{"type":"string","description":"Marketer ID"},"name":{"type":"string","description":"Marketer name"},"email":{"type":"string","description":"Marketer email"},"phone_number":{"type":"string","description":"Marketer phone number"},"fb_id":{"type":"string","description":"Marketer Facebook ID"},"avatar_url":{"type":"string","description":"Marketer avatar URL"}}},"pke_mkter":{"type":"string","description":"Marketer ID"},"activated_combo_products":{"type":"object","description":"Activated combo products information","properties":{"combo_product_id":{"type":"integer","description":"Combo product ID"},"quantity_combo_activated":{"type":"integer","description":"Quantity combo activated"},"combo_product_info":{"type":"object","description":"Combo product information"}}},"activated_promotion_advances":{"type":"array","description":"Activated promotion advances information","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"promotion_advance_id":{"type":"string","description":"Promotion advance ID"},"promotion_advance_info":{"type":"object","description":"Promotion advance information"}}}},"invoice_info_list":{"type":"array","description":"Invoice information list","items":{"type":"object","properties":{"error":{"type":"string","description":"Error message if any"},"invoice_detail":{"type":"object","description":"Invoice detail information. The fields to send depend on `invoice_type`:\n- `company`: use `company_name`, `company_tax_id`, `company_address`, `company_email` (and optionally `company_address_breakdown`).\n- `personal`: use `name`, `phone_number`, `identity_code`, `tax_id`, `email`.\n","properties":{"name":{"type":"string","description":"Full name of the individual requesting the invoice (`invoice_type` = `personal`)","example":"Hoang Anh"},"phone_number":{"type":"string","description":"Phone number of the individual (`invoice_type` = `personal`)","example":"0934283743"},"identity_code":{"type":"string","description":"Citizen identity card / ID number of the individual (`invoice_type` = `personal`)","example":"029374382740"},"tax_id":{"type":"string","description":"Personal tax ID of the individual, if any (`invoice_type` = `personal`)","example":""},"email":{"type":"string","description":"Email of the individual to receive the e-invoice (`invoice_type` = `personal`)","example":""},"company_address":{"type":"string","description":"Company address (`invoice_type` = `company`)"},"company_address_breakdown":{"type":"object","description":"Company address breakdown","properties":{"company_additional_info":{"type":"string","description":"Company additional information"},"company_barangay":{"type":"string","description":"Company barangay"},"company_city":{"type":"string","description":"Company city"},"company_detailed_address":{"type":"string","description":"Company detailed address"},"company_district":{"type":"string","description":"Company district"},"company_full_address":{"type":"string","description":"Company full address"},"company_postcode":{"type":"string","description":"Company postcode"},"company_province":{"type":"string","description":"Company province"},"company_region":{"type":"string","description":"Company region"},"company_state":{"type":"string","description":"Company state"},"company_town":{"type":"string","description":"Company town"}}},"company_email":{"type":"string","description":"Company email (`invoice_type` = `company`)"},"company_name":{"type":"string","description":"Company name (`invoice_type` = `company`)"},"company_tax_id":{"type":"string","description":"Company tax ID (`invoice_type` = `company`)"}}},"invoice_type":{"type":"string","enum":["company","personal"],"description":"Invoice type: `company` for an organization, `personal` for an individual.\nDetermines which `invoice_detail` fields are used.\n","example":"personal"},"is_requested":{"type":"boolean","description":"Customer requests an e-invoice for this order. Set `true` together with `invoice_type` and `invoice_detail` to request invoice issuance.","example":true},"order_sn":{"type":"string","description":"Order code on the marketplace"}}}},"reports_by_phone":{"type":"object","description":"Reports by phone number","properties":{"order_fail":{"type":"integer","description":"Number of failed orders"},"order_success":{"type":"integer","description":"Number of successful orders"},"warning":{"type":"integer","description":"Number of warnings orders"}},"example":{"+639175706297":{"order_fail":29,"order_success":20,"warning":0}}},"tracking_link":{"type":"string","description":"Link confirm order"},"payment_link":{"type":"string","description":"Payment link"},"ads_source":{"type":"string","description":"Advertising source"},"bank_payments":{"type":"object","description":"Payment method"},"transfer_proofs":{"type":"array","description":"Bank transfer payment proofs, including verification time, amount and receipt images","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transfer proof ID"},"order_id":{"type":"integer","description":"Order ID"},"shop_id":{"type":"integer","description":"Shop ID"},"payment_id":{"type":"string","description":"Bank payment method ID (matches a key in `bank_payments`)"},"amount":{"type":"integer","description":"Transferred amount"},"images":{"type":"array","description":"Transfer receipt images","items":{"type":"string"}},"note":{"type":"string","nullable":true,"description":"Note"},"is_income":{"type":"boolean","description":"Money received (true) or paid out (false)"},"is_verify":{"type":"boolean","description":"Whether the transfer has been verified"},"verify_at":{"type":"string","format":"date-time","nullable":true,"description":"Verification time"},"verifier":{"type":"object","nullable":true,"description":"Verifier information","properties":{"id":{"type":"string","description":"Verifier ID"},"name":{"type":"string","description":"Verifier name"},"fb_id":{"type":"string","description":"Facebook ID of verifier"},"avatar_url":{"type":"string","description":"Verifier avatar URL"}}},"creator":{"type":"object","nullable":true,"description":"Creator information","properties":{"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"last_editor":{"type":"object","nullable":true,"description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Editor name"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"avatar_url":{"type":"string","description":"Editor avatar URL"}}},"order_info":{"type":"object","nullable":true,"description":"Additional order information"},"inserted_at":{"type":"string","format":"date-time","description":"Transfer proof creation time"},"updated_at":{"type":"string","format":"date-time","description":"Transfer proof update time"}}}},"shopify_order_id":{"type":"string","description":"Shopify order ID"},"shopify_abandon_checkout_id":{"type":"integer","description":"Shopify abandon checkout ID"},"is_abandoned_order":{"type":"boolean","description":"Abandoned-cart flag for creating or updating an order. Send it directly in the request body, not inside `third_party` or `third_party_infomation`.\nAn 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.\nOnly boolean `true` or string `\"true\"` is normalized to `true`; all other submitted values become `false`.\n","example":true},"cod":{"type":"integer","description":"Cash on delivery"},"cash":{"type":"integer","description":"Cash payment"},"account":{"type":"integer","description":"Order source ID"},"account_name":{"type":"string","description":"Order source name"},"advanced_platform_fee":{"type":"object","description":"Fees from e-commerce platforms","properties":{"ads_top_up":{"type":"integer","description":"Ads wallet top-up"},"affiliate_commission":{"type":"integer","description":"Affiliate commission"},"diff_shipping_fee":{"type":"integer","description":"Difference shipping fee"},"marketplace_voucher":{"type":"integer","description":"Marketplace voucher"},"payment_fee":{"type":"integer","description":"Payment fee"},"platform_commission":{"type":"integer","description":"Platform commission"},"seller_transaction_fee":{"type":"integer","description":"Seller transaction fee"},"service_fee":{"type":"integer","description":"Service fee"},"sfp_service_fee":{"type":"integer","description":"SFP service fee"}}},"printing_count":{"type":"integer","description":"Printing count"},"money_to_collect":{"type":"integer","description":"Money to collect"},"marketplace_id":{"type":"string","description":"Marketplace ID","enum":["-2","-3","-4","-9","-16","-17","-20","-25","-27","-28"],"x-enum-descriptions":{"-2":"Tiki","-3":"Shopee","-4":"Lazada","-9":"TikTok","-16":"WooCommerce","-17":"Shopify","-20":"Line Shopping","-25":"Tokopedia","-27":"Mercado Libre","-28":"Tiendanube"}},"total_price":{"type":"integer","description":"Total price"},"shop_customer_address_id":{"type":"string","description":"Customer address ID"},"customer":{"type":"object","description":"Customer information","properties":{"fb_id":{"type":"string","description":"Customer Facebook ID"},"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Customer name"},"page_id":{"type":"string","description":"Page ID"}}},"total_quantity":{"type":"integer","description":"Total quantity"},"time_assign_marketer":{"type":"string","format":"date-time","description":"Time assign marketer"},"p_utm_source":{"type":"string","description":"UTM Source"},"p_utm_medium":{"type":"string","description":"UTM Medium"},"p_utm_campaign":{"type":"string","description":"UTM Campaign"},"p_utm_term":{"type":"string","description":"UTM Term"},"p_utm_content":{"type":"string","description":"UTM Content"},"p_utm_id":{"type":"string","description":"UTM ID"},"utm_affiliate":{"type":"string","description":"Affiliate"},"link":{"type":"string","description":"Link"},"status_history":{"type":"array","description":"Status update history","items":{"type":"object","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"editor":{"type":"object","description":"Editor information"},"editor_fb":{"type":"string","description":"Editor Facebook ID"},"editor_id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Name"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Status"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"duplicated_phone":{"type":"boolean","description":"Duplicated phone"},"order_currency":{"type":"string","description":"Order currency"},"charged_by_vnpay":{"type":"integer","description":"Charged by VNPay"},"charged_by_qrpay":{"type":"integer","description":"Charged by QRPay"},"custom_id":{"type":"string","description":"Custom ID"},"last_editor":{"type":"object","description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"name":{"type":"string","description":"Editor name"},"email":{"type":"string","description":"Editor email"},"avatar_url":{"type":"string","description":"Editor avatar URL"},"phone_number":{"type":"string","description":"Editor phone number"}}},"last_editor_id":{"type":"string","description":"Last editor ID"},"charged_by_momo":{"type":"integer","description":"Charged by MoMo"},"prepaid_by_point":{"type":"object","description":"Prepaid by point","properties":{"money":{"type":"integer","description":"Money amount","example":15000},"point":{"type":"integer","description":"Point amount","example":15}},"example":{"money":15000,"point":15}},"bank_transfer_images":{"type":"array","description":"Bank transfer images","items":{"type":"string","format":"uri"}},"transfer_money":{"type":"integer","description":"Transfer money"},"lock_order_by_user":{"type":"string","description":"Lock order by user ID"},"assigning_care":{"type":"object","description":"Assigning care information","properties":{"id":{"type":"string","description":"Care ID"},"fb_id":{"type":"string","description":"Facebook ID of care"},"name":{"type":"string","description":"Care name"},"email":{"type":"string","description":"Care email"},"avatar_url":{"type":"string","description":"Care avatar URL"},"phone_number":{"type":"string","description":"Care phone number"}}},"assigning_care_id":{"type":"string","description":"Assigning care ID"},"time_assign_care":{"type":"string","format":"date-time","description":"Time assign care"},"assigning_seller":{"type":"object","description":"Assigning seller information","properties":{"id":{"type":"string","description":"Seller ID"},"fb_id":{"type":"string","description":"Facebook ID of seller"},"name":{"type":"string","description":"Seller name"},"email":{"type":"string","description":"Seller email"},"avatar_url":{"type":"string","description":"Seller avatar URL"},"phone_number":{"type":"string","description":"Seller phone number"}}},"einvoices":{"type":"array","items":{"$ref":"#/components/schemas/EInvoice"}},"charged_by_card":{"type":"integer","description":"Charged by card"},"estimate_delivery_date":{"type":"string","format":"date-time","description":"Estimate delivery date"},"order_sources":{"type":"string","description":"Order sources ID"},"charged_by_fundiin":{"type":"integer","description":"Charged by Fundiin"},"surcharge":{"type":"integer","description":"Surcharge"},"is_linked_partner":{"type":"boolean","description":"Is linked partner"},"call_laters":{"type":"array","description":"Call laters","items":{"type":"object"}},"last_update_status_at":{"type":"string","format":"date-time","description":"Last update status at"},"discount_by_customer_level":{"type":"integer","description":"Discount by customer level"},"viewing":{"type":"array","description":"Viewing","items":{"type":"object"}},"additional_info":{"type":"object","description":"Additional info","properties":{"service_partner":{"type":"string","description":"Service partner","enum":["instant"],"x-enum-descriptions":["Instant"]},"delivery_deadline":{"type":"string","format":"date-time","description":"Delivery deadline (ISO8601, no timezone).","example":"2026-06-03T10:00:00"},"ship_by_date":{"type":"integer","nullable":true,"readOnly":true,"description":"Marketplace ship-by deadline (Unix timestamp, seconds) for Shopee/TikTok orders — the order must be handed over to the carrier before this time, otherwise the marketplace may cancel it automatically. Shopee `ship_by_date`, TikTok `collection_due_time`. `0` = the marketplace has not returned it yet; `null` for non-marketplace orders.","example":1793000000}}},"order_returned_ids":{"type":"string","description":"Order returned IDs"},"cost_surcharge":{"type":"integer","description":"Cost surcharge"},"time_send_partner":{"type":"string","format":"date-time","description":"Time send partner"},"charged_by_kredivo":{"type":"integer","description":"Charged by Kredivo"},"discount":{"type":"integer","description":"Discount"},"histories":{"type":"array","description":"Histories","items":{"type":"object"}},"duplicated_customer":{"type":"boolean","description":"Duplicated customer"},"customer_referral_code":{"type":"object","description":"Customer referral code","properties":{"active":{"type":"string","description":"Active status","example":"true"},"customer_id":{"type":"string","format":"uuid","description":"Customer ID","example":"09bb9399-45f3-4897-a53a-85dde2f886fe"},"discount":{"type":"string","description":"Discount value","example":"10"},"format":{"type":"string","description":"Referral code format","example":"{PHONE_NUMBER}"},"free_products_priced_between_approx":{"type":"object","description":"Free products priced between approximately","properties":{"active":{"type":"string","description":"Active status","example":"true"},"operator":{"type":"string","description":"Comparison operator","example":"GreaterOrEqual"},"price":{"type":"string","description":"Price threshold","example":"150000"}}},"is_percent":{"type":"string","description":"Discount is percentage","example":"true"},"only_customers_with_level_will_have_referral_code":{"type":"string","description":"Only customers with level will have referral code","example":"true"},"referral_code":{"type":"string","description":"Referral code","example":"982843759"},"reward_points_for_old_customers":{"type":"object","description":"Reward points for customers","properties":{"active":{"type":"string","description":"Active status","example":"true"},"money":{"type":"string","description":"Money reward","example":"10000"},"point":{"type":"string","description":"Point reward","example":"1"}}},"shop_customer_id":{"type":"string","format":"uuid","description":"Shop customer ID","example":"f8160a4c-dfa7-4ee8-b540-d245755ea1f1"}},"example":{"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"}},"tax":{"type":"integer","description":"Tax"},"is_from_ecommerce":{"type":"boolean","description":"Is from e-commerce"},"note_image":{"type":"array","description":"Note images","items":{"type":"string","format":"uri"}},"shopify_draft_order_id":{"type":"string","description":"Shopify draft order ID"},"display_id":{"type":"integer","description":"Display ID"},"shop_partner_id":{"type":"integer","description":"Shop partner ID"},"is_locked":{"type":"boolean","description":"Order lock"},"merge_order":{"type":"boolean","description":"Allows merging orders"}},"required":["shop_id"]},"example":{"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}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Order ID"},"system_id":{"type":"integer","description":"System ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Order creation time"},"updated_at":{"type":"string","format":"date-time","description":"Order update time"},"status":{"type":"integer","description":"Order status","enum":[0,17,11,12,13,20,1,8,9,2,3,16,4,15,5,6,7],"x-enum-descriptions":["New","Waiting for confirmation","Restocking","Wait for printing","Printed","Purchased","Confirmed","Packaging","Waiting for pick up","Shipped","Received","Collected money","Returning","Partial return","Returned","Canceled","Deleted recently"]},"status_name":{"type":"string","description":"Order status name"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"bill_email":{"type":"string","description":"Customer email"},"conversation_id":{"type":"string","description":"Conversation ID"},"page_id":{"type":"string","description":"Facebook page ID"},"post_id":{"type":"string","description":"Post ID"},"ad_id":{"type":"string","description":"Ad ID"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"partner_fee":{"type":"integer","description":"Fee from shipping partner"},"fee_marketplace":{"type":"integer","description":"Fees from e-commerce platforms"},"customer_pay_fee":{"type":"boolean","description":"Customer pay shipping fee"},"is_free_shipping":{"type":"boolean","description":"Free shipping"},"is_livestream":{"type":"boolean","description":"Is livestream order"},"is_live_shopping":{"type":"boolean","description":"Is live shopping order"},"is_smc":{"type":"boolean","description":"Shopping on Messenger"},"received_at_shop":{"type":"boolean","description":"true: Sales at counter, false: Sell online"},"total_discount":{"type":"integer","description":"Discount total"},"note":{"type":"string","description":"Internal note"},"note_print":{"type":"string","description":"Note for printing"},"returned_reason":{"type":"integer","description":"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_name":{"type":"string","description":"Return reason name"},"sub_status":{"type":"integer","description":"Reason for delivery delay"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"warehouse_info":{"type":"object","description":"Warehouse information","properties":{"name":{"type":"string","description":"Warehouse name"},"phone_number":{"type":"string","description":"Warehouse phone number"},"full_address":{"type":"string","description":"Warehouse full address"},"address":{"type":"string","description":"Warehouse address"},"province_id":{"type":"string","description":"Province ID"},"district_id":{"type":"string","description":"District ID"},"commune_id":{"type":"string","description":"Commune ID"},"affiliate_id":{"type":"string","description":"Affiliate ID"},"ffm_id":{"type":"string","description":"FFM ID"},"has_snappy_service":{"type":"boolean","description":"Has Snappy service"},"custom_id":{"type":"string","description":"Custom ID"}}},"creator_id":{"type":"string","description":"Creator ID"},"creator":{"type":"object","description":"Order creator","properties":{"id":{"type":"string","description":"Creator ID"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"name":{"type":"string","description":"Creator name"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"items":{"type":"array","description":"Product list. When creating or updating an order, each entry must include `variation_id` and `quantity`. `variation_info` is optional — if omitted, the backend treats it as an empty object; send it (with `retail_price`) when you need the line price to be explicit.","items":{"type":"object","required":["variation_id","quantity"],"properties":{"product_id":{"type":"string","description":"Product ID"},"quantity":{"type":"integer","description":"Quantity"},"returned_count":{"type":"integer","description":"Returned count"},"assigning_seller_id":{"type":"string","description":"Assigning seller ID"},"quantity_by_combo_products":{"type":"array","description":"Quantity by combo products","items":{"type":"object"}},"discount_each_product":{"type":"integer","description":"Discount for each product"},"is_bonus_product":{"type":"boolean","description":"Is bonus product"},"is_discount_percent":{"type":"boolean","description":"Is discount by percent"},"is_wholesale":{"type":"boolean","description":"Is wholesale"},"is_composite":{"type":"boolean","description":"Is composite product"},"one_time_product":{"type":"boolean","description":"One time product"},"note":{"type":"string","description":"Product note"},"note_product":{"type":"string","description":"Product note"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"measure_group_id":{"type":"integer","description":"Measure group ID"},"variation_info":{"type":"object","description":"Variation information. Optional when creating/updating an order (the backend defaults it to an empty object if omitted). Its inner fields are not individually required, but sending `retail_price` is recommended so the line price is correct.","properties":{"id":{"type":"string","description":"Variation ID"},"name":{"type":"string","description":"Product name"},"product_id":{"type":"string","description":"Product ID"},"retail_price":{"type":"integer","description":"Retail price. Not strictly required, but recommended when creating/updating an order so the line price is correct."},"detail":{"type":"string","description":"Variation detail"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"},"keyValue":{"type":"string","description":"Key value"}}}},"barcode":{"type":"string","description":"Barcode"},"brand_id":{"type":"string","description":"Brand ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"display_id":{"type":"string","description":"Display ID"},"product_display_id":{"type":"string","description":"Product display ID"},"last_imported_price":{"type":"integer","description":"Last imported price"},"is_upsale_product":{"type":"boolean","description":"Upsale product"},"weight":{"type":"integer","description":"Weight"},"measure_info":{"type":"object","description":"Measure information","properties":{"measure_id":{"type":"integer","description":"Measure ID"},"exchange_value":{"type":"integer","description":"Exchange value"}}},"avg_price":{"type":"integer","description":"Average import price"}}},"components":{"type":"array","description":"Product components","items":{"type":"object","properties":{"component_id":{"type":"string","description":"Component ID"},"quantity":{"type":"integer","description":"Quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information"}}}},"id":{"type":"integer","description":"Item ID"},"variation_id":{"type":"string","description":"Variation ID"}}}},"partner":{"type":"object","description":"Partner information\nWhen updating an order that already has shipping info, only the fields you send are written; omitted fields keep their current values. Send `null` to clear `partner_id`, `extend_code` or `shop_partner_id`.\n","properties":{"partner_id":{"type":"integer","description":"Partner ID"},"cod":{"type":"integer","description":"Reconciliation COD"},"extend_code":{"type":"string","description":"Shipping order ID on partner system"},"total_fee":{"type":"integer","description":"Total fee"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"delivery_name":{"type":"string","description":"Shipper name"},"delivery_tel":{"type":"string","description":"Delivery phone"},"picked_up_at":{"type":"string","format":"date-time","description":"Picked up at"},"sort_code":{"type":"string","description":"Sort code"},"paid_at":{"type":"string","format":"date-time","description":"Paid at"},"system_created":{"type":"boolean","description":"System created"},"extend_update":{"type":"array","description":"Update from courier","items":{"type":"object","properties":{"key":{"type":"string","description":"Update key"},"status":{"type":"string","description":"Status"},"tracking_id":{"type":"string","description":"Partner extend code"},"note":{"type":"string","description":"Courier notes"},"update_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"partner_status":{"type":"string","nullable":true,"description":"Partner shipping status","enum":["waiting","request_received","processing_picked_up","picking_up","delay_pickup","picked_up","waiting_on_the_way","on_the_way","contact_delivery_company","out_for_delivery","delay_delivery","inform_recipient","undeliverable","waiting_for_return","delivered","delivered_cod","returning","returned","returned_cod","canceled"],"x-enum-descriptions":["Waiting for processing","Carrier received the request","Processing pickup","Picking up","Delayed pickup","Picked up","Waiting for transit","In transit","Contact the carrier","Out for delivery","Delayed delivery","Notify the recipient","Undeliverable","Waiting for return","Delivered","Delivered, COD reconciled","Returning","Returned","Returned, COD reconciled","Canceled"]},"partner_name":{"type":"string","nullable":true,"description":"Partner name"},"first_delivery_at":{"type":"string","format":"date-time","nullable":true,"description":"First delivery time"},"first_undeliverable_at":{"type":"string","format":"date-time","nullable":true,"description":"First failed delivery time"},"count_of_delivery":{"type":"integer","nullable":true,"minimum":0,"maximum":32767,"description":"Number of delivery attempts. Courier updates add 1 each time the shipment moves to `out_for_delivery` or `delay_delivery`.\nCan be set when creating or updating an order (integer 0-32767); omitted or invalid values keep the current value, and later courier updates keep counting from the value you set.\n","example":2},"order_number_vtp":{"type":"string","nullable":true,"description":"Viettel Post tracking number"},"printed_form":{"type":"object","nullable":true,"description":"Printed form"}}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"payment_purchase_histories":{"type":"array","description":"Payment histories","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount of money"},"type":{"type":"string","description":"Payment type"},"inserted_at":{"type":"string","format":"date-time","description":"Transaction time"},"result_code":{"type":"string","description":"Result code"},"ipn_reply":{"type":"boolean","description":"IPN reply"},"voucher_amount":{"type":"integer","description":"Voucher amount"},"tags":{"type":"array","description":"Tags","items":{"type":"string"}}}}},"tags":{"type":"array","description":"Tags list","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"}}}},"marketer":{"type":"object","description":"Marketer information","properties":{"id":{"type":"string","description":"Marketer ID"},"name":{"type":"string","description":"Marketer name"},"email":{"type":"string","description":"Marketer email"},"phone_number":{"type":"string","description":"Marketer phone number"},"fb_id":{"type":"string","description":"Marketer Facebook ID"},"avatar_url":{"type":"string","description":"Marketer avatar URL"}}},"pke_mkter":{"type":"string","description":"Marketer ID"},"activated_combo_products":{"type":"object","description":"Activated combo products information","properties":{"combo_product_id":{"type":"integer","description":"Combo product ID"},"quantity_combo_activated":{"type":"integer","description":"Quantity combo activated"},"combo_product_info":{"type":"object","description":"Combo product information"}}},"activated_promotion_advances":{"type":"array","description":"Activated promotion advances information","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"promotion_advance_id":{"type":"string","description":"Promotion advance ID"},"promotion_advance_info":{"type":"object","description":"Promotion advance information"}}}},"invoice_info_list":{"type":"array","description":"Invoice information list","items":{"type":"object","properties":{"error":{"type":"string","description":"Error message if any"},"invoice_detail":{"type":"object","description":"Invoice detail information. The fields to send depend on `invoice_type`:\n- `company`: use `company_name`, `company_tax_id`, `company_address`, `company_email` (and optionally `company_address_breakdown`).\n- `personal`: use `name`, `phone_number`, `identity_code`, `tax_id`, `email`.\n","properties":{"name":{"type":"string","description":"Full name of the individual requesting the invoice (`invoice_type` = `personal`)","example":"Hoang Anh"},"phone_number":{"type":"string","description":"Phone number of the individual (`invoice_type` = `personal`)","example":"0934283743"},"identity_code":{"type":"string","description":"Citizen identity card / ID number of the individual (`invoice_type` = `personal`)","example":"029374382740"},"tax_id":{"type":"string","description":"Personal tax ID of the individual, if any (`invoice_type` = `personal`)","example":""},"email":{"type":"string","description":"Email of the individual to receive the e-invoice (`invoice_type` = `personal`)","example":""},"company_address":{"type":"string","description":"Company address (`invoice_type` = `company`)"},"company_address_breakdown":{"type":"object","description":"Company address breakdown","properties":{"company_additional_info":{"type":"string","description":"Company additional information"},"company_barangay":{"type":"string","description":"Company barangay"},"company_city":{"type":"string","description":"Company city"},"company_detailed_address":{"type":"string","description":"Company detailed address"},"company_district":{"type":"string","description":"Company district"},"company_full_address":{"type":"string","description":"Company full address"},"company_postcode":{"type":"string","description":"Company postcode"},"company_province":{"type":"string","description":"Company province"},"company_region":{"type":"string","description":"Company region"},"company_state":{"type":"string","description":"Company state"},"company_town":{"type":"string","description":"Company town"}}},"company_email":{"type":"string","description":"Company email (`invoice_type` = `company`)"},"company_name":{"type":"string","description":"Company name (`invoice_type` = `company`)"},"company_tax_id":{"type":"string","description":"Company tax ID (`invoice_type` = `company`)"}}},"invoice_type":{"type":"string","enum":["company","personal"],"description":"Invoice type: `company` for an organization, `personal` for an individual.\nDetermines which `invoice_detail` fields are used.\n","example":"personal"},"is_requested":{"type":"boolean","description":"Customer requests an e-invoice for this order. Set `true` together with `invoice_type` and `invoice_detail` to request invoice issuance.","example":true},"order_sn":{"type":"string","description":"Order code on the marketplace"}}}},"reports_by_phone":{"type":"object","description":"Reports by phone number","properties":{"order_fail":{"type":"integer","description":"Number of failed orders"},"order_success":{"type":"integer","description":"Number of successful orders"},"warning":{"type":"integer","description":"Number of warnings orders"}},"example":{"+639175706297":{"order_fail":29,"order_success":20,"warning":0}}},"tracking_link":{"type":"string","description":"Link confirm order"},"payment_link":{"type":"string","description":"Payment link"},"ads_source":{"type":"string","description":"Advertising source"},"bank_payments":{"type":"object","description":"Payment method"},"transfer_proofs":{"type":"array","description":"Bank transfer payment proofs, including verification time, amount and receipt images","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transfer proof ID"},"order_id":{"type":"integer","description":"Order ID"},"shop_id":{"type":"integer","description":"Shop ID"},"payment_id":{"type":"string","description":"Bank payment method ID (matches a key in `bank_payments`)"},"amount":{"type":"integer","description":"Transferred amount"},"images":{"type":"array","description":"Transfer receipt images","items":{"type":"string"}},"note":{"type":"string","nullable":true,"description":"Note"},"is_income":{"type":"boolean","description":"Money received (true) or paid out (false)"},"is_verify":{"type":"boolean","description":"Whether the transfer has been verified"},"verify_at":{"type":"string","format":"date-time","nullable":true,"description":"Verification time"},"verifier":{"type":"object","nullable":true,"description":"Verifier information","properties":{"id":{"type":"string","description":"Verifier ID"},"name":{"type":"string","description":"Verifier name"},"fb_id":{"type":"string","description":"Facebook ID of verifier"},"avatar_url":{"type":"string","description":"Verifier avatar URL"}}},"creator":{"type":"object","nullable":true,"description":"Creator information","properties":{"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"last_editor":{"type":"object","nullable":true,"description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Editor name"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"avatar_url":{"type":"string","description":"Editor avatar URL"}}},"order_info":{"type":"object","nullable":true,"description":"Additional order information"},"inserted_at":{"type":"string","format":"date-time","description":"Transfer proof creation time"},"updated_at":{"type":"string","format":"date-time","description":"Transfer proof update time"}}}},"shopify_order_id":{"type":"string","description":"Shopify order ID"},"shopify_abandon_checkout_id":{"type":"integer","description":"Shopify abandon checkout ID"},"is_abandoned_order":{"type":"boolean","description":"Abandoned-cart flag for creating or updating an order. Send it directly in the request body, not inside `third_party` or `third_party_infomation`.\nAn 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.\nOnly boolean `true` or string `\"true\"` is normalized to `true`; all other submitted values become `false`.\n","example":true},"cod":{"type":"integer","description":"Cash on delivery"},"cash":{"type":"integer","description":"Cash payment"},"account":{"type":"integer","description":"Order source ID"},"account_name":{"type":"string","description":"Order source name"},"advanced_platform_fee":{"type":"object","description":"Fees from e-commerce platforms","properties":{"ads_top_up":{"type":"integer","description":"Ads wallet top-up"},"affiliate_commission":{"type":"integer","description":"Affiliate commission"},"diff_shipping_fee":{"type":"integer","description":"Difference shipping fee"},"marketplace_voucher":{"type":"integer","description":"Marketplace voucher"},"payment_fee":{"type":"integer","description":"Payment fee"},"platform_commission":{"type":"integer","description":"Platform commission"},"seller_transaction_fee":{"type":"integer","description":"Seller transaction fee"},"service_fee":{"type":"integer","description":"Service fee"},"sfp_service_fee":{"type":"integer","description":"SFP service fee"}}},"printing_count":{"type":"integer","description":"Printing count"},"money_to_collect":{"type":"integer","description":"Money to collect"},"marketplace_id":{"type":"string","description":"Marketplace ID","enum":["-2","-3","-4","-9","-16","-17","-20","-25","-27","-28"],"x-enum-descriptions":{"-2":"Tiki","-3":"Shopee","-4":"Lazada","-9":"TikTok","-16":"WooCommerce","-17":"Shopify","-20":"Line Shopping","-25":"Tokopedia","-27":"Mercado Libre","-28":"Tiendanube"}},"total_price":{"type":"integer","description":"Total price"},"shop_customer_address_id":{"type":"string","description":"Customer address ID"},"customer":{"type":"object","description":"Customer information","properties":{"fb_id":{"type":"string","description":"Customer Facebook ID"},"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Customer name"},"page_id":{"type":"string","description":"Page ID"}}},"total_quantity":{"type":"integer","description":"Total quantity"},"time_assign_marketer":{"type":"string","format":"date-time","description":"Time assign marketer"},"p_utm_source":{"type":"string","description":"UTM Source"},"p_utm_medium":{"type":"string","description":"UTM Medium"},"p_utm_campaign":{"type":"string","description":"UTM Campaign"},"p_utm_term":{"type":"string","description":"UTM Term"},"p_utm_content":{"type":"string","description":"UTM Content"},"p_utm_id":{"type":"string","description":"UTM ID"},"utm_affiliate":{"type":"string","description":"Affiliate"},"link":{"type":"string","description":"Link"},"status_history":{"type":"array","description":"Status update history","items":{"type":"object","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"editor":{"type":"object","description":"Editor information"},"editor_fb":{"type":"string","description":"Editor Facebook ID"},"editor_id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Name"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Status"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"duplicated_phone":{"type":"boolean","description":"Duplicated phone"},"order_currency":{"type":"string","description":"Order currency"},"charged_by_vnpay":{"type":"integer","description":"Charged by VNPay"},"charged_by_qrpay":{"type":"integer","description":"Charged by QRPay"},"custom_id":{"type":"string","description":"Custom ID"},"last_editor":{"type":"object","description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"name":{"type":"string","description":"Editor name"},"email":{"type":"string","description":"Editor email"},"avatar_url":{"type":"string","description":"Editor avatar URL"},"phone_number":{"type":"string","description":"Editor phone number"}}},"last_editor_id":{"type":"string","description":"Last editor ID"},"charged_by_momo":{"type":"integer","description":"Charged by MoMo"},"prepaid_by_point":{"type":"object","description":"Prepaid by point","properties":{"money":{"type":"integer","description":"Money amount","example":15000},"point":{"type":"integer","description":"Point amount","example":15}},"example":{"money":15000,"point":15}},"bank_transfer_images":{"type":"array","description":"Bank transfer images","items":{"type":"string","format":"uri"}},"transfer_money":{"type":"integer","description":"Transfer money"},"lock_order_by_user":{"type":"string","description":"Lock order by user ID"},"assigning_care":{"type":"object","description":"Assigning care information","properties":{"id":{"type":"string","description":"Care ID"},"fb_id":{"type":"string","description":"Facebook ID of care"},"name":{"type":"string","description":"Care name"},"email":{"type":"string","description":"Care email"},"avatar_url":{"type":"string","description":"Care avatar URL"},"phone_number":{"type":"string","description":"Care phone number"}}},"assigning_care_id":{"type":"string","description":"Assigning care ID"},"time_assign_care":{"type":"string","format":"date-time","description":"Time assign care"},"assigning_seller":{"type":"object","description":"Assigning seller information","properties":{"id":{"type":"string","description":"Seller ID"},"fb_id":{"type":"string","description":"Facebook ID of seller"},"name":{"type":"string","description":"Seller name"},"email":{"type":"string","description":"Seller email"},"avatar_url":{"type":"string","description":"Seller avatar URL"},"phone_number":{"type":"string","description":"Seller phone number"}}},"einvoices":{"type":"array","items":{"$ref":"#/components/schemas/EInvoice"}},"charged_by_card":{"type":"integer","description":"Charged by card"},"estimate_delivery_date":{"type":"string","format":"date-time","description":"Estimate delivery date"},"order_sources":{"type":"string","description":"Order sources ID"},"charged_by_fundiin":{"type":"integer","description":"Charged by Fundiin"},"surcharge":{"type":"integer","description":"Surcharge"},"is_linked_partner":{"type":"boolean","description":"Is linked partner"},"call_laters":{"type":"array","description":"Call laters","items":{"type":"object"}},"last_update_status_at":{"type":"string","format":"date-time","description":"Last update status at"},"discount_by_customer_level":{"type":"integer","description":"Discount by customer level"},"viewing":{"type":"array","description":"Viewing","items":{"type":"object"}},"additional_info":{"type":"object","description":"Additional info","properties":{"service_partner":{"type":"string","description":"Service partner","enum":["instant"],"x-enum-descriptions":["Instant"]},"delivery_deadline":{"type":"string","format":"date-time","description":"Delivery deadline (ISO8601, no timezone).","example":"2026-06-03T10:00:00"},"ship_by_date":{"type":"integer","nullable":true,"readOnly":true,"description":"Marketplace ship-by deadline (Unix timestamp, seconds) for Shopee/TikTok orders — the order must be handed over to the carrier before this time, otherwise the marketplace may cancel it automatically. Shopee `ship_by_date`, TikTok `collection_due_time`. `0` = the marketplace has not returned it yet; `null` for non-marketplace orders.","example":1793000000}}},"order_returned_ids":{"type":"string","description":"Order returned IDs"},"cost_surcharge":{"type":"integer","description":"Cost surcharge"},"time_send_partner":{"type":"string","format":"date-time","description":"Time send partner"},"charged_by_kredivo":{"type":"integer","description":"Charged by Kredivo"},"discount":{"type":"integer","description":"Discount"},"histories":{"type":"array","description":"Histories","items":{"type":"object"}},"duplicated_customer":{"type":"boolean","description":"Duplicated customer"},"customer_referral_code":{"type":"object","description":"Customer referral code","properties":{"active":{"type":"string","description":"Active status","example":"true"},"customer_id":{"type":"string","format":"uuid","description":"Customer ID","example":"09bb9399-45f3-4897-a53a-85dde2f886fe"},"discount":{"type":"string","description":"Discount value","example":"10"},"format":{"type":"string","description":"Referral code format","example":"{PHONE_NUMBER}"},"free_products_priced_between_approx":{"type":"object","description":"Free products priced between approximately","properties":{"active":{"type":"string","description":"Active status","example":"true"},"operator":{"type":"string","description":"Comparison operator","example":"GreaterOrEqual"},"price":{"type":"string","description":"Price threshold","example":"150000"}}},"is_percent":{"type":"string","description":"Discount is percentage","example":"true"},"only_customers_with_level_will_have_referral_code":{"type":"string","description":"Only customers with level will have referral code","example":"true"},"referral_code":{"type":"string","description":"Referral code","example":"982843759"},"reward_points_for_old_customers":{"type":"object","description":"Reward points for customers","properties":{"active":{"type":"string","description":"Active status","example":"true"},"money":{"type":"string","description":"Money reward","example":"10000"},"point":{"type":"string","description":"Point reward","example":"1"}}},"shop_customer_id":{"type":"string","format":"uuid","description":"Shop customer ID","example":"f8160a4c-dfa7-4ee8-b540-d245755ea1f1"}},"example":{"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"}},"tax":{"type":"integer","description":"Tax"},"is_from_ecommerce":{"type":"boolean","description":"Is from e-commerce"},"note_image":{"type":"array","description":"Note images","items":{"type":"string","format":"uri"}},"shopify_draft_order_id":{"type":"string","description":"Shopify draft order ID"},"display_id":{"type":"integer","description":"Display ID"},"shop_partner_id":{"type":"integer","description":"Shop partner ID"},"is_locked":{"type":"boolean","description":"Order lock"},"merge_order":{"type":"boolean","description":"Allows merging orders"}}},"examples":{"default":{"$ref":"#/components/examples/OrderBasic"}}}}}}}},"/shops/{SHOP_ID}/orders/{ORDER_ID}":{"get":{"summary":"Get order information","x-summary-i18n":{"vie":"Lấy thông tin 1 đơn hàng"},"description":"Get order information","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"ORDER_ID","in":"path","required":true,"schema":{"type":"string","example":"1418"},"description":"Order ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Order ID"},"system_id":{"type":"integer","description":"System ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Order creation time"},"updated_at":{"type":"string","format":"date-time","description":"Order update time"},"status":{"type":"integer","description":"Order status","enum":[0,17,11,12,13,20,1,8,9,2,3,16,4,15,5,6,7],"x-enum-descriptions":["New","Waiting for confirmation","Restocking","Wait for printing","Printed","Purchased","Confirmed","Packaging","Waiting for pick up","Shipped","Received","Collected money","Returning","Partial return","Returned","Canceled","Deleted recently"]},"status_name":{"type":"string","description":"Order status name"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"bill_email":{"type":"string","description":"Customer email"},"conversation_id":{"type":"string","description":"Conversation ID"},"page_id":{"type":"string","description":"Facebook page ID"},"post_id":{"type":"string","description":"Post ID"},"ad_id":{"type":"string","description":"Ad ID"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"partner_fee":{"type":"integer","description":"Fee from shipping partner"},"fee_marketplace":{"type":"integer","description":"Fees from e-commerce platforms"},"customer_pay_fee":{"type":"boolean","description":"Customer pay shipping fee"},"is_free_shipping":{"type":"boolean","description":"Free shipping"},"is_livestream":{"type":"boolean","description":"Is livestream order"},"is_live_shopping":{"type":"boolean","description":"Is live shopping order"},"is_smc":{"type":"boolean","description":"Shopping on Messenger"},"received_at_shop":{"type":"boolean","description":"true: Sales at counter, false: Sell online"},"total_discount":{"type":"integer","description":"Discount total"},"note":{"type":"string","description":"Internal note"},"note_print":{"type":"string","description":"Note for printing"},"returned_reason":{"type":"integer","description":"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_name":{"type":"string","description":"Return reason name"},"sub_status":{"type":"integer","description":"Reason for delivery delay"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"warehouse_info":{"type":"object","description":"Warehouse information","properties":{"name":{"type":"string","description":"Warehouse name"},"phone_number":{"type":"string","description":"Warehouse phone number"},"full_address":{"type":"string","description":"Warehouse full address"},"address":{"type":"string","description":"Warehouse address"},"province_id":{"type":"string","description":"Province ID"},"district_id":{"type":"string","description":"District ID"},"commune_id":{"type":"string","description":"Commune ID"},"affiliate_id":{"type":"string","description":"Affiliate ID"},"ffm_id":{"type":"string","description":"FFM ID"},"has_snappy_service":{"type":"boolean","description":"Has Snappy service"},"custom_id":{"type":"string","description":"Custom ID"}}},"creator_id":{"type":"string","description":"Creator ID"},"creator":{"type":"object","description":"Order creator","properties":{"id":{"type":"string","description":"Creator ID"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"name":{"type":"string","description":"Creator name"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"items":{"type":"array","description":"Product list. When creating or updating an order, each entry must include `variation_id` and `quantity`. `variation_info` is optional — if omitted, the backend treats it as an empty object; send it (with `retail_price`) when you need the line price to be explicit.","items":{"type":"object","required":["variation_id","quantity"],"properties":{"product_id":{"type":"string","description":"Product ID"},"quantity":{"type":"integer","description":"Quantity"},"returned_count":{"type":"integer","description":"Returned count"},"assigning_seller_id":{"type":"string","description":"Assigning seller ID"},"quantity_by_combo_products":{"type":"array","description":"Quantity by combo products","items":{"type":"object"}},"discount_each_product":{"type":"integer","description":"Discount for each product"},"is_bonus_product":{"type":"boolean","description":"Is bonus product"},"is_discount_percent":{"type":"boolean","description":"Is discount by percent"},"is_wholesale":{"type":"boolean","description":"Is wholesale"},"is_composite":{"type":"boolean","description":"Is composite product"},"one_time_product":{"type":"boolean","description":"One time product"},"note":{"type":"string","description":"Product note"},"note_product":{"type":"string","description":"Product note"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"measure_group_id":{"type":"integer","description":"Measure group ID"},"variation_info":{"type":"object","description":"Variation information. Optional when creating/updating an order (the backend defaults it to an empty object if omitted). Its inner fields are not individually required, but sending `retail_price` is recommended so the line price is correct.","properties":{"id":{"type":"string","description":"Variation ID"},"name":{"type":"string","description":"Product name"},"product_id":{"type":"string","description":"Product ID"},"retail_price":{"type":"integer","description":"Retail price. Not strictly required, but recommended when creating/updating an order so the line price is correct."},"detail":{"type":"string","description":"Variation detail"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"},"keyValue":{"type":"string","description":"Key value"}}}},"barcode":{"type":"string","description":"Barcode"},"brand_id":{"type":"string","description":"Brand ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"display_id":{"type":"string","description":"Display ID"},"product_display_id":{"type":"string","description":"Product display ID"},"last_imported_price":{"type":"integer","description":"Last imported price"},"is_upsale_product":{"type":"boolean","description":"Upsale product"},"weight":{"type":"integer","description":"Weight"},"measure_info":{"type":"object","description":"Measure information","properties":{"measure_id":{"type":"integer","description":"Measure ID"},"exchange_value":{"type":"integer","description":"Exchange value"}}},"avg_price":{"type":"integer","description":"Average import price"}}},"components":{"type":"array","description":"Product components","items":{"type":"object","properties":{"component_id":{"type":"string","description":"Component ID"},"quantity":{"type":"integer","description":"Quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information"}}}},"id":{"type":"integer","description":"Item ID"},"variation_id":{"type":"string","description":"Variation ID"}}}},"partner":{"type":"object","description":"Partner information\nWhen updating an order that already has shipping info, only the fields you send are written; omitted fields keep their current values. Send `null` to clear `partner_id`, `extend_code` or `shop_partner_id`.\n","properties":{"partner_id":{"type":"integer","description":"Partner ID"},"cod":{"type":"integer","description":"Reconciliation COD"},"extend_code":{"type":"string","description":"Shipping order ID on partner system"},"total_fee":{"type":"integer","description":"Total fee"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"delivery_name":{"type":"string","description":"Shipper name"},"delivery_tel":{"type":"string","description":"Delivery phone"},"picked_up_at":{"type":"string","format":"date-time","description":"Picked up at"},"sort_code":{"type":"string","description":"Sort code"},"paid_at":{"type":"string","format":"date-time","description":"Paid at"},"system_created":{"type":"boolean","description":"System created"},"extend_update":{"type":"array","description":"Update from courier","items":{"type":"object","properties":{"key":{"type":"string","description":"Update key"},"status":{"type":"string","description":"Status"},"tracking_id":{"type":"string","description":"Partner extend code"},"note":{"type":"string","description":"Courier notes"},"update_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"partner_status":{"type":"string","nullable":true,"description":"Partner shipping status","enum":["waiting","request_received","processing_picked_up","picking_up","delay_pickup","picked_up","waiting_on_the_way","on_the_way","contact_delivery_company","out_for_delivery","delay_delivery","inform_recipient","undeliverable","waiting_for_return","delivered","delivered_cod","returning","returned","returned_cod","canceled"],"x-enum-descriptions":["Waiting for processing","Carrier received the request","Processing pickup","Picking up","Delayed pickup","Picked up","Waiting for transit","In transit","Contact the carrier","Out for delivery","Delayed delivery","Notify the recipient","Undeliverable","Waiting for return","Delivered","Delivered, COD reconciled","Returning","Returned","Returned, COD reconciled","Canceled"]},"partner_name":{"type":"string","nullable":true,"description":"Partner name"},"first_delivery_at":{"type":"string","format":"date-time","nullable":true,"description":"First delivery time"},"first_undeliverable_at":{"type":"string","format":"date-time","nullable":true,"description":"First failed delivery time"},"count_of_delivery":{"type":"integer","nullable":true,"minimum":0,"maximum":32767,"description":"Number of delivery attempts. Courier updates add 1 each time the shipment moves to `out_for_delivery` or `delay_delivery`.\nCan be set when creating or updating an order (integer 0-32767); omitted or invalid values keep the current value, and later courier updates keep counting from the value you set.\n","example":2},"order_number_vtp":{"type":"string","nullable":true,"description":"Viettel Post tracking number"},"printed_form":{"type":"object","nullable":true,"description":"Printed form"}}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"payment_purchase_histories":{"type":"array","description":"Payment histories","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount of money"},"type":{"type":"string","description":"Payment type"},"inserted_at":{"type":"string","format":"date-time","description":"Transaction time"},"result_code":{"type":"string","description":"Result code"},"ipn_reply":{"type":"boolean","description":"IPN reply"},"voucher_amount":{"type":"integer","description":"Voucher amount"},"tags":{"type":"array","description":"Tags","items":{"type":"string"}}}}},"tags":{"type":"array","description":"Tags list","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"}}}},"marketer":{"type":"object","description":"Marketer information","properties":{"id":{"type":"string","description":"Marketer ID"},"name":{"type":"string","description":"Marketer name"},"email":{"type":"string","description":"Marketer email"},"phone_number":{"type":"string","description":"Marketer phone number"},"fb_id":{"type":"string","description":"Marketer Facebook ID"},"avatar_url":{"type":"string","description":"Marketer avatar URL"}}},"pke_mkter":{"type":"string","description":"Marketer ID"},"activated_combo_products":{"type":"object","description":"Activated combo products information","properties":{"combo_product_id":{"type":"integer","description":"Combo product ID"},"quantity_combo_activated":{"type":"integer","description":"Quantity combo activated"},"combo_product_info":{"type":"object","description":"Combo product information"}}},"activated_promotion_advances":{"type":"array","description":"Activated promotion advances information","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"promotion_advance_id":{"type":"string","description":"Promotion advance ID"},"promotion_advance_info":{"type":"object","description":"Promotion advance information"}}}},"invoice_info_list":{"type":"array","description":"Invoice information list","items":{"type":"object","properties":{"error":{"type":"string","description":"Error message if any"},"invoice_detail":{"type":"object","description":"Invoice detail information. The fields to send depend on `invoice_type`:\n- `company`: use `company_name`, `company_tax_id`, `company_address`, `company_email` (and optionally `company_address_breakdown`).\n- `personal`: use `name`, `phone_number`, `identity_code`, `tax_id`, `email`.\n","properties":{"name":{"type":"string","description":"Full name of the individual requesting the invoice (`invoice_type` = `personal`)","example":"Hoang Anh"},"phone_number":{"type":"string","description":"Phone number of the individual (`invoice_type` = `personal`)","example":"0934283743"},"identity_code":{"type":"string","description":"Citizen identity card / ID number of the individual (`invoice_type` = `personal`)","example":"029374382740"},"tax_id":{"type":"string","description":"Personal tax ID of the individual, if any (`invoice_type` = `personal`)","example":""},"email":{"type":"string","description":"Email of the individual to receive the e-invoice (`invoice_type` = `personal`)","example":""},"company_address":{"type":"string","description":"Company address (`invoice_type` = `company`)"},"company_address_breakdown":{"type":"object","description":"Company address breakdown","properties":{"company_additional_info":{"type":"string","description":"Company additional information"},"company_barangay":{"type":"string","description":"Company barangay"},"company_city":{"type":"string","description":"Company city"},"company_detailed_address":{"type":"string","description":"Company detailed address"},"company_district":{"type":"string","description":"Company district"},"company_full_address":{"type":"string","description":"Company full address"},"company_postcode":{"type":"string","description":"Company postcode"},"company_province":{"type":"string","description":"Company province"},"company_region":{"type":"string","description":"Company region"},"company_state":{"type":"string","description":"Company state"},"company_town":{"type":"string","description":"Company town"}}},"company_email":{"type":"string","description":"Company email (`invoice_type` = `company`)"},"company_name":{"type":"string","description":"Company name (`invoice_type` = `company`)"},"company_tax_id":{"type":"string","description":"Company tax ID (`invoice_type` = `company`)"}}},"invoice_type":{"type":"string","enum":["company","personal"],"description":"Invoice type: `company` for an organization, `personal` for an individual.\nDetermines which `invoice_detail` fields are used.\n","example":"personal"},"is_requested":{"type":"boolean","description":"Customer requests an e-invoice for this order. Set `true` together with `invoice_type` and `invoice_detail` to request invoice issuance.","example":true},"order_sn":{"type":"string","description":"Order code on the marketplace"}}}},"reports_by_phone":{"type":"object","description":"Reports by phone number","properties":{"order_fail":{"type":"integer","description":"Number of failed orders"},"order_success":{"type":"integer","description":"Number of successful orders"},"warning":{"type":"integer","description":"Number of warnings orders"}},"example":{"+639175706297":{"order_fail":29,"order_success":20,"warning":0}}},"tracking_link":{"type":"string","description":"Link confirm order"},"payment_link":{"type":"string","description":"Payment link"},"ads_source":{"type":"string","description":"Advertising source"},"bank_payments":{"type":"object","description":"Payment method"},"transfer_proofs":{"type":"array","description":"Bank transfer payment proofs, including verification time, amount and receipt images","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transfer proof ID"},"order_id":{"type":"integer","description":"Order ID"},"shop_id":{"type":"integer","description":"Shop ID"},"payment_id":{"type":"string","description":"Bank payment method ID (matches a key in `bank_payments`)"},"amount":{"type":"integer","description":"Transferred amount"},"images":{"type":"array","description":"Transfer receipt images","items":{"type":"string"}},"note":{"type":"string","nullable":true,"description":"Note"},"is_income":{"type":"boolean","description":"Money received (true) or paid out (false)"},"is_verify":{"type":"boolean","description":"Whether the transfer has been verified"},"verify_at":{"type":"string","format":"date-time","nullable":true,"description":"Verification time"},"verifier":{"type":"object","nullable":true,"description":"Verifier information","properties":{"id":{"type":"string","description":"Verifier ID"},"name":{"type":"string","description":"Verifier name"},"fb_id":{"type":"string","description":"Facebook ID of verifier"},"avatar_url":{"type":"string","description":"Verifier avatar URL"}}},"creator":{"type":"object","nullable":true,"description":"Creator information","properties":{"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"last_editor":{"type":"object","nullable":true,"description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Editor name"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"avatar_url":{"type":"string","description":"Editor avatar URL"}}},"order_info":{"type":"object","nullable":true,"description":"Additional order information"},"inserted_at":{"type":"string","format":"date-time","description":"Transfer proof creation time"},"updated_at":{"type":"string","format":"date-time","description":"Transfer proof update time"}}}},"shopify_order_id":{"type":"string","description":"Shopify order ID"},"shopify_abandon_checkout_id":{"type":"integer","description":"Shopify abandon checkout ID"},"is_abandoned_order":{"type":"boolean","description":"Abandoned-cart flag for creating or updating an order. Send it directly in the request body, not inside `third_party` or `third_party_infomation`.\nAn 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.\nOnly boolean `true` or string `\"true\"` is normalized to `true`; all other submitted values become `false`.\n","example":true},"cod":{"type":"integer","description":"Cash on delivery"},"cash":{"type":"integer","description":"Cash payment"},"account":{"type":"integer","description":"Order source ID"},"account_name":{"type":"string","description":"Order source name"},"advanced_platform_fee":{"type":"object","description":"Fees from e-commerce platforms","properties":{"ads_top_up":{"type":"integer","description":"Ads wallet top-up"},"affiliate_commission":{"type":"integer","description":"Affiliate commission"},"diff_shipping_fee":{"type":"integer","description":"Difference shipping fee"},"marketplace_voucher":{"type":"integer","description":"Marketplace voucher"},"payment_fee":{"type":"integer","description":"Payment fee"},"platform_commission":{"type":"integer","description":"Platform commission"},"seller_transaction_fee":{"type":"integer","description":"Seller transaction fee"},"service_fee":{"type":"integer","description":"Service fee"},"sfp_service_fee":{"type":"integer","description":"SFP service fee"}}},"printing_count":{"type":"integer","description":"Printing count"},"money_to_collect":{"type":"integer","description":"Money to collect"},"marketplace_id":{"type":"string","description":"Marketplace ID","enum":["-2","-3","-4","-9","-16","-17","-20","-25","-27","-28"],"x-enum-descriptions":{"-2":"Tiki","-3":"Shopee","-4":"Lazada","-9":"TikTok","-16":"WooCommerce","-17":"Shopify","-20":"Line Shopping","-25":"Tokopedia","-27":"Mercado Libre","-28":"Tiendanube"}},"total_price":{"type":"integer","description":"Total price"},"shop_customer_address_id":{"type":"string","description":"Customer address ID"},"customer":{"type":"object","description":"Customer information","properties":{"fb_id":{"type":"string","description":"Customer Facebook ID"},"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Customer name"},"page_id":{"type":"string","description":"Page ID"}}},"total_quantity":{"type":"integer","description":"Total quantity"},"time_assign_marketer":{"type":"string","format":"date-time","description":"Time assign marketer"},"p_utm_source":{"type":"string","description":"UTM Source"},"p_utm_medium":{"type":"string","description":"UTM Medium"},"p_utm_campaign":{"type":"string","description":"UTM Campaign"},"p_utm_term":{"type":"string","description":"UTM Term"},"p_utm_content":{"type":"string","description":"UTM Content"},"p_utm_id":{"type":"string","description":"UTM ID"},"utm_affiliate":{"type":"string","description":"Affiliate"},"link":{"type":"string","description":"Link"},"status_history":{"type":"array","description":"Status update history","items":{"type":"object","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"editor":{"type":"object","description":"Editor information"},"editor_fb":{"type":"string","description":"Editor Facebook ID"},"editor_id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Name"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Status"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"duplicated_phone":{"type":"boolean","description":"Duplicated phone"},"order_currency":{"type":"string","description":"Order currency"},"charged_by_vnpay":{"type":"integer","description":"Charged by VNPay"},"charged_by_qrpay":{"type":"integer","description":"Charged by QRPay"},"custom_id":{"type":"string","description":"Custom ID"},"last_editor":{"type":"object","description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"name":{"type":"string","description":"Editor name"},"email":{"type":"string","description":"Editor email"},"avatar_url":{"type":"string","description":"Editor avatar URL"},"phone_number":{"type":"string","description":"Editor phone number"}}},"last_editor_id":{"type":"string","description":"Last editor ID"},"charged_by_momo":{"type":"integer","description":"Charged by MoMo"},"prepaid_by_point":{"type":"object","description":"Prepaid by point","properties":{"money":{"type":"integer","description":"Money amount","example":15000},"point":{"type":"integer","description":"Point amount","example":15}},"example":{"money":15000,"point":15}},"bank_transfer_images":{"type":"array","description":"Bank transfer images","items":{"type":"string","format":"uri"}},"transfer_money":{"type":"integer","description":"Transfer money"},"lock_order_by_user":{"type":"string","description":"Lock order by user ID"},"assigning_care":{"type":"object","description":"Assigning care information","properties":{"id":{"type":"string","description":"Care ID"},"fb_id":{"type":"string","description":"Facebook ID of care"},"name":{"type":"string","description":"Care name"},"email":{"type":"string","description":"Care email"},"avatar_url":{"type":"string","description":"Care avatar URL"},"phone_number":{"type":"string","description":"Care phone number"}}},"assigning_care_id":{"type":"string","description":"Assigning care ID"},"time_assign_care":{"type":"string","format":"date-time","description":"Time assign care"},"assigning_seller":{"type":"object","description":"Assigning seller information","properties":{"id":{"type":"string","description":"Seller ID"},"fb_id":{"type":"string","description":"Facebook ID of seller"},"name":{"type":"string","description":"Seller name"},"email":{"type":"string","description":"Seller email"},"avatar_url":{"type":"string","description":"Seller avatar URL"},"phone_number":{"type":"string","description":"Seller phone number"}}},"einvoices":{"type":"array","items":{"$ref":"#/components/schemas/EInvoice"}},"charged_by_card":{"type":"integer","description":"Charged by card"},"estimate_delivery_date":{"type":"string","format":"date-time","description":"Estimate delivery date"},"order_sources":{"type":"string","description":"Order sources ID"},"charged_by_fundiin":{"type":"integer","description":"Charged by Fundiin"},"surcharge":{"type":"integer","description":"Surcharge"},"is_linked_partner":{"type":"boolean","description":"Is linked partner"},"call_laters":{"type":"array","description":"Call laters","items":{"type":"object"}},"last_update_status_at":{"type":"string","format":"date-time","description":"Last update status at"},"discount_by_customer_level":{"type":"integer","description":"Discount by customer level"},"viewing":{"type":"array","description":"Viewing","items":{"type":"object"}},"additional_info":{"type":"object","description":"Additional info","properties":{"service_partner":{"type":"string","description":"Service partner","enum":["instant"],"x-enum-descriptions":["Instant"]},"delivery_deadline":{"type":"string","format":"date-time","description":"Delivery deadline (ISO8601, no timezone).","example":"2026-06-03T10:00:00"},"ship_by_date":{"type":"integer","nullable":true,"readOnly":true,"description":"Marketplace ship-by deadline (Unix timestamp, seconds) for Shopee/TikTok orders — the order must be handed over to the carrier before this time, otherwise the marketplace may cancel it automatically. Shopee `ship_by_date`, TikTok `collection_due_time`. `0` = the marketplace has not returned it yet; `null` for non-marketplace orders.","example":1793000000}}},"order_returned_ids":{"type":"string","description":"Order returned IDs"},"cost_surcharge":{"type":"integer","description":"Cost surcharge"},"time_send_partner":{"type":"string","format":"date-time","description":"Time send partner"},"charged_by_kredivo":{"type":"integer","description":"Charged by Kredivo"},"discount":{"type":"integer","description":"Discount"},"histories":{"type":"array","description":"Histories","items":{"type":"object"}},"duplicated_customer":{"type":"boolean","description":"Duplicated customer"},"customer_referral_code":{"type":"object","description":"Customer referral code","properties":{"active":{"type":"string","description":"Active status","example":"true"},"customer_id":{"type":"string","format":"uuid","description":"Customer ID","example":"09bb9399-45f3-4897-a53a-85dde2f886fe"},"discount":{"type":"string","description":"Discount value","example":"10"},"format":{"type":"string","description":"Referral code format","example":"{PHONE_NUMBER}"},"free_products_priced_between_approx":{"type":"object","description":"Free products priced between approximately","properties":{"active":{"type":"string","description":"Active status","example":"true"},"operator":{"type":"string","description":"Comparison operator","example":"GreaterOrEqual"},"price":{"type":"string","description":"Price threshold","example":"150000"}}},"is_percent":{"type":"string","description":"Discount is percentage","example":"true"},"only_customers_with_level_will_have_referral_code":{"type":"string","description":"Only customers with level will have referral code","example":"true"},"referral_code":{"type":"string","description":"Referral code","example":"982843759"},"reward_points_for_old_customers":{"type":"object","description":"Reward points for customers","properties":{"active":{"type":"string","description":"Active status","example":"true"},"money":{"type":"string","description":"Money reward","example":"10000"},"point":{"type":"string","description":"Point reward","example":"1"}}},"shop_customer_id":{"type":"string","format":"uuid","description":"Shop customer ID","example":"f8160a4c-dfa7-4ee8-b540-d245755ea1f1"}},"example":{"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"}},"tax":{"type":"integer","description":"Tax"},"is_from_ecommerce":{"type":"boolean","description":"Is from e-commerce"},"note_image":{"type":"array","description":"Note images","items":{"type":"string","format":"uri"}},"shopify_draft_order_id":{"type":"string","description":"Shopify draft order ID"},"display_id":{"type":"integer","description":"Display ID"},"shop_partner_id":{"type":"integer","description":"Shop partner ID"},"is_locked":{"type":"boolean","description":"Order lock"},"merge_order":{"type":"boolean","description":"Allows merging orders"}}},"examples":{"default":{"value":{"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"}}}}}}}},"put":{"summary":"Update order","x-summary-i18n":{"vie":"Cập nhật đơn hàng"},"description":"Update order","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"ORDER_ID","in":"path","required":true,"schema":{"type":"string","example":"1418"},"description":"Order ID"}],"requestBody":{"required":true,"description":"Order information to update","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Order ID"},"system_id":{"type":"integer","description":"System ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Order creation time"},"updated_at":{"type":"string","format":"date-time","description":"Order update time"},"status":{"type":"integer","description":"Order status","enum":[0,17,11,12,13,20,1,8,9,2,3,16,4,15,5,6,7],"x-enum-descriptions":["New","Waiting for confirmation","Restocking","Wait for printing","Printed","Purchased","Confirmed","Packaging","Waiting for pick up","Shipped","Received","Collected money","Returning","Partial return","Returned","Canceled","Deleted recently"]},"status_name":{"type":"string","description":"Order status name"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"bill_email":{"type":"string","description":"Customer email"},"conversation_id":{"type":"string","description":"Conversation ID"},"page_id":{"type":"string","description":"Facebook page ID"},"post_id":{"type":"string","description":"Post ID"},"ad_id":{"type":"string","description":"Ad ID"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"partner_fee":{"type":"integer","description":"Fee from shipping partner"},"fee_marketplace":{"type":"integer","description":"Fees from e-commerce platforms"},"customer_pay_fee":{"type":"boolean","description":"Customer pay shipping fee"},"is_free_shipping":{"type":"boolean","description":"Free shipping"},"is_livestream":{"type":"boolean","description":"Is livestream order"},"is_live_shopping":{"type":"boolean","description":"Is live shopping order"},"is_smc":{"type":"boolean","description":"Shopping on Messenger"},"received_at_shop":{"type":"boolean","description":"true: Sales at counter, false: Sell online"},"total_discount":{"type":"integer","description":"Discount total"},"note":{"type":"string","description":"Internal note"},"note_print":{"type":"string","description":"Note for printing"},"returned_reason":{"type":"integer","description":"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_name":{"type":"string","description":"Return reason name"},"sub_status":{"type":"integer","description":"Reason for delivery delay"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"warehouse_info":{"type":"object","description":"Warehouse information","properties":{"name":{"type":"string","description":"Warehouse name"},"phone_number":{"type":"string","description":"Warehouse phone number"},"full_address":{"type":"string","description":"Warehouse full address"},"address":{"type":"string","description":"Warehouse address"},"province_id":{"type":"string","description":"Province ID"},"district_id":{"type":"string","description":"District ID"},"commune_id":{"type":"string","description":"Commune ID"},"affiliate_id":{"type":"string","description":"Affiliate ID"},"ffm_id":{"type":"string","description":"FFM ID"},"has_snappy_service":{"type":"boolean","description":"Has Snappy service"},"custom_id":{"type":"string","description":"Custom ID"}}},"creator_id":{"type":"string","description":"Creator ID"},"creator":{"type":"object","description":"Order creator","properties":{"id":{"type":"string","description":"Creator ID"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"name":{"type":"string","description":"Creator name"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"items":{"type":"array","description":"Product list","items":{"type":"object","required":["variation_id","quantity"],"properties":{"product_id":{"type":"string","description":"Product ID"},"quantity":{"type":"integer","description":"Quantity"},"returned_count":{"type":"integer","description":"Returned count"},"assigning_seller_id":{"type":"string","description":"Assigning seller ID"},"quantity_by_combo_products":{"type":"array","description":"Quantity by combo products","items":{"type":"object"}},"discount_each_product":{"type":"integer","description":"Discount for each product"},"is_bonus_product":{"type":"boolean","description":"Is bonus product"},"is_discount_percent":{"type":"boolean","description":"Is discount by percent"},"is_wholesale":{"type":"boolean","description":"Is wholesale"},"is_composite":{"type":"boolean","description":"Is composite product"},"one_time_product":{"type":"boolean","description":"One time product"},"note":{"type":"string","description":"Product note"},"note_product":{"type":"string","description":"Product note"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"measure_group_id":{"type":"integer","description":"Measure group ID"},"variation_info":{"type":"object","description":"Variation information. Optional when creating/updating an order (the backend defaults it to an empty object if omitted). Its inner fields are not individually required, but sending `retail_price` is recommended so the line price is correct.","properties":{"id":{"type":"string","description":"Variation ID"},"name":{"type":"string","description":"Product name"},"product_id":{"type":"string","description":"Product ID"},"retail_price":{"type":"integer","description":"Retail price. Not strictly required, but recommended when creating/updating an order so the line price is correct."},"detail":{"type":"string","description":"Variation detail"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"},"keyValue":{"type":"string","description":"Key value"}}}},"barcode":{"type":"string","description":"Barcode"},"brand_id":{"type":"string","description":"Brand ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"display_id":{"type":"string","description":"Display ID"},"product_display_id":{"type":"string","description":"Product display ID"},"last_imported_price":{"type":"integer","description":"Last imported price"},"is_upsale_product":{"type":"boolean","description":"Upsale product"},"weight":{"type":"integer","description":"Weight"},"measure_info":{"type":"object","description":"Measure information","properties":{"measure_id":{"type":"integer","description":"Measure ID"},"exchange_value":{"type":"integer","description":"Exchange value"}}},"avg_price":{"type":"integer","description":"Average import price"}}},"components":{"type":"array","description":"Product components","items":{"type":"object","properties":{"component_id":{"type":"string","description":"Component ID"},"quantity":{"type":"integer","description":"Quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information"}}}},"variation_id":{"type":"string","description":"Variation ID"}}}},"partner":{"type":"object","description":"Partner information\nWhen updating an order that already has shipping info, only the fields you send are written; omitted fields keep their current values. Send `null` to clear `partner_id`, `extend_code` or `shop_partner_id`.\n","properties":{"partner_id":{"type":"integer","description":"Partner ID"},"cod":{"type":"integer","description":"Reconciliation COD"},"extend_code":{"type":"string","description":"Shipping order ID on partner system"},"total_fee":{"type":"integer","description":"Total fee"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"delivery_name":{"type":"string","description":"Shipper name"},"delivery_tel":{"type":"string","description":"Delivery phone"},"picked_up_at":{"type":"string","format":"date-time","description":"Picked up at"},"sort_code":{"type":"string","description":"Sort code"},"paid_at":{"type":"string","format":"date-time","description":"Paid at"},"system_created":{"type":"boolean","description":"System created"},"extend_update":{"type":"array","description":"Update from courier","items":{"type":"object","properties":{"key":{"type":"string","description":"Update key"},"status":{"type":"string","description":"Status"},"tracking_id":{"type":"string","description":"Partner extend code"},"note":{"type":"string","description":"Courier notes"},"update_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"partner_status":{"type":"string","nullable":true,"description":"Partner shipping status","enum":["waiting","request_received","processing_picked_up","picking_up","delay_pickup","picked_up","waiting_on_the_way","on_the_way","contact_delivery_company","out_for_delivery","delay_delivery","inform_recipient","undeliverable","waiting_for_return","delivered","delivered_cod","returning","returned","returned_cod","canceled"],"x-enum-descriptions":["Waiting for processing","Carrier received the request","Processing pickup","Picking up","Delayed pickup","Picked up","Waiting for transit","In transit","Contact the carrier","Out for delivery","Delayed delivery","Notify the recipient","Undeliverable","Waiting for return","Delivered","Delivered, COD reconciled","Returning","Returned","Returned, COD reconciled","Canceled"]},"partner_name":{"type":"string","nullable":true,"description":"Partner name"},"first_delivery_at":{"type":"string","format":"date-time","nullable":true,"description":"First delivery time"},"first_undeliverable_at":{"type":"string","format":"date-time","nullable":true,"description":"First failed delivery time"},"count_of_delivery":{"type":"integer","nullable":true,"minimum":0,"maximum":32767,"description":"Number of delivery attempts. Courier updates add 1 each time the shipment moves to `out_for_delivery` or `delay_delivery`.\nCan be set when creating or updating an order (integer 0-32767); omitted or invalid values keep the current value, and later courier updates keep counting from the value you set.\n","example":2},"order_number_vtp":{"type":"string","nullable":true,"description":"Viettel Post tracking number"},"printed_form":{"type":"object","nullable":true,"description":"Printed form"}}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"payment_purchase_histories":{"type":"array","description":"Payment histories","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount of money"},"type":{"type":"string","description":"Payment type"},"inserted_at":{"type":"string","format":"date-time","description":"Transaction time"},"result_code":{"type":"string","description":"Result code"},"ipn_reply":{"type":"boolean","description":"IPN reply"},"voucher_amount":{"type":"integer","description":"Voucher amount"},"tags":{"type":"array","description":"Tags","items":{"type":"string"}}}}},"tags":{"type":"array","description":"Tags list","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"}}}},"marketer":{"type":"object","description":"Marketer information","properties":{"id":{"type":"string","description":"Marketer ID"},"name":{"type":"string","description":"Marketer name"},"email":{"type":"string","description":"Marketer email"},"phone_number":{"type":"string","description":"Marketer phone number"},"fb_id":{"type":"string","description":"Marketer Facebook ID"},"avatar_url":{"type":"string","description":"Marketer avatar URL"}}},"pke_mkter":{"type":"string","description":"Marketer ID"},"activated_combo_products":{"type":"object","description":"Activated combo products information","properties":{"combo_product_id":{"type":"integer","description":"Combo product ID"},"quantity_combo_activated":{"type":"integer","description":"Quantity combo activated"},"combo_product_info":{"type":"object","description":"Combo product information"}}},"activated_promotion_advances":{"type":"array","description":"Activated promotion advances information","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"promotion_advance_id":{"type":"string","description":"Promotion advance ID"},"promotion_advance_info":{"type":"object","description":"Promotion advance information"}}}},"invoice_info_list":{"type":"array","description":"Invoice information list","items":{"type":"object","properties":{"error":{"type":"string","description":"Error message if any"},"invoice_detail":{"type":"object","description":"Invoice detail information. The fields to send depend on `invoice_type`:\n- `company`: use `company_name`, `company_tax_id`, `company_address`, `company_email` (and optionally `company_address_breakdown`).\n- `personal`: use `name`, `phone_number`, `identity_code`, `tax_id`, `email`.\n","properties":{"name":{"type":"string","description":"Full name of the individual requesting the invoice (`invoice_type` = `personal`)","example":"Hoang Anh"},"phone_number":{"type":"string","description":"Phone number of the individual (`invoice_type` = `personal`)","example":"0934283743"},"identity_code":{"type":"string","description":"Citizen identity card / ID number of the individual (`invoice_type` = `personal`)","example":"029374382740"},"tax_id":{"type":"string","description":"Personal tax ID of the individual, if any (`invoice_type` = `personal`)","example":""},"email":{"type":"string","description":"Email of the individual to receive the e-invoice (`invoice_type` = `personal`)","example":""},"company_address":{"type":"string","description":"Company address (`invoice_type` = `company`)"},"company_address_breakdown":{"type":"object","description":"Company address breakdown","properties":{"company_additional_info":{"type":"string","description":"Company additional information"},"company_barangay":{"type":"string","description":"Company barangay"},"company_city":{"type":"string","description":"Company city"},"company_detailed_address":{"type":"string","description":"Company detailed address"},"company_district":{"type":"string","description":"Company district"},"company_full_address":{"type":"string","description":"Company full address"},"company_postcode":{"type":"string","description":"Company postcode"},"company_province":{"type":"string","description":"Company province"},"company_region":{"type":"string","description":"Company region"},"company_state":{"type":"string","description":"Company state"},"company_town":{"type":"string","description":"Company town"}}},"company_email":{"type":"string","description":"Company email (`invoice_type` = `company`)"},"company_name":{"type":"string","description":"Company name (`invoice_type` = `company`)"},"company_tax_id":{"type":"string","description":"Company tax ID (`invoice_type` = `company`)"}}},"invoice_type":{"type":"string","enum":["company","personal"],"description":"Invoice type: `company` for an organization, `personal` for an individual.\nDetermines which `invoice_detail` fields are used.\n","example":"personal"},"is_requested":{"type":"boolean","description":"Customer requests an e-invoice for this order. Set `true` together with `invoice_type` and `invoice_detail` to request invoice issuance.","example":true},"order_sn":{"type":"string","description":"Order code on the marketplace"}}}},"reports_by_phone":{"type":"object","description":"Reports by phone number","properties":{"order_fail":{"type":"integer","description":"Number of failed orders"},"order_success":{"type":"integer","description":"Number of successful orders"},"warning":{"type":"integer","description":"Number of warnings orders"}},"example":{"+639175706297":{"order_fail":29,"order_success":20,"warning":0}}},"tracking_link":{"type":"string","description":"Link confirm order"},"payment_link":{"type":"string","description":"Payment link"},"ads_source":{"type":"string","description":"Advertising source"},"bank_payments":{"type":"object","description":"Payment method"},"transfer_proofs":{"type":"array","description":"Bank transfer payment proofs, including verification time, amount and receipt images","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transfer proof ID"},"order_id":{"type":"integer","description":"Order ID"},"shop_id":{"type":"integer","description":"Shop ID"},"payment_id":{"type":"string","description":"Bank payment method ID (matches a key in `bank_payments`)"},"amount":{"type":"integer","description":"Transferred amount"},"images":{"type":"array","description":"Transfer receipt images","items":{"type":"string"}},"note":{"type":"string","nullable":true,"description":"Note"},"is_income":{"type":"boolean","description":"Money received (true) or paid out (false)"},"is_verify":{"type":"boolean","description":"Whether the transfer has been verified"},"verify_at":{"type":"string","format":"date-time","nullable":true,"description":"Verification time"},"verifier":{"type":"object","nullable":true,"description":"Verifier information","properties":{"id":{"type":"string","description":"Verifier ID"},"name":{"type":"string","description":"Verifier name"},"fb_id":{"type":"string","description":"Facebook ID of verifier"},"avatar_url":{"type":"string","description":"Verifier avatar URL"}}},"creator":{"type":"object","nullable":true,"description":"Creator information","properties":{"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"last_editor":{"type":"object","nullable":true,"description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Editor name"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"avatar_url":{"type":"string","description":"Editor avatar URL"}}},"order_info":{"type":"object","nullable":true,"description":"Additional order information"},"inserted_at":{"type":"string","format":"date-time","description":"Transfer proof creation time"},"updated_at":{"type":"string","format":"date-time","description":"Transfer proof update time"}}}},"shopify_order_id":{"type":"string","description":"Shopify order ID"},"shopify_abandon_checkout_id":{"type":"integer","description":"Shopify abandon checkout ID"},"is_abandoned_order":{"type":"boolean","description":"Abandoned-cart flag for creating or updating an order. Send it directly in the request body, not inside `third_party` or `third_party_infomation`.\nAn 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.\nOnly boolean `true` or string `\"true\"` is normalized to `true`; all other submitted values become `false`.\n","example":true},"cod":{"type":"integer","description":"Cash on delivery"},"cash":{"type":"integer","description":"Cash payment"},"account":{"type":"integer","description":"Order source ID"},"account_name":{"type":"string","description":"Order source name"},"advanced_platform_fee":{"type":"object","description":"Fees from e-commerce platforms","properties":{"ads_top_up":{"type":"integer","description":"Ads wallet top-up"},"affiliate_commission":{"type":"integer","description":"Affiliate commission"},"diff_shipping_fee":{"type":"integer","description":"Difference shipping fee"},"marketplace_voucher":{"type":"integer","description":"Marketplace voucher"},"payment_fee":{"type":"integer","description":"Payment fee"},"platform_commission":{"type":"integer","description":"Platform commission"},"seller_transaction_fee":{"type":"integer","description":"Seller transaction fee"},"service_fee":{"type":"integer","description":"Service fee"},"sfp_service_fee":{"type":"integer","description":"SFP service fee"}}},"printing_count":{"type":"integer","description":"Printing count"},"money_to_collect":{"type":"integer","description":"Money to collect"},"marketplace_id":{"type":"string","description":"Marketplace ID","enum":["-2","-3","-4","-9","-16","-17","-20","-25","-27","-28"],"x-enum-descriptions":{"-2":"Tiki","-3":"Shopee","-4":"Lazada","-9":"TikTok","-16":"WooCommerce","-17":"Shopify","-20":"Line Shopping","-25":"Tokopedia","-27":"Mercado Libre","-28":"Tiendanube"}},"total_price":{"type":"integer","description":"Total price"},"shop_customer_address_id":{"type":"string","description":"Customer address ID"},"customer":{"type":"object","description":"Customer information","properties":{"fb_id":{"type":"string","description":"Customer Facebook ID"},"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Customer name"},"page_id":{"type":"string","description":"Page ID"}}},"total_quantity":{"type":"integer","description":"Total quantity"},"time_assign_marketer":{"type":"string","format":"date-time","description":"Time assign marketer"},"p_utm_source":{"type":"string","description":"UTM Source"},"p_utm_medium":{"type":"string","description":"UTM Medium"},"p_utm_campaign":{"type":"string","description":"UTM Campaign"},"p_utm_term":{"type":"string","description":"UTM Term"},"p_utm_content":{"type":"string","description":"UTM Content"},"p_utm_id":{"type":"string","description":"UTM ID"},"utm_affiliate":{"type":"string","description":"Affiliate"},"link":{"type":"string","description":"Link"},"status_history":{"type":"array","description":"Status update history","items":{"type":"object","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"editor":{"type":"object","description":"Editor information"},"editor_fb":{"type":"string","description":"Editor Facebook ID"},"editor_id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Name"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Status"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"duplicated_phone":{"type":"boolean","description":"Duplicated phone"},"order_currency":{"type":"string","description":"Order currency"},"charged_by_vnpay":{"type":"integer","description":"Charged by VNPay"},"charged_by_qrpay":{"type":"integer","description":"Charged by QRPay"},"custom_id":{"type":"string","description":"Custom ID"},"last_editor":{"type":"object","description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"name":{"type":"string","description":"Editor name"},"email":{"type":"string","description":"Editor email"},"avatar_url":{"type":"string","description":"Editor avatar URL"},"phone_number":{"type":"string","description":"Editor phone number"}}},"last_editor_id":{"type":"string","description":"Last editor ID"},"charged_by_momo":{"type":"integer","description":"Charged by MoMo"},"prepaid_by_point":{"type":"object","description":"Prepaid by point","properties":{"money":{"type":"integer","description":"Money amount","example":15000},"point":{"type":"integer","description":"Point amount","example":15}},"example":{"money":15000,"point":15}},"bank_transfer_images":{"type":"array","description":"Bank transfer images","items":{"type":"string","format":"uri"}},"transfer_money":{"type":"integer","description":"Transfer money"},"lock_order_by_user":{"type":"string","description":"Lock order by user ID"},"assigning_care":{"type":"object","description":"Assigning care information","properties":{"id":{"type":"string","description":"Care ID"},"fb_id":{"type":"string","description":"Facebook ID of care"},"name":{"type":"string","description":"Care name"},"email":{"type":"string","description":"Care email"},"avatar_url":{"type":"string","description":"Care avatar URL"},"phone_number":{"type":"string","description":"Care phone number"}}},"assigning_care_id":{"type":"string","description":"Assigning care ID"},"time_assign_care":{"type":"string","format":"date-time","description":"Time assign care"},"assigning_seller":{"type":"object","description":"Assigning seller information","properties":{"id":{"type":"string","description":"Seller ID"},"fb_id":{"type":"string","description":"Facebook ID of seller"},"name":{"type":"string","description":"Seller name"},"email":{"type":"string","description":"Seller email"},"avatar_url":{"type":"string","description":"Seller avatar URL"},"phone_number":{"type":"string","description":"Seller phone number"}}},"einvoices":{"type":"array","items":{"$ref":"#/components/schemas/EInvoice"}},"charged_by_card":{"type":"integer","description":"Charged by card"},"estimate_delivery_date":{"type":"string","format":"date-time","description":"Estimate delivery date"},"order_sources":{"type":"string","description":"Order sources ID"},"charged_by_fundiin":{"type":"integer","description":"Charged by Fundiin"},"surcharge":{"type":"integer","description":"Surcharge"},"is_linked_partner":{"type":"boolean","description":"Is linked partner"},"call_laters":{"type":"array","description":"Call laters","items":{"type":"object"}},"last_update_status_at":{"type":"string","format":"date-time","description":"Last update status at"},"discount_by_customer_level":{"type":"integer","description":"Discount by customer level"},"viewing":{"type":"array","description":"Viewing","items":{"type":"object"}},"additional_info":{"type":"object","description":"Additional info","properties":{"service_partner":{"type":"string","description":"Service partner","enum":["instant"],"x-enum-descriptions":["Instant"]},"delivery_deadline":{"type":"string","format":"date-time","description":"Delivery deadline (ISO8601, no timezone).","example":"2026-06-03T10:00:00"},"ship_by_date":{"type":"integer","nullable":true,"readOnly":true,"description":"Marketplace ship-by deadline (Unix timestamp, seconds) for Shopee/TikTok orders — the order must be handed over to the carrier before this time, otherwise the marketplace may cancel it automatically. Shopee `ship_by_date`, TikTok `collection_due_time`. `0` = the marketplace has not returned it yet; `null` for non-marketplace orders.","example":1793000000}}},"order_returned_ids":{"type":"string","description":"Order returned IDs"},"cost_surcharge":{"type":"integer","description":"Cost surcharge"},"time_send_partner":{"type":"string","format":"date-time","description":"Time send partner"},"charged_by_kredivo":{"type":"integer","description":"Charged by Kredivo"},"discount":{"type":"integer","description":"Discount"},"histories":{"type":"array","description":"Histories","items":{"type":"object"}},"duplicated_customer":{"type":"boolean","description":"Duplicated customer"},"customer_referral_code":{"type":"object","description":"Customer referral code","properties":{"active":{"type":"string","description":"Active status","example":"true"},"customer_id":{"type":"string","format":"uuid","description":"Customer ID","example":"09bb9399-45f3-4897-a53a-85dde2f886fe"},"discount":{"type":"string","description":"Discount value","example":"10"},"format":{"type":"string","description":"Referral code format","example":"{PHONE_NUMBER}"},"free_products_priced_between_approx":{"type":"object","description":"Free products priced between approximately","properties":{"active":{"type":"string","description":"Active status","example":"true"},"operator":{"type":"string","description":"Comparison operator","example":"GreaterOrEqual"},"price":{"type":"string","description":"Price threshold","example":"150000"}}},"is_percent":{"type":"string","description":"Discount is percentage","example":"true"},"only_customers_with_level_will_have_referral_code":{"type":"string","description":"Only customers with level will have referral code","example":"true"},"referral_code":{"type":"string","description":"Referral code","example":"982843759"},"reward_points_for_old_customers":{"type":"object","description":"Reward points for customers","properties":{"active":{"type":"string","description":"Active status","example":"true"},"money":{"type":"string","description":"Money reward","example":"10000"},"point":{"type":"string","description":"Point reward","example":"1"}}},"shop_customer_id":{"type":"string","format":"uuid","description":"Shop customer ID","example":"f8160a4c-dfa7-4ee8-b540-d245755ea1f1"}},"example":{"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"}},"tax":{"type":"integer","description":"Tax"},"is_from_ecommerce":{"type":"boolean","description":"Is from e-commerce"},"note_image":{"type":"array","description":"Note images","items":{"type":"string","format":"uri"}},"shopify_draft_order_id":{"type":"string","description":"Shopify draft order ID"},"display_id":{"type":"integer","description":"Display ID"},"shop_partner_id":{"type":"integer","description":"Shop partner ID"},"is_locked":{"type":"boolean","description":"Order lock"},"merge_order":{"type":"boolean","description":"Allows merging orders"}}},"example":{"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}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Order ID"},"system_id":{"type":"integer","description":"System ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Order creation time"},"updated_at":{"type":"string","format":"date-time","description":"Order update time"},"status":{"type":"integer","description":"Order status","enum":[0,17,11,12,13,20,1,8,9,2,3,16,4,15,5,6,7],"x-enum-descriptions":["New","Waiting for confirmation","Restocking","Wait for printing","Printed","Purchased","Confirmed","Packaging","Waiting for pick up","Shipped","Received","Collected money","Returning","Partial return","Returned","Canceled","Deleted recently"]},"status_name":{"type":"string","description":"Order status name"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"bill_email":{"type":"string","description":"Customer email"},"conversation_id":{"type":"string","description":"Conversation ID"},"page_id":{"type":"string","description":"Facebook page ID"},"post_id":{"type":"string","description":"Post ID"},"ad_id":{"type":"string","description":"Ad ID"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"partner_fee":{"type":"integer","description":"Fee from shipping partner"},"fee_marketplace":{"type":"integer","description":"Fees from e-commerce platforms"},"customer_pay_fee":{"type":"boolean","description":"Customer pay shipping fee"},"is_free_shipping":{"type":"boolean","description":"Free shipping"},"is_livestream":{"type":"boolean","description":"Is livestream order"},"is_live_shopping":{"type":"boolean","description":"Is live shopping order"},"is_smc":{"type":"boolean","description":"Shopping on Messenger"},"received_at_shop":{"type":"boolean","description":"true: Sales at counter, false: Sell online"},"total_discount":{"type":"integer","description":"Discount total"},"note":{"type":"string","description":"Internal note"},"note_print":{"type":"string","description":"Note for printing"},"returned_reason":{"type":"integer","description":"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_name":{"type":"string","description":"Return reason name"},"sub_status":{"type":"integer","description":"Reason for delivery delay"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"warehouse_info":{"type":"object","description":"Warehouse information","properties":{"name":{"type":"string","description":"Warehouse name"},"phone_number":{"type":"string","description":"Warehouse phone number"},"full_address":{"type":"string","description":"Warehouse full address"},"address":{"type":"string","description":"Warehouse address"},"province_id":{"type":"string","description":"Province ID"},"district_id":{"type":"string","description":"District ID"},"commune_id":{"type":"string","description":"Commune ID"},"affiliate_id":{"type":"string","description":"Affiliate ID"},"ffm_id":{"type":"string","description":"FFM ID"},"has_snappy_service":{"type":"boolean","description":"Has Snappy service"},"custom_id":{"type":"string","description":"Custom ID"}}},"creator_id":{"type":"string","description":"Creator ID"},"creator":{"type":"object","description":"Order creator","properties":{"id":{"type":"string","description":"Creator ID"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"name":{"type":"string","description":"Creator name"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"items":{"type":"array","description":"Product list. When creating or updating an order, each entry must include `variation_id` and `quantity`. `variation_info` is optional — if omitted, the backend treats it as an empty object; send it (with `retail_price`) when you need the line price to be explicit.","items":{"type":"object","required":["variation_id","quantity"],"properties":{"product_id":{"type":"string","description":"Product ID"},"quantity":{"type":"integer","description":"Quantity"},"returned_count":{"type":"integer","description":"Returned count"},"assigning_seller_id":{"type":"string","description":"Assigning seller ID"},"quantity_by_combo_products":{"type":"array","description":"Quantity by combo products","items":{"type":"object"}},"discount_each_product":{"type":"integer","description":"Discount for each product"},"is_bonus_product":{"type":"boolean","description":"Is bonus product"},"is_discount_percent":{"type":"boolean","description":"Is discount by percent"},"is_wholesale":{"type":"boolean","description":"Is wholesale"},"is_composite":{"type":"boolean","description":"Is composite product"},"one_time_product":{"type":"boolean","description":"One time product"},"note":{"type":"string","description":"Product note"},"note_product":{"type":"string","description":"Product note"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"measure_group_id":{"type":"integer","description":"Measure group ID"},"variation_info":{"type":"object","description":"Variation information. Optional when creating/updating an order (the backend defaults it to an empty object if omitted). Its inner fields are not individually required, but sending `retail_price` is recommended so the line price is correct.","properties":{"id":{"type":"string","description":"Variation ID"},"name":{"type":"string","description":"Product name"},"product_id":{"type":"string","description":"Product ID"},"retail_price":{"type":"integer","description":"Retail price. Not strictly required, but recommended when creating/updating an order so the line price is correct."},"detail":{"type":"string","description":"Variation detail"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"},"keyValue":{"type":"string","description":"Key value"}}}},"barcode":{"type":"string","description":"Barcode"},"brand_id":{"type":"string","description":"Brand ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"display_id":{"type":"string","description":"Display ID"},"product_display_id":{"type":"string","description":"Product display ID"},"last_imported_price":{"type":"integer","description":"Last imported price"},"is_upsale_product":{"type":"boolean","description":"Upsale product"},"weight":{"type":"integer","description":"Weight"},"measure_info":{"type":"object","description":"Measure information","properties":{"measure_id":{"type":"integer","description":"Measure ID"},"exchange_value":{"type":"integer","description":"Exchange value"}}},"avg_price":{"type":"integer","description":"Average import price"}}},"components":{"type":"array","description":"Product components","items":{"type":"object","properties":{"component_id":{"type":"string","description":"Component ID"},"quantity":{"type":"integer","description":"Quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information"}}}},"id":{"type":"integer","description":"Item ID"},"variation_id":{"type":"string","description":"Variation ID"}}}},"partner":{"type":"object","description":"Partner information\nWhen updating an order that already has shipping info, only the fields you send are written; omitted fields keep their current values. Send `null` to clear `partner_id`, `extend_code` or `shop_partner_id`.\n","properties":{"partner_id":{"type":"integer","description":"Partner ID"},"cod":{"type":"integer","description":"Reconciliation COD"},"extend_code":{"type":"string","description":"Shipping order ID on partner system"},"total_fee":{"type":"integer","description":"Total fee"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"delivery_name":{"type":"string","description":"Shipper name"},"delivery_tel":{"type":"string","description":"Delivery phone"},"picked_up_at":{"type":"string","format":"date-time","description":"Picked up at"},"sort_code":{"type":"string","description":"Sort code"},"paid_at":{"type":"string","format":"date-time","description":"Paid at"},"system_created":{"type":"boolean","description":"System created"},"extend_update":{"type":"array","description":"Update from courier","items":{"type":"object","properties":{"key":{"type":"string","description":"Update key"},"status":{"type":"string","description":"Status"},"tracking_id":{"type":"string","description":"Partner extend code"},"note":{"type":"string","description":"Courier notes"},"update_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"partner_status":{"type":"string","nullable":true,"description":"Partner shipping status","enum":["waiting","request_received","processing_picked_up","picking_up","delay_pickup","picked_up","waiting_on_the_way","on_the_way","contact_delivery_company","out_for_delivery","delay_delivery","inform_recipient","undeliverable","waiting_for_return","delivered","delivered_cod","returning","returned","returned_cod","canceled"],"x-enum-descriptions":["Waiting for processing","Carrier received the request","Processing pickup","Picking up","Delayed pickup","Picked up","Waiting for transit","In transit","Contact the carrier","Out for delivery","Delayed delivery","Notify the recipient","Undeliverable","Waiting for return","Delivered","Delivered, COD reconciled","Returning","Returned","Returned, COD reconciled","Canceled"]},"partner_name":{"type":"string","nullable":true,"description":"Partner name"},"first_delivery_at":{"type":"string","format":"date-time","nullable":true,"description":"First delivery time"},"first_undeliverable_at":{"type":"string","format":"date-time","nullable":true,"description":"First failed delivery time"},"count_of_delivery":{"type":"integer","nullable":true,"minimum":0,"maximum":32767,"description":"Number of delivery attempts. Courier updates add 1 each time the shipment moves to `out_for_delivery` or `delay_delivery`.\nCan be set when creating or updating an order (integer 0-32767); omitted or invalid values keep the current value, and later courier updates keep counting from the value you set.\n","example":2},"order_number_vtp":{"type":"string","nullable":true,"description":"Viettel Post tracking number"},"printed_form":{"type":"object","nullable":true,"description":"Printed form"}}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"payment_purchase_histories":{"type":"array","description":"Payment histories","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount of money"},"type":{"type":"string","description":"Payment type"},"inserted_at":{"type":"string","format":"date-time","description":"Transaction time"},"result_code":{"type":"string","description":"Result code"},"ipn_reply":{"type":"boolean","description":"IPN reply"},"voucher_amount":{"type":"integer","description":"Voucher amount"},"tags":{"type":"array","description":"Tags","items":{"type":"string"}}}}},"tags":{"type":"array","description":"Tags list","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"}}}},"marketer":{"type":"object","description":"Marketer information","properties":{"id":{"type":"string","description":"Marketer ID"},"name":{"type":"string","description":"Marketer name"},"email":{"type":"string","description":"Marketer email"},"phone_number":{"type":"string","description":"Marketer phone number"},"fb_id":{"type":"string","description":"Marketer Facebook ID"},"avatar_url":{"type":"string","description":"Marketer avatar URL"}}},"pke_mkter":{"type":"string","description":"Marketer ID"},"activated_combo_products":{"type":"object","description":"Activated combo products information","properties":{"combo_product_id":{"type":"integer","description":"Combo product ID"},"quantity_combo_activated":{"type":"integer","description":"Quantity combo activated"},"combo_product_info":{"type":"object","description":"Combo product information"}}},"activated_promotion_advances":{"type":"array","description":"Activated promotion advances information","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"promotion_advance_id":{"type":"string","description":"Promotion advance ID"},"promotion_advance_info":{"type":"object","description":"Promotion advance information"}}}},"invoice_info_list":{"type":"array","description":"Invoice information list","items":{"type":"object","properties":{"error":{"type":"string","description":"Error message if any"},"invoice_detail":{"type":"object","description":"Invoice detail information. The fields to send depend on `invoice_type`:\n- `company`: use `company_name`, `company_tax_id`, `company_address`, `company_email` (and optionally `company_address_breakdown`).\n- `personal`: use `name`, `phone_number`, `identity_code`, `tax_id`, `email`.\n","properties":{"name":{"type":"string","description":"Full name of the individual requesting the invoice (`invoice_type` = `personal`)","example":"Hoang Anh"},"phone_number":{"type":"string","description":"Phone number of the individual (`invoice_type` = `personal`)","example":"0934283743"},"identity_code":{"type":"string","description":"Citizen identity card / ID number of the individual (`invoice_type` = `personal`)","example":"029374382740"},"tax_id":{"type":"string","description":"Personal tax ID of the individual, if any (`invoice_type` = `personal`)","example":""},"email":{"type":"string","description":"Email of the individual to receive the e-invoice (`invoice_type` = `personal`)","example":""},"company_address":{"type":"string","description":"Company address (`invoice_type` = `company`)"},"company_address_breakdown":{"type":"object","description":"Company address breakdown","properties":{"company_additional_info":{"type":"string","description":"Company additional information"},"company_barangay":{"type":"string","description":"Company barangay"},"company_city":{"type":"string","description":"Company city"},"company_detailed_address":{"type":"string","description":"Company detailed address"},"company_district":{"type":"string","description":"Company district"},"company_full_address":{"type":"string","description":"Company full address"},"company_postcode":{"type":"string","description":"Company postcode"},"company_province":{"type":"string","description":"Company province"},"company_region":{"type":"string","description":"Company region"},"company_state":{"type":"string","description":"Company state"},"company_town":{"type":"string","description":"Company town"}}},"company_email":{"type":"string","description":"Company email (`invoice_type` = `company`)"},"company_name":{"type":"string","description":"Company name (`invoice_type` = `company`)"},"company_tax_id":{"type":"string","description":"Company tax ID (`invoice_type` = `company`)"}}},"invoice_type":{"type":"string","enum":["company","personal"],"description":"Invoice type: `company` for an organization, `personal` for an individual.\nDetermines which `invoice_detail` fields are used.\n","example":"personal"},"is_requested":{"type":"boolean","description":"Customer requests an e-invoice for this order. Set `true` together with `invoice_type` and `invoice_detail` to request invoice issuance.","example":true},"order_sn":{"type":"string","description":"Order code on the marketplace"}}}},"reports_by_phone":{"type":"object","description":"Reports by phone number","properties":{"order_fail":{"type":"integer","description":"Number of failed orders"},"order_success":{"type":"integer","description":"Number of successful orders"},"warning":{"type":"integer","description":"Number of warnings orders"}},"example":{"+639175706297":{"order_fail":29,"order_success":20,"warning":0}}},"tracking_link":{"type":"string","description":"Link confirm order"},"payment_link":{"type":"string","description":"Payment link"},"ads_source":{"type":"string","description":"Advertising source"},"bank_payments":{"type":"object","description":"Payment method"},"transfer_proofs":{"type":"array","description":"Bank transfer payment proofs, including verification time, amount and receipt images","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transfer proof ID"},"order_id":{"type":"integer","description":"Order ID"},"shop_id":{"type":"integer","description":"Shop ID"},"payment_id":{"type":"string","description":"Bank payment method ID (matches a key in `bank_payments`)"},"amount":{"type":"integer","description":"Transferred amount"},"images":{"type":"array","description":"Transfer receipt images","items":{"type":"string"}},"note":{"type":"string","nullable":true,"description":"Note"},"is_income":{"type":"boolean","description":"Money received (true) or paid out (false)"},"is_verify":{"type":"boolean","description":"Whether the transfer has been verified"},"verify_at":{"type":"string","format":"date-time","nullable":true,"description":"Verification time"},"verifier":{"type":"object","nullable":true,"description":"Verifier information","properties":{"id":{"type":"string","description":"Verifier ID"},"name":{"type":"string","description":"Verifier name"},"fb_id":{"type":"string","description":"Facebook ID of verifier"},"avatar_url":{"type":"string","description":"Verifier avatar URL"}}},"creator":{"type":"object","nullable":true,"description":"Creator information","properties":{"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"last_editor":{"type":"object","nullable":true,"description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Editor name"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"avatar_url":{"type":"string","description":"Editor avatar URL"}}},"order_info":{"type":"object","nullable":true,"description":"Additional order information"},"inserted_at":{"type":"string","format":"date-time","description":"Transfer proof creation time"},"updated_at":{"type":"string","format":"date-time","description":"Transfer proof update time"}}}},"shopify_order_id":{"type":"string","description":"Shopify order ID"},"shopify_abandon_checkout_id":{"type":"integer","description":"Shopify abandon checkout ID"},"is_abandoned_order":{"type":"boolean","description":"Abandoned-cart flag for creating or updating an order. Send it directly in the request body, not inside `third_party` or `third_party_infomation`.\nAn 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.\nOnly boolean `true` or string `\"true\"` is normalized to `true`; all other submitted values become `false`.\n","example":true},"cod":{"type":"integer","description":"Cash on delivery"},"cash":{"type":"integer","description":"Cash payment"},"account":{"type":"integer","description":"Order source ID"},"account_name":{"type":"string","description":"Order source name"},"advanced_platform_fee":{"type":"object","description":"Fees from e-commerce platforms","properties":{"ads_top_up":{"type":"integer","description":"Ads wallet top-up"},"affiliate_commission":{"type":"integer","description":"Affiliate commission"},"diff_shipping_fee":{"type":"integer","description":"Difference shipping fee"},"marketplace_voucher":{"type":"integer","description":"Marketplace voucher"},"payment_fee":{"type":"integer","description":"Payment fee"},"platform_commission":{"type":"integer","description":"Platform commission"},"seller_transaction_fee":{"type":"integer","description":"Seller transaction fee"},"service_fee":{"type":"integer","description":"Service fee"},"sfp_service_fee":{"type":"integer","description":"SFP service fee"}}},"printing_count":{"type":"integer","description":"Printing count"},"money_to_collect":{"type":"integer","description":"Money to collect"},"marketplace_id":{"type":"string","description":"Marketplace ID","enum":["-2","-3","-4","-9","-16","-17","-20","-25","-27","-28"],"x-enum-descriptions":{"-2":"Tiki","-3":"Shopee","-4":"Lazada","-9":"TikTok","-16":"WooCommerce","-17":"Shopify","-20":"Line Shopping","-25":"Tokopedia","-27":"Mercado Libre","-28":"Tiendanube"}},"total_price":{"type":"integer","description":"Total price"},"shop_customer_address_id":{"type":"string","description":"Customer address ID"},"customer":{"type":"object","description":"Customer information","properties":{"fb_id":{"type":"string","description":"Customer Facebook ID"},"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Customer name"},"page_id":{"type":"string","description":"Page ID"}}},"total_quantity":{"type":"integer","description":"Total quantity"},"time_assign_marketer":{"type":"string","format":"date-time","description":"Time assign marketer"},"p_utm_source":{"type":"string","description":"UTM Source"},"p_utm_medium":{"type":"string","description":"UTM Medium"},"p_utm_campaign":{"type":"string","description":"UTM Campaign"},"p_utm_term":{"type":"string","description":"UTM Term"},"p_utm_content":{"type":"string","description":"UTM Content"},"p_utm_id":{"type":"string","description":"UTM ID"},"utm_affiliate":{"type":"string","description":"Affiliate"},"link":{"type":"string","description":"Link"},"status_history":{"type":"array","description":"Status update history","items":{"type":"object","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"editor":{"type":"object","description":"Editor information"},"editor_fb":{"type":"string","description":"Editor Facebook ID"},"editor_id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Name"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Status"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"duplicated_phone":{"type":"boolean","description":"Duplicated phone"},"order_currency":{"type":"string","description":"Order currency"},"charged_by_vnpay":{"type":"integer","description":"Charged by VNPay"},"charged_by_qrpay":{"type":"integer","description":"Charged by QRPay"},"custom_id":{"type":"string","description":"Custom ID"},"last_editor":{"type":"object","description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"name":{"type":"string","description":"Editor name"},"email":{"type":"string","description":"Editor email"},"avatar_url":{"type":"string","description":"Editor avatar URL"},"phone_number":{"type":"string","description":"Editor phone number"}}},"last_editor_id":{"type":"string","description":"Last editor ID"},"charged_by_momo":{"type":"integer","description":"Charged by MoMo"},"prepaid_by_point":{"type":"object","description":"Prepaid by point","properties":{"money":{"type":"integer","description":"Money amount","example":15000},"point":{"type":"integer","description":"Point amount","example":15}},"example":{"money":15000,"point":15}},"bank_transfer_images":{"type":"array","description":"Bank transfer images","items":{"type":"string","format":"uri"}},"transfer_money":{"type":"integer","description":"Transfer money"},"lock_order_by_user":{"type":"string","description":"Lock order by user ID"},"assigning_care":{"type":"object","description":"Assigning care information","properties":{"id":{"type":"string","description":"Care ID"},"fb_id":{"type":"string","description":"Facebook ID of care"},"name":{"type":"string","description":"Care name"},"email":{"type":"string","description":"Care email"},"avatar_url":{"type":"string","description":"Care avatar URL"},"phone_number":{"type":"string","description":"Care phone number"}}},"assigning_care_id":{"type":"string","description":"Assigning care ID"},"time_assign_care":{"type":"string","format":"date-time","description":"Time assign care"},"assigning_seller":{"type":"object","description":"Assigning seller information","properties":{"id":{"type":"string","description":"Seller ID"},"fb_id":{"type":"string","description":"Facebook ID of seller"},"name":{"type":"string","description":"Seller name"},"email":{"type":"string","description":"Seller email"},"avatar_url":{"type":"string","description":"Seller avatar URL"},"phone_number":{"type":"string","description":"Seller phone number"}}},"einvoices":{"type":"array","items":{"$ref":"#/components/schemas/EInvoice"}},"charged_by_card":{"type":"integer","description":"Charged by card"},"estimate_delivery_date":{"type":"string","format":"date-time","description":"Estimate delivery date"},"order_sources":{"type":"string","description":"Order sources ID"},"charged_by_fundiin":{"type":"integer","description":"Charged by Fundiin"},"surcharge":{"type":"integer","description":"Surcharge"},"is_linked_partner":{"type":"boolean","description":"Is linked partner"},"call_laters":{"type":"array","description":"Call laters","items":{"type":"object"}},"last_update_status_at":{"type":"string","format":"date-time","description":"Last update status at"},"discount_by_customer_level":{"type":"integer","description":"Discount by customer level"},"viewing":{"type":"array","description":"Viewing","items":{"type":"object"}},"additional_info":{"type":"object","description":"Additional info","properties":{"service_partner":{"type":"string","description":"Service partner","enum":["instant"],"x-enum-descriptions":["Instant"]},"delivery_deadline":{"type":"string","format":"date-time","description":"Delivery deadline (ISO8601, no timezone).","example":"2026-06-03T10:00:00"},"ship_by_date":{"type":"integer","nullable":true,"readOnly":true,"description":"Marketplace ship-by deadline (Unix timestamp, seconds) for Shopee/TikTok orders — the order must be handed over to the carrier before this time, otherwise the marketplace may cancel it automatically. Shopee `ship_by_date`, TikTok `collection_due_time`. `0` = the marketplace has not returned it yet; `null` for non-marketplace orders.","example":1793000000}}},"order_returned_ids":{"type":"string","description":"Order returned IDs"},"cost_surcharge":{"type":"integer","description":"Cost surcharge"},"time_send_partner":{"type":"string","format":"date-time","description":"Time send partner"},"charged_by_kredivo":{"type":"integer","description":"Charged by Kredivo"},"discount":{"type":"integer","description":"Discount"},"histories":{"type":"array","description":"Histories","items":{"type":"object"}},"duplicated_customer":{"type":"boolean","description":"Duplicated customer"},"customer_referral_code":{"type":"object","description":"Customer referral code","properties":{"active":{"type":"string","description":"Active status","example":"true"},"customer_id":{"type":"string","format":"uuid","description":"Customer ID","example":"09bb9399-45f3-4897-a53a-85dde2f886fe"},"discount":{"type":"string","description":"Discount value","example":"10"},"format":{"type":"string","description":"Referral code format","example":"{PHONE_NUMBER}"},"free_products_priced_between_approx":{"type":"object","description":"Free products priced between approximately","properties":{"active":{"type":"string","description":"Active status","example":"true"},"operator":{"type":"string","description":"Comparison operator","example":"GreaterOrEqual"},"price":{"type":"string","description":"Price threshold","example":"150000"}}},"is_percent":{"type":"string","description":"Discount is percentage","example":"true"},"only_customers_with_level_will_have_referral_code":{"type":"string","description":"Only customers with level will have referral code","example":"true"},"referral_code":{"type":"string","description":"Referral code","example":"982843759"},"reward_points_for_old_customers":{"type":"object","description":"Reward points for customers","properties":{"active":{"type":"string","description":"Active status","example":"true"},"money":{"type":"string","description":"Money reward","example":"10000"},"point":{"type":"string","description":"Point reward","example":"1"}}},"shop_customer_id":{"type":"string","format":"uuid","description":"Shop customer ID","example":"f8160a4c-dfa7-4ee8-b540-d245755ea1f1"}},"example":{"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"}},"tax":{"type":"integer","description":"Tax"},"is_from_ecommerce":{"type":"boolean","description":"Is from e-commerce"},"note_image":{"type":"array","description":"Note images","items":{"type":"string","format":"uri"}},"shopify_draft_order_id":{"type":"string","description":"Shopify draft order ID"},"display_id":{"type":"integer","description":"Display ID"},"shop_partner_id":{"type":"integer","description":"Shop partner ID"},"is_locked":{"type":"boolean","description":"Order lock"},"merge_order":{"type":"boolean","description":"Allows merging orders"}}},"examples":{"default":{"value":{"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}}}}}}}}},"/shops/{SHOP_ID}/orders/{ORDER_ID}/messages":{"get":{"summary":"Get order conversation messages","x-summary-i18n":{"vie":"Lấy tin nhắn hội thoại của đơn hàng"},"description":"Resolves the conversation associated with the order and returns messages from the entire conversation. Messages in each response are ordered chronologically (oldest to newest).\n\nPagination follows the Pancake web application semantics:\n- Omit `current_count` or set it to `0` to load up to 25 of the newest records, rendered in chronological order.\n- 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.\n- Calls with a positive `current_count` return up to 30 older messages.\n\nA valid order without an associated conversation returns `{\"success\":true,\"data\":[]}`.\n","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"ORDER_ID","in":"path","required":true,"schema":{"type":"string","example":"SOICUN-12943-02"},"description":"Order ID"},{"name":"current_count","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":2147483647,"default":0,"example":25},"description":"Number of messages already loaded. This is an offset count, not a cursor."},{"name":"fields[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"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.","example":["id","message","inserted_at"]}],"responses":{"200":{"description":"Conversation messages, an empty data array when the valid order has no conversation, or a legacy authentication error returned with HTTP 200","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","enum":[true],"description":"Success status"},"data":{"type":"array","description":"Conversation messages in chronological order","items":{"$ref":"#/components/schemas/OrderMessage"}}}},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"default":{"value":{"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}]}},"authentication_required":{"value":{"success":false,"message":"Missing access_token","error_code":101}}}}}},"400":{"description":"The current_count parameter is invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"error":"invalid_parameters"}}}},"403":{"description":"The API key is invalid or disabled, or the authenticated user cannot access order management","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalid_api_key":{"value":{"success":false,"message":"api_key is invalid","error_code":105}},"missing_permission":{"value":{"success":false,"message":"Insufficient permissions","permission":"ql_donhang"}}}}}},"404":{"description":"The shop or order does not exist, or the order is not visible to the authenticated API client","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"error":"order_not_found"}}}},"429":{"description":"The Open API request rate limit was reached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"message":"You have reached the limit of requests","error_code":106}}}},"502":{"description":"The upstream conversation service returned an error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"error":"message_provider_error"}}}},"504":{"description":"The upstream conversation service timed out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"error":"message_provider_timeout"}}}}}}},"/shops/{SHOP_ID}/orders/{ORDER_ID}/print":{"get":{"summary":"Print order as PDF","x-summary-i18n":{"vie":"In đơn hàng ra PDF"},"description":"Fills one of the shop's print templates with the order data and returns a PDF, as when printing the order from POS web.\n\nWhen `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.\n\n- The page size follows the template's paper size. Roll paper (K80, K58...) returns one page whose height fits the content.\n- Printing through this endpoint does not increase the order's printing count.\n- 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.\n\nThe 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.\n\nErrors are returned as JSON. For the `404` order and print template errors and the `503` error, the `message` follows the shop's language.\n","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"ORDER_ID","in":"path","required":true,"schema":{"type":"string","example":"1418"},"description":"Order ID, system ID or custom order ID"},{"name":"label_id","in":"query","required":false,"schema":{"type":"integer","example":922009896},"description":"ID of the shop's print template. Omit it to choose the template automatically."}],"responses":{"200":{"description":"The order printed as a PDF file, or a legacy authentication error returned with HTTP 200","headers":{"Content-Disposition":{"description":"Inline file name of the PDF, for example `inline; filename=\"order-1418.pdf\"`","schema":{"type":"string"}}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"authentication_required":{"value":{"success":false,"message":"Missing access_token","error_code":101}}}}}},"403":{"description":"The API key is invalid or disabled, or the authenticated user cannot access order management","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalid_api_key":{"value":{"success":false,"message":"api_key is invalid","error_code":105}},"missing_permission":{"value":{"success":false,"message":"Account does not have permission: Manage orders","permission":"ql_donhang"}}}}}},"404":{"description":"The shop or order does not exist, the order is not visible to the authenticated API client, or `label_id` is not a print template of the shop","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"order_not_found":{"value":{"success":false,"message":"You do not have permission to view this order"}},"label_not_found":{"value":{"success":false,"message":"Print template not found"}}}}}},"429":{"description":"The Open API request rate limit was reached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"message":"You have reached the limit of requests","error_code":106}}}},"503":{"description":"The PDF could not be rendered. Retry later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"message":"Could not print the order, please try again later"}}}}}}},"/shops/{SHOP_ID}/order_source":{"get":{"summary":"List of order sources","x-summary-i18n":{"vie":"Danh sách nguồn đơn hàng"},"description":"Get list of order sources","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Order sources list","properties":{"data":{"type":"array","description":"List of order sources","items":{"type":"object","properties":{"id":{"type":"string","description":"Order source ID or page ID"},"name":{"type":"string","description":"Order source name or page name"},"parent_id":{"type":"integer","description":"Parent order source ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Created at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"link":{"type":"string","nullable":true,"description":"Fixed source link (Webcake landing link)"}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"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}}}}}}}}},"/shops/{SHOP_ID}/orders/tags":{"get":{"summary":"List of order tags","x-summary-i18n":{"vie":"Danh sách thẻ đơn hàng"},"description":"Get list of order tags","tags":["Order tag"],"x-tags-i18n":{"vie":["Thẻ đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Order tags list","properties":{"data":{"type":"array","description":"List of order tags","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"},"color":{"type":"string","description":"Tag color code"},"is_system_tag":{"type":"boolean","description":"Is system tag"},"groups":{"type":"array","description":"Tag group information","items":{"type":"object","properties":{"id":{"type":"integer","description":"Group ID"},"name":{"type":"string","description":"Group name"}}}}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"data":[{"id":75,"name":"thẻ 4","color":"#123123","is_system_tag":false,"groups":[{"id":13,"name":"nhom 1"},{"id":16,"name":"nhom 2"}]},{"id":1,"name":"Giao không thành","color":"#f04134","is_system_tag":true,"groups":[{"id":-1,"name":"Delivery Group"},{"id":13,"name":"nhom 1"}]},{"id":2,"name":"Chờ cọc","color":"#096dd9","is_system_tag":true,"groups":[]}],"success":true}}}}}}}},"post":{"summary":"Create order tag","x-summary-i18n":{"vie":"Tạo thẻ đơn hàng"},"description":"Create a new order tag","tags":["Order tag"],"x-tags-i18n":{"vie":["Thẻ đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Request body containing order tag information to create","content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Tag name"},"tag_color":{"type":"string","description":"Tag color code"},"groups":{"type":"array","description":"List of tag group IDs. Get by API GET /shops/{SHOP_ID}/orders/tag_groups","items":{"type":"integer"}},"statuses":{"type":"array","description":"List of order statuses to apply the tag","items":{"type":"integer"}}},"example":{"name":"test 5.1","tag_color":"#000","groups":[1],"statuses":[1,2,3]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"Created order tag information","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"},"tag_color":{"type":"string","description":"Tag color code"},"groups":{"type":"array","description":"List of tag group IDs","items":{"type":"integer"}},"statuses":{"type":"array","description":"List of order statuses to apply the tag","items":{"type":"integer"}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"data":{"id":50,"name":"test 5.1","tag_color":"#000","groups":[1],"statuses":[1,2,3]},"success":true}}}}}}}}},"/shops/{SHOP_ID}/orders/tags/{TAG_ID}":{"put":{"summary":"Update order tag","x-summary-i18n":{"vie":"Cập nhật thẻ đơn hàng"},"description":"Update an order tag. Only applies to tags that are not system tags (is_system_tag = false)","tags":["Order tag"],"x-tags-i18n":{"vie":["Thẻ đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"TAG_ID","in":"path","required":true,"schema":{"type":"integer","example":45},"description":"Tag ID"}],"requestBody":{"required":true,"description":"Request body containing order tag information to update","content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Tag name"},"tag_color":{"type":"string","description":"Tag color code"},"groups":{"type":"array","description":"List of tag group IDs. Get by API GET /shops/{SHOP_ID}/orders/tag_groups","items":{"type":"integer"}},"statuses":{"type":"array","description":"List of order statuses to apply the tag","items":{"type":"integer"}}},"example":{"name":"test 4.4","tag_color":"#000","groups":[1,2],"statuses":[1,2,3]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"Updated order tag information","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"},"tag_color":{"type":"string","description":"Tag color code"},"groups":{"type":"array","description":"List of tag group IDs","items":{"type":"integer"}},"statuses":{"type":"array","description":"List of order statuses to apply the tag","items":{"type":"integer"}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"data":{"id":45,"name":"test 4.4","tag_color":"#000","groups":[2,1],"statuses":[1,2,3]},"success":true}}}}}}}}},"/shops/{SHOP_ID}/orders/tag_groups":{"get":{"summary":"List of order tag groups","x-summary-i18n":{"vie":"Danh sách nhóm thẻ đơn hàng"},"description":"Get list of order tag groups","tags":["Order tag"],"x-tags-i18n":{"vie":["Thẻ đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Order tag groups list","properties":{"data":{"type":"array","description":"List of order tag groups","items":{"type":"object","properties":{"id":{"type":"integer","description":"Group ID"},"name":{"type":"string","description":"Group name"},"add_multiple_tags":{"type":"boolean","description":"Allow adding multiple tags of the group to an order"},"tags":{"type":"array","description":"List of tag IDs in the group","items":{"type":"integer"}}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"data":[{"id":1,"name":"nhóm 1","add_multiple_tags":true,"tags":[41,50,45]}],"success":true}}}}}}}}},"/shops/{SHOP_ID}/products/get_logistics_shipping_document":{"post":{"summary":"Get link print label","x-summary-i18n":{"vie":"Lấy liên kết in đơn"},"description":"Get link to print shipping label and packing slips","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"document_type","in":"query","required":false,"schema":{"type":"string","enum":["SL_PL","SHIPPING_LABEL","PICK_LIST"],"x-enum-descriptions":["Shipping label + Packing slips","Shipping label","Packing slips"],"example":"SL_PL"},"description":"Document type"}],"requestBody":{"required":true,"description":"Request body containing list of order IDs to print labels","content":{"application/json":{"schema":{"type":"object","required":["params"],"properties":{"params":{"type":"array","description":"List of order IDs","items":{"type":"object","required":["order_id"],"properties":{"order_id":{"type":"string","description":"Order ID"}}}}},"example":{"params":[{"order_id":"576551803772635228"}]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Print label links","properties":{"data":{"type":"array","description":"List of print label URLs","items":{"type":"string","format":"uri"}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"data":["https://content.pancake.vn/2-25/2025/3/28/071edc2cc6c728f6c3fa493a2cb033e8f61fb11e.071edc2cc6c728f6c3fa493a2cb033e8f61fb11e"],"success":true}}}}}}}}},"/shops/{SHOP_ID}/orders/get_tracking_url":{"post":{"summary":"Get order confirm link","x-summary-i18n":{"vie":"Lấy liên kết xác nhận đơn hàng"},"description":"Get order confirm link","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Request body containing system ID to get tracking URL","content":{"application/json":{"schema":{"type":"object","required":["system_id"],"properties":{"system_id":{"type":"integer","description":"System ID"}},"example":{"system_id":862}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Tracking URL","properties":{"url":{"type":"string","format":"uri","description":"Order confirm link"},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"url":"https://pke.gg/99gjy3r","success":true}}}}}}}}},"/shops/{SHOP_ID}/orders/{ORDER_ID}/trigger_call":{"post":{"summary":"Trigger auto voice call for an order","x-summary-i18n":{"vie":"Kích hoạt cuộc gọi tự động cho đơn hàng"},"description":"Trigger an automated outbound call (Auto Voice) to the order's customer phone number and play the selected voice. Returns a background job id; the call outcome is delivered asynchronously. The SIP subscription must have the Auto Voice add-on enabled.","tags":["Auto Voice"],"x-tags-i18n":{"vie":["Gọi tự động"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"ORDER_ID","in":"path","required":true,"schema":{"type":"string","example":"1418"},"description":"Order ID"}],"requestBody":{"required":true,"description":"Request body containing the voice id to play","content":{"application/json":{"schema":{"type":"object","required":["voice_id"],"properties":{"voice_id":{"type":"string","format":"uuid","description":"Voice id (copied from the voice management screen)"}},"example":{"voice_id":"3f7c2b9a-1e4d-4a2b-9c8e-2b1d0a9f6e5c"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true}}}}}}}}},"/shops/{SHOP_ID}/orders/arrange_shipment":{"post":{"summary":"Prepare order shipment","x-summary-i18n":{"vie":"Chuẩn bị hàng đơn sàn"},"description":"Prepare order shipment","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Request body containing order IDs to prepare shipment","content":{"application/json":{"schema":{"type":"object","required":["order_id"],"properties":{"order_id":{"type":"string","description":"Order ID"},"pickup_shift":{"type":"string","description":"Pickup shift. Required for Shopee platform.","enum":["closest","farthest"],"x-enum-descriptions":["closest","farthest"],"example":"closest"},"pickup_method":{"type":"string","description":"Pickup method. Required for Shopee and TikTok platforms.","enum":["pick_up","drop_off"],"x-enum-descriptions":["ĐVVC lấy hàng","Mang hàng ra bưu cục"],"example":"pick_up"}},"example":{"order_id":"34123423498237","pickup_shift":"closest","pickup_method":"pick_up"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Arrange shipment response","properties":{"message":{"type":"string","description":"Response message"},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"message":"Arrange shipment successfully","success":true}}}}}}}}},"/shops/{SHOP_ID}/orders/get_promotion_advance_active":{"post":{"summary":"List of advanced promotions of order","x-summary-i18n":{"vie":"Danh sách khuyến mại nâng cao của đơn"},"description":"Get list of advanced promotions that can be applied to an order","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Request body containing order information (existing order ID or new order details) to get active promotions","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["order_id"],"properties":{"order_id":{"type":"string","description":"Order ID (for existing order)"}}},{"type":"object","required":["order"],"properties":{"order":{"type":"object","required":["shop_id","items"],"properties":{"shop_id":{"type":"integer","description":"Shop ID"},"received_at_shop":{"type":"boolean","description":"Sales at counter"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"order_currency":{"type":"string","description":"Order currency"},"order_sources":{"type":"integer","description":"Order source ID"},"customer":{"type":"object","description":"Customer information","properties":{"shop_customer":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}}}}}},"items":{"type":"array","description":"Product list","items":{"type":"object","required":["product_id","variation_id"],"properties":{"product_id":{"type":"string","description":"Product ID"},"variation_id":{"type":"string","description":"Variation ID"},"quantity":{"type":"integer","description":"Quantity"},"variation_info":{"type":"object","description":"Variation information"}}}}}}}}],"examples":{"existing_order":{"value":{"order_id":"LMP0266310053VNA"}},"new_order":{"value":{"order":{"shop_id":224,"received_at_shop":false,"warehouse_id":"73c9505e-0f90-4a18-a1a1-13e1bdac21ee","order_currency":"VND","order_sources":-3,"customer":{"shop_customer":{"tags":["Tiềm năng"]}},"items":[{"product_id":"4a6fc152-5989-4202-83d4-a11a2ab28078","variation_id":"ad5a7194-034f-49cb-9d27-64fec1f30999","quantity":1,"variation_info":{"retail_price":500000,"category_ids":[1572],"product_tags":[196]}}]}}}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Order ID"},"system_id":{"type":"integer","description":"System ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Order creation time"},"updated_at":{"type":"string","format":"date-time","description":"Order update time"},"status":{"type":"integer","description":"Order status","enum":[0,17,11,12,13,20,1,8,9,2,3,16,4,15,5,6,7],"x-enum-descriptions":["New","Waiting for confirmation","Restocking","Wait for printing","Printed","Purchased","Confirmed","Packaging","Waiting for pick up","Shipped","Received","Collected money","Returning","Partial return","Returned","Canceled","Deleted recently"]},"status_name":{"type":"string","description":"Order status name"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"bill_email":{"type":"string","description":"Customer email"},"conversation_id":{"type":"string","description":"Conversation ID"},"page_id":{"type":"string","description":"Facebook page ID"},"post_id":{"type":"string","description":"Post ID"},"ad_id":{"type":"string","description":"Ad ID"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"partner_fee":{"type":"integer","description":"Fee from shipping partner"},"fee_marketplace":{"type":"integer","description":"Fees from e-commerce platforms"},"customer_pay_fee":{"type":"boolean","description":"Customer pay shipping fee"},"is_free_shipping":{"type":"boolean","description":"Free shipping"},"is_livestream":{"type":"boolean","description":"Is livestream order"},"is_live_shopping":{"type":"boolean","description":"Is live shopping order"},"is_smc":{"type":"boolean","description":"Shopping on Messenger"},"received_at_shop":{"type":"boolean","description":"true: Sales at counter, false: Sell online"},"total_discount":{"type":"integer","description":"Discount total"},"note":{"type":"string","description":"Internal note"},"note_print":{"type":"string","description":"Note for printing"},"returned_reason":{"type":"integer","description":"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_name":{"type":"string","description":"Return reason name"},"sub_status":{"type":"integer","description":"Reason for delivery delay"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"warehouse_info":{"type":"object","description":"Warehouse information","properties":{"name":{"type":"string","description":"Warehouse name"},"phone_number":{"type":"string","description":"Warehouse phone number"},"full_address":{"type":"string","description":"Warehouse full address"},"address":{"type":"string","description":"Warehouse address"},"province_id":{"type":"string","description":"Province ID"},"district_id":{"type":"string","description":"District ID"},"commune_id":{"type":"string","description":"Commune ID"},"affiliate_id":{"type":"string","description":"Affiliate ID"},"ffm_id":{"type":"string","description":"FFM ID"},"has_snappy_service":{"type":"boolean","description":"Has Snappy service"},"custom_id":{"type":"string","description":"Custom ID"}}},"creator_id":{"type":"string","description":"Creator ID"},"creator":{"type":"object","description":"Order creator","properties":{"id":{"type":"string","description":"Creator ID"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"name":{"type":"string","description":"Creator name"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"items":{"type":"array","description":"Product list. When creating or updating an order, each entry must include `variation_id` and `quantity`. `variation_info` is optional — if omitted, the backend treats it as an empty object; send it (with `retail_price`) when you need the line price to be explicit.","items":{"type":"object","required":["variation_id","quantity"],"properties":{"product_id":{"type":"string","description":"Product ID"},"quantity":{"type":"integer","description":"Quantity"},"returned_count":{"type":"integer","description":"Returned count"},"assigning_seller_id":{"type":"string","description":"Assigning seller ID"},"quantity_by_combo_products":{"type":"array","description":"Quantity by combo products","items":{"type":"object"}},"discount_each_product":{"type":"integer","description":"Discount for each product"},"is_bonus_product":{"type":"boolean","description":"Is bonus product"},"is_discount_percent":{"type":"boolean","description":"Is discount by percent"},"is_wholesale":{"type":"boolean","description":"Is wholesale"},"is_composite":{"type":"boolean","description":"Is composite product"},"one_time_product":{"type":"boolean","description":"One time product"},"note":{"type":"string","description":"Product note"},"note_product":{"type":"string","description":"Product note"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"measure_group_id":{"type":"integer","description":"Measure group ID"},"variation_info":{"type":"object","description":"Variation information. Optional when creating/updating an order (the backend defaults it to an empty object if omitted). Its inner fields are not individually required, but sending `retail_price` is recommended so the line price is correct.","properties":{"id":{"type":"string","description":"Variation ID"},"name":{"type":"string","description":"Product name"},"product_id":{"type":"string","description":"Product ID"},"retail_price":{"type":"integer","description":"Retail price. Not strictly required, but recommended when creating/updating an order so the line price is correct."},"detail":{"type":"string","description":"Variation detail"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"},"keyValue":{"type":"string","description":"Key value"}}}},"barcode":{"type":"string","description":"Barcode"},"brand_id":{"type":"string","description":"Brand ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"display_id":{"type":"string","description":"Display ID"},"product_display_id":{"type":"string","description":"Product display ID"},"last_imported_price":{"type":"integer","description":"Last imported price"},"is_upsale_product":{"type":"boolean","description":"Upsale product"},"weight":{"type":"integer","description":"Weight"},"measure_info":{"type":"object","description":"Measure information","properties":{"measure_id":{"type":"integer","description":"Measure ID"},"exchange_value":{"type":"integer","description":"Exchange value"}}},"avg_price":{"type":"integer","description":"Average import price"}}},"components":{"type":"array","description":"Product components","items":{"type":"object","properties":{"component_id":{"type":"string","description":"Component ID"},"quantity":{"type":"integer","description":"Quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information"}}}},"id":{"type":"integer","description":"Item ID"},"variation_id":{"type":"string","description":"Variation ID"}}}},"partner":{"type":"object","description":"Partner information\nWhen updating an order that already has shipping info, only the fields you send are written; omitted fields keep their current values. Send `null` to clear `partner_id`, `extend_code` or `shop_partner_id`.\n","properties":{"partner_id":{"type":"integer","description":"Partner ID"},"cod":{"type":"integer","description":"Reconciliation COD"},"extend_code":{"type":"string","description":"Shipping order ID on partner system"},"total_fee":{"type":"integer","description":"Total fee"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"delivery_name":{"type":"string","description":"Shipper name"},"delivery_tel":{"type":"string","description":"Delivery phone"},"picked_up_at":{"type":"string","format":"date-time","description":"Picked up at"},"sort_code":{"type":"string","description":"Sort code"},"paid_at":{"type":"string","format":"date-time","description":"Paid at"},"system_created":{"type":"boolean","description":"System created"},"extend_update":{"type":"array","description":"Update from courier","items":{"type":"object","properties":{"key":{"type":"string","description":"Update key"},"status":{"type":"string","description":"Status"},"tracking_id":{"type":"string","description":"Partner extend code"},"note":{"type":"string","description":"Courier notes"},"update_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"partner_status":{"type":"string","nullable":true,"description":"Partner shipping status","enum":["waiting","request_received","processing_picked_up","picking_up","delay_pickup","picked_up","waiting_on_the_way","on_the_way","contact_delivery_company","out_for_delivery","delay_delivery","inform_recipient","undeliverable","waiting_for_return","delivered","delivered_cod","returning","returned","returned_cod","canceled"],"x-enum-descriptions":["Waiting for processing","Carrier received the request","Processing pickup","Picking up","Delayed pickup","Picked up","Waiting for transit","In transit","Contact the carrier","Out for delivery","Delayed delivery","Notify the recipient","Undeliverable","Waiting for return","Delivered","Delivered, COD reconciled","Returning","Returned","Returned, COD reconciled","Canceled"]},"partner_name":{"type":"string","nullable":true,"description":"Partner name"},"first_delivery_at":{"type":"string","format":"date-time","nullable":true,"description":"First delivery time"},"first_undeliverable_at":{"type":"string","format":"date-time","nullable":true,"description":"First failed delivery time"},"count_of_delivery":{"type":"integer","nullable":true,"minimum":0,"maximum":32767,"description":"Number of delivery attempts. Courier updates add 1 each time the shipment moves to `out_for_delivery` or `delay_delivery`.\nCan be set when creating or updating an order (integer 0-32767); omitted or invalid values keep the current value, and later courier updates keep counting from the value you set.\n","example":2},"order_number_vtp":{"type":"string","nullable":true,"description":"Viettel Post tracking number"},"printed_form":{"type":"object","nullable":true,"description":"Printed form"}}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"payment_purchase_histories":{"type":"array","description":"Payment histories","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount of money"},"type":{"type":"string","description":"Payment type"},"inserted_at":{"type":"string","format":"date-time","description":"Transaction time"},"result_code":{"type":"string","description":"Result code"},"ipn_reply":{"type":"boolean","description":"IPN reply"},"voucher_amount":{"type":"integer","description":"Voucher amount"},"tags":{"type":"array","description":"Tags","items":{"type":"string"}}}}},"tags":{"type":"array","description":"Tags list","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"}}}},"marketer":{"type":"object","description":"Marketer information","properties":{"id":{"type":"string","description":"Marketer ID"},"name":{"type":"string","description":"Marketer name"},"email":{"type":"string","description":"Marketer email"},"phone_number":{"type":"string","description":"Marketer phone number"},"fb_id":{"type":"string","description":"Marketer Facebook ID"},"avatar_url":{"type":"string","description":"Marketer avatar URL"}}},"pke_mkter":{"type":"string","description":"Marketer ID"},"activated_combo_products":{"type":"object","description":"Activated combo products information","properties":{"combo_product_id":{"type":"integer","description":"Combo product ID"},"quantity_combo_activated":{"type":"integer","description":"Quantity combo activated"},"combo_product_info":{"type":"object","description":"Combo product information"}}},"activated_promotion_advances":{"type":"array","description":"Activated promotion advances information","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"promotion_advance_id":{"type":"string","description":"Promotion advance ID"},"promotion_advance_info":{"type":"object","description":"Promotion advance information"}}}},"invoice_info_list":{"type":"array","description":"Invoice information list","items":{"type":"object","properties":{"error":{"type":"string","description":"Error message if any"},"invoice_detail":{"type":"object","description":"Invoice detail information. The fields to send depend on `invoice_type`:\n- `company`: use `company_name`, `company_tax_id`, `company_address`, `company_email` (and optionally `company_address_breakdown`).\n- `personal`: use `name`, `phone_number`, `identity_code`, `tax_id`, `email`.\n","properties":{"name":{"type":"string","description":"Full name of the individual requesting the invoice (`invoice_type` = `personal`)","example":"Hoang Anh"},"phone_number":{"type":"string","description":"Phone number of the individual (`invoice_type` = `personal`)","example":"0934283743"},"identity_code":{"type":"string","description":"Citizen identity card / ID number of the individual (`invoice_type` = `personal`)","example":"029374382740"},"tax_id":{"type":"string","description":"Personal tax ID of the individual, if any (`invoice_type` = `personal`)","example":""},"email":{"type":"string","description":"Email of the individual to receive the e-invoice (`invoice_type` = `personal`)","example":""},"company_address":{"type":"string","description":"Company address (`invoice_type` = `company`)"},"company_address_breakdown":{"type":"object","description":"Company address breakdown","properties":{"company_additional_info":{"type":"string","description":"Company additional information"},"company_barangay":{"type":"string","description":"Company barangay"},"company_city":{"type":"string","description":"Company city"},"company_detailed_address":{"type":"string","description":"Company detailed address"},"company_district":{"type":"string","description":"Company district"},"company_full_address":{"type":"string","description":"Company full address"},"company_postcode":{"type":"string","description":"Company postcode"},"company_province":{"type":"string","description":"Company province"},"company_region":{"type":"string","description":"Company region"},"company_state":{"type":"string","description":"Company state"},"company_town":{"type":"string","description":"Company town"}}},"company_email":{"type":"string","description":"Company email (`invoice_type` = `company`)"},"company_name":{"type":"string","description":"Company name (`invoice_type` = `company`)"},"company_tax_id":{"type":"string","description":"Company tax ID (`invoice_type` = `company`)"}}},"invoice_type":{"type":"string","enum":["company","personal"],"description":"Invoice type: `company` for an organization, `personal` for an individual.\nDetermines which `invoice_detail` fields are used.\n","example":"personal"},"is_requested":{"type":"boolean","description":"Customer requests an e-invoice for this order. Set `true` together with `invoice_type` and `invoice_detail` to request invoice issuance.","example":true},"order_sn":{"type":"string","description":"Order code on the marketplace"}}}},"reports_by_phone":{"type":"object","description":"Reports by phone number","properties":{"order_fail":{"type":"integer","description":"Number of failed orders"},"order_success":{"type":"integer","description":"Number of successful orders"},"warning":{"type":"integer","description":"Number of warnings orders"}},"example":{"+639175706297":{"order_fail":29,"order_success":20,"warning":0}}},"tracking_link":{"type":"string","description":"Link confirm order"},"payment_link":{"type":"string","description":"Payment link"},"ads_source":{"type":"string","description":"Advertising source"},"bank_payments":{"type":"object","description":"Payment method"},"transfer_proofs":{"type":"array","description":"Bank transfer payment proofs, including verification time, amount and receipt images","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transfer proof ID"},"order_id":{"type":"integer","description":"Order ID"},"shop_id":{"type":"integer","description":"Shop ID"},"payment_id":{"type":"string","description":"Bank payment method ID (matches a key in `bank_payments`)"},"amount":{"type":"integer","description":"Transferred amount"},"images":{"type":"array","description":"Transfer receipt images","items":{"type":"string"}},"note":{"type":"string","nullable":true,"description":"Note"},"is_income":{"type":"boolean","description":"Money received (true) or paid out (false)"},"is_verify":{"type":"boolean","description":"Whether the transfer has been verified"},"verify_at":{"type":"string","format":"date-time","nullable":true,"description":"Verification time"},"verifier":{"type":"object","nullable":true,"description":"Verifier information","properties":{"id":{"type":"string","description":"Verifier ID"},"name":{"type":"string","description":"Verifier name"},"fb_id":{"type":"string","description":"Facebook ID of verifier"},"avatar_url":{"type":"string","description":"Verifier avatar URL"}}},"creator":{"type":"object","nullable":true,"description":"Creator information","properties":{"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"last_editor":{"type":"object","nullable":true,"description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Editor name"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"avatar_url":{"type":"string","description":"Editor avatar URL"}}},"order_info":{"type":"object","nullable":true,"description":"Additional order information"},"inserted_at":{"type":"string","format":"date-time","description":"Transfer proof creation time"},"updated_at":{"type":"string","format":"date-time","description":"Transfer proof update time"}}}},"shopify_order_id":{"type":"string","description":"Shopify order ID"},"shopify_abandon_checkout_id":{"type":"integer","description":"Shopify abandon checkout ID"},"is_abandoned_order":{"type":"boolean","description":"Abandoned-cart flag for creating or updating an order. Send it directly in the request body, not inside `third_party` or `third_party_infomation`.\nAn 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.\nOnly boolean `true` or string `\"true\"` is normalized to `true`; all other submitted values become `false`.\n","example":true},"cod":{"type":"integer","description":"Cash on delivery"},"cash":{"type":"integer","description":"Cash payment"},"account":{"type":"integer","description":"Order source ID"},"account_name":{"type":"string","description":"Order source name"},"advanced_platform_fee":{"type":"object","description":"Fees from e-commerce platforms","properties":{"ads_top_up":{"type":"integer","description":"Ads wallet top-up"},"affiliate_commission":{"type":"integer","description":"Affiliate commission"},"diff_shipping_fee":{"type":"integer","description":"Difference shipping fee"},"marketplace_voucher":{"type":"integer","description":"Marketplace voucher"},"payment_fee":{"type":"integer","description":"Payment fee"},"platform_commission":{"type":"integer","description":"Platform commission"},"seller_transaction_fee":{"type":"integer","description":"Seller transaction fee"},"service_fee":{"type":"integer","description":"Service fee"},"sfp_service_fee":{"type":"integer","description":"SFP service fee"}}},"printing_count":{"type":"integer","description":"Printing count"},"money_to_collect":{"type":"integer","description":"Money to collect"},"marketplace_id":{"type":"string","description":"Marketplace ID","enum":["-2","-3","-4","-9","-16","-17","-20","-25","-27","-28"],"x-enum-descriptions":{"-2":"Tiki","-3":"Shopee","-4":"Lazada","-9":"TikTok","-16":"WooCommerce","-17":"Shopify","-20":"Line Shopping","-25":"Tokopedia","-27":"Mercado Libre","-28":"Tiendanube"}},"total_price":{"type":"integer","description":"Total price"},"shop_customer_address_id":{"type":"string","description":"Customer address ID"},"customer":{"type":"object","description":"Customer information","properties":{"fb_id":{"type":"string","description":"Customer Facebook ID"},"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Customer name"},"page_id":{"type":"string","description":"Page ID"}}},"total_quantity":{"type":"integer","description":"Total quantity"},"time_assign_marketer":{"type":"string","format":"date-time","description":"Time assign marketer"},"p_utm_source":{"type":"string","description":"UTM Source"},"p_utm_medium":{"type":"string","description":"UTM Medium"},"p_utm_campaign":{"type":"string","description":"UTM Campaign"},"p_utm_term":{"type":"string","description":"UTM Term"},"p_utm_content":{"type":"string","description":"UTM Content"},"p_utm_id":{"type":"string","description":"UTM ID"},"utm_affiliate":{"type":"string","description":"Affiliate"},"link":{"type":"string","description":"Link"},"status_history":{"type":"array","description":"Status update history","items":{"type":"object","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"editor":{"type":"object","description":"Editor information"},"editor_fb":{"type":"string","description":"Editor Facebook ID"},"editor_id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Name"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Status"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"duplicated_phone":{"type":"boolean","description":"Duplicated phone"},"order_currency":{"type":"string","description":"Order currency"},"charged_by_vnpay":{"type":"integer","description":"Charged by VNPay"},"charged_by_qrpay":{"type":"integer","description":"Charged by QRPay"},"custom_id":{"type":"string","description":"Custom ID"},"last_editor":{"type":"object","description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"name":{"type":"string","description":"Editor name"},"email":{"type":"string","description":"Editor email"},"avatar_url":{"type":"string","description":"Editor avatar URL"},"phone_number":{"type":"string","description":"Editor phone number"}}},"last_editor_id":{"type":"string","description":"Last editor ID"},"charged_by_momo":{"type":"integer","description":"Charged by MoMo"},"prepaid_by_point":{"type":"object","description":"Prepaid by point","properties":{"money":{"type":"integer","description":"Money amount","example":15000},"point":{"type":"integer","description":"Point amount","example":15}},"example":{"money":15000,"point":15}},"bank_transfer_images":{"type":"array","description":"Bank transfer images","items":{"type":"string","format":"uri"}},"transfer_money":{"type":"integer","description":"Transfer money"},"lock_order_by_user":{"type":"string","description":"Lock order by user ID"},"assigning_care":{"type":"object","description":"Assigning care information","properties":{"id":{"type":"string","description":"Care ID"},"fb_id":{"type":"string","description":"Facebook ID of care"},"name":{"type":"string","description":"Care name"},"email":{"type":"string","description":"Care email"},"avatar_url":{"type":"string","description":"Care avatar URL"},"phone_number":{"type":"string","description":"Care phone number"}}},"assigning_care_id":{"type":"string","description":"Assigning care ID"},"time_assign_care":{"type":"string","format":"date-time","description":"Time assign care"},"assigning_seller":{"type":"object","description":"Assigning seller information","properties":{"id":{"type":"string","description":"Seller ID"},"fb_id":{"type":"string","description":"Facebook ID of seller"},"name":{"type":"string","description":"Seller name"},"email":{"type":"string","description":"Seller email"},"avatar_url":{"type":"string","description":"Seller avatar URL"},"phone_number":{"type":"string","description":"Seller phone number"}}},"einvoices":{"type":"array","items":{"$ref":"#/components/schemas/EInvoice"}},"charged_by_card":{"type":"integer","description":"Charged by card"},"estimate_delivery_date":{"type":"string","format":"date-time","description":"Estimate delivery date"},"order_sources":{"type":"string","description":"Order sources ID"},"charged_by_fundiin":{"type":"integer","description":"Charged by Fundiin"},"surcharge":{"type":"integer","description":"Surcharge"},"is_linked_partner":{"type":"boolean","description":"Is linked partner"},"call_laters":{"type":"array","description":"Call laters","items":{"type":"object"}},"last_update_status_at":{"type":"string","format":"date-time","description":"Last update status at"},"discount_by_customer_level":{"type":"integer","description":"Discount by customer level"},"viewing":{"type":"array","description":"Viewing","items":{"type":"object"}},"additional_info":{"type":"object","description":"Additional info","properties":{"service_partner":{"type":"string","description":"Service partner","enum":["instant"],"x-enum-descriptions":["Instant"]},"delivery_deadline":{"type":"string","format":"date-time","description":"Delivery deadline (ISO8601, no timezone).","example":"2026-06-03T10:00:00"},"ship_by_date":{"type":"integer","nullable":true,"readOnly":true,"description":"Marketplace ship-by deadline (Unix timestamp, seconds) for Shopee/TikTok orders — the order must be handed over to the carrier before this time, otherwise the marketplace may cancel it automatically. Shopee `ship_by_date`, TikTok `collection_due_time`. `0` = the marketplace has not returned it yet; `null` for non-marketplace orders.","example":1793000000}}},"order_returned_ids":{"type":"string","description":"Order returned IDs"},"cost_surcharge":{"type":"integer","description":"Cost surcharge"},"time_send_partner":{"type":"string","format":"date-time","description":"Time send partner"},"charged_by_kredivo":{"type":"integer","description":"Charged by Kredivo"},"discount":{"type":"integer","description":"Discount"},"histories":{"type":"array","description":"Histories","items":{"type":"object"}},"duplicated_customer":{"type":"boolean","description":"Duplicated customer"},"customer_referral_code":{"type":"object","description":"Customer referral code","properties":{"active":{"type":"string","description":"Active status","example":"true"},"customer_id":{"type":"string","format":"uuid","description":"Customer ID","example":"09bb9399-45f3-4897-a53a-85dde2f886fe"},"discount":{"type":"string","description":"Discount value","example":"10"},"format":{"type":"string","description":"Referral code format","example":"{PHONE_NUMBER}"},"free_products_priced_between_approx":{"type":"object","description":"Free products priced between approximately","properties":{"active":{"type":"string","description":"Active status","example":"true"},"operator":{"type":"string","description":"Comparison operator","example":"GreaterOrEqual"},"price":{"type":"string","description":"Price threshold","example":"150000"}}},"is_percent":{"type":"string","description":"Discount is percentage","example":"true"},"only_customers_with_level_will_have_referral_code":{"type":"string","description":"Only customers with level will have referral code","example":"true"},"referral_code":{"type":"string","description":"Referral code","example":"982843759"},"reward_points_for_old_customers":{"type":"object","description":"Reward points for customers","properties":{"active":{"type":"string","description":"Active status","example":"true"},"money":{"type":"string","description":"Money reward","example":"10000"},"point":{"type":"string","description":"Point reward","example":"1"}}},"shop_customer_id":{"type":"string","format":"uuid","description":"Shop customer ID","example":"f8160a4c-dfa7-4ee8-b540-d245755ea1f1"}},"example":{"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"}},"tax":{"type":"integer","description":"Tax"},"is_from_ecommerce":{"type":"boolean","description":"Is from e-commerce"},"note_image":{"type":"array","description":"Note images","items":{"type":"string","format":"uri"}},"shopify_draft_order_id":{"type":"string","description":"Shopify draft order ID"},"display_id":{"type":"integer","description":"Display ID"},"shop_partner_id":{"type":"integer","description":"Shop partner ID"},"is_locked":{"type":"boolean","description":"Order lock"},"merge_order":{"type":"boolean","description":"Allows merging orders"}}},"examples":{"default":{"$ref":"#/components/examples/OrderBasic"}}}}}}}},"/shops/{SHOP_ID}/bank_payments":{"get":{"summary":"List of payment methods","x-summary-i18n":{"vie":"Danh sách phương thức thanh toán"},"description":"Get list of payment methods","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Payment methods list","properties":{"data":{"type":"array","description":"List of payment methods","items":{"type":"object","properties":{"id":{"type":"string","description":"Payment method ID"},"name":{"type":"string","description":"Payment method name"},"creator_id":{"type":"string","description":"Creator ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Created at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"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}}}}}}}}},"/shops/{SHOP_ID}/orders_returned":{"get":{"summary":"List of return orders","x-summary-i18n":{"vie":"Danh sách đơn hàng đổi trả"},"description":"Get list of return orders","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number","example":1},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size","example":30},{"name":"status","in":"query","required":false,"schema":{"type":"integer","default":-1,"example":-1},"description":"Order status","example":-1},{"name":"update_status","in":"query","required":false,"schema":{"type":"string","default":"inserted_at","enum":["inserted_at","updated_at","0","2","1","4"],"x-enum-descriptions":["Order creation time","Last update time","New","Shipped","Completed","Canceled"],"example":"inserted_at"},"description":"Filter orders by time"},{"name":"start_time","in":"query","required":false,"schema":{"type":"integer"},"description":"Start date (unix timestamp)","example":1699635600},{"name":"end_time","in":"query","required":false,"schema":{"type":"integer"},"description":"End date (unix timestamp)","example":1699635600}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Return orders list","properties":{"data":{"type":"array","description":"List of return orders","items":{"$ref":"#/components/schemas/ReturnOrder"}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"}}},"examples":{"default":{"value":{"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"}]}}}}}}}},"post":{"summary":"Create return order","x-summary-i18n":{"vie":"Tạo đơn đổi trả"},"description":"Create return order","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Request body containing return order information","content":{"application/json":{"schema":{"type":"object","required":["order_additional","returned_items","status","warehouse_id"],"properties":{"discount_from_order_to_returned":{"type":"integer","default":0,"description":"Discount from order to returned"},"order_additional":{"type":"object","description":"Exchange order information","required":["items","warehouse_id"],"properties":{"bill_email":{"type":"string","description":"Customer email"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"cash":{"type":"integer","default":0,"description":"Cash payment"},"discount":{"type":"integer","default":0,"description":"Discount total"},"items":{"type":"array","description":"List of products in exchange order","items":{"type":"object","required":["product_id","variation_id","returned_quantity","variation_info"],"properties":{"discount_each_product":{"type":"integer","default":0,"description":"Discount for each product"},"product_id":{"type":"string","description":"Product ID"},"quantity":{"type":"integer","default":1,"description":"Quantity"},"returned_quantity":{"type":"integer","description":"Returned quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information","required":["name","retail_price"],"properties":{"detail":{"type":"string","description":"Variation detail"},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"keyValue":{"type":"string","description":"Key value"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"}}}},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"name":{"type":"string","description":"Product name"},"retail_price":{"type":"integer","description":"Retail price"},"weight":{"type":"integer","description":"Weight"}}}}}},"note":{"type":"string","description":"Internal note"},"note_print":{"type":"string","description":"Note for printing"},"order_currency":{"type":"string","description":"Order currency"},"payment_from_customers_exchange_order":{"type":"integer","default":0,"description":"Payment from customers exchange order"},"prepaid":{"type":"integer","default":0,"description":"Prepaid amount"},"received_at_shop":{"type":"boolean","default":false,"description":"true: Sales at counter, false: Sell online"},"shipping_address":{"type":"object","description":"Delivery address information","properties":{"address":{"type":"string","description":"Address"},"commune_id":{"type":"string","description":"Commune ID"},"country_code":{"type":"string","description":"Country code"},"district_id":{"type":"string","description":"District ID"},"full_address":{"type":"string","description":"Full address"},"full_name":{"type":"string","description":"Full name"},"new_full_address":{"type":"string","description":"New full address"},"phone_number":{"type":"string","description":"Phone number"},"province_id":{"type":"string","description":"Province ID"},"render_type":{"type":"string","description":"Render type"}}},"shipping_fee":{"type":"integer","default":0,"description":"Shipping fee"},"shop_customer_id":{"type":"string","description":"Customer ID"},"surcharge":{"type":"integer","default":0,"description":"Surcharge"},"warehouse_id":{"type":"string","description":"Warehouse ID"}}},"order_to_returned":{"type":"object","description":"Order to be returned","properties":{"id":{"type":"string","description":"Order ID to returned"}}},"returned_items":{"type":"array","description":"List of products in returned order","items":{"type":"object","required":["product_id","variation_id","returned_quantity","variation_info"],"properties":{"product_id":{"type":"string","description":"Product ID"},"returned_quantity":{"type":"integer","description":"Returned quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information","required":["name","retail_price"],"properties":{"detail":{"type":"string","description":"Variation detail"},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"name":{"type":"string","description":"Product name"},"retail_price":{"type":"integer","description":"Retail price"}}}}}},"shop_customer_id":{"type":"string","description":"Customer ID"},"status":{"type":"integer","description":"Order status"},"warehouse_id":{"type":"string","description":"Warehouse ID"}},"example":{"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"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnOrder"},"examples":{"default":{"value":{"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"}}}}}}}}},"/shops/{SHOP_ID}/partners":{"get":{"summary":"Partner list","x-summary-i18n":{"vie":"Danh sách đối tác"},"description":"Get list of shipping partners","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of partners","items":{"type":"object","properties":{"id":{"type":"integer","description":"Partner ID"},"name":{"type":"string","description":"Partner name"},"country_code":{"type":"string","description":"Country code"},"accounts":{"type":"array","description":"List of courier accounts connected to the shop","items":{"type":"object","properties":{"id":{"type":"integer","description":"Account ID"},"name":{"type":"string","description":"Account name"}}}}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"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}}}}}}}}},"/shops/{SHOP_ID}/projects":{"get":{"summary":"Project list","x-summary-i18n":{"vie":"Danh sách dự án"},"description":"Get list of projects","tags":["Order"],"x-tags-i18n":{"vie":["Đơn hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"},"examples":{"default":{"value":{"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}}}}}}}}},"/shops/{SHOP_ID}/list_einvoices/":{"get":{"summary":"List of e-invoices","x-summary-i18n":{"vie":"Danh sách hóa đơn điện tử"},"description":"Get list of e-invoices","tags":["E-Invoice"],"x-tags-i18n":{"vie":["Hóa đơn điện tử"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"account_id","in":"query","required":false,"schema":{"type":"string","example":"2284322048329488"},"description":"Account ID"},{"name":"marketplace_id","in":"query","required":false,"schema":{"type":"string","example":"1"},"description":"Marketplace ID"},{"name":"name","in":"query","required":false,"schema":{"type":"string","example":"Shopee"},"description":"Account name"},{"name":"startDate","in":"query","required":false,"schema":{"type":"integer","example":1778518800},"description":"Start of creation time range (unix timestamp)"},{"name":"endDate","in":"query","required":false,"schema":{"type":"integer","example":1778518800},"description":"End of creation time range (unix timestamp)"},{"name":"startDateRelease","in":"query","required":false,"schema":{"type":"integer","example":1778518800},"description":"Start of release time range (unix timestamp)"},{"name":"endDateRelease","in":"query","required":false,"schema":{"type":"integer","example":1778518800},"description":"End of release time range (unix timestamp)"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EInvoice"},"examples":{"default":{"value":{"success":true,"data":[{"actual_shipping_fee":30000,"adjust_amount":null,"adjustment_criteria":null,"adjustment_type":null,"allocation_discounts":[],"allocation_type":1,"bank_account_number":null,"bank_name":null,"budget_unit_code":null,"buyer_not_get_invoice":false,"creator":{"avatar_url":null,"fb_id":"377936050731194","id":"cee3c05e-5f85-43c4-b27e-889b99c50097","name":"Vũ Sơn"},"discount":100000,"display_id":754,"einvoice_account_id":66,"email":"acb@gmail.com","full_name":"C. Hạnh","id":1656,"identity_code":null,"included_tax":0,"invoice_no":"00000095","invoice_series":"C25TPA","invoice_type":1,"is_adjust_amount":false,"is_included_tax":false,"items":[{"adjust_amount":null,"discount":0,"id":3501,"is_calculation_tax":false,"is_component":false,"is_surcharge":null,"measure":null,"note":null,"order_id":124409,"order_item_id":70104,"quantity":1,"retail_price":200000,"tax":5,"type":1,"variation":{"custom_id":"TESTMATGREENS","display_id":16,"fields":[{"id":"b8a37fc1-4479-480a-937a-e18e1a588aec","keyValue":"RED","name":"Màu sắcaa","value":"red"},{"id":"786371f1-8d23-4a45-9e83-d944892ad3ce","keyValue":"L","name":"Sizeaaa","value":"L"}],"product":{"custom_id":"ANPR","display_id":13038,"name":"Áo nam Pari đẹp thời trang 123"},"product_id":"dee8f2c3-2ecc-4d9b-a9ff-603b5bde7e3d"},"variation_id":"573e9406-07dd-44f7-9c26-28f95da9ad47","variation_info":{"detail":"Màu sắcaa: red, Sizeaaa: L","diff_discount":null,"discount":10000000,"item_total_amount_with_tax":10500000,"item_total_amount_without_tax":10000000,"measure_info":null,"name":"Áo nam Pari đẹp thời trang 123","product_id":"dee8f2c3-2ecc-4d9b-a9ff-603b5bde7e3d","product_tags":[],"tax_amount":500000,"tax_rate":5,"unit_price":20000000}}],"key_search":"KICKFUYUPUAOFF8","last_editor_id":"d6e6a545-f102-439e-9943-8ac8369f9735","note":null,"order_id":124409,"order_info":{"account":null,"account_source":null,"cod":130500,"custom_id":null,"display_id":20456,"order_currency":"VND","order_sources":null,"page":{"id":"117967746266487","name":"Soicun","username":null},"page_id":"117967746266487","partner":{"extend_code":null,"partner_id":154},"shop_customer_id":"7869af18-f0f4-44d9-95e8-106c9731eef9","warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"},"original_einvoice":null,"payment_method":"TM/CK","phone_number":"0983924977","purchaser_tax_code":null,"purchaser_unit":null,"release_date":"2025-11-13T05:05:29.322669","release_type":1,"shipping_address":{"address":"123","commnue_name":"Phường Cống Vị","commune_id":"1010115","country_code":"84","district_id":"10101","district_name":"Quận Ba Đình","full_address":"123, Phường Cống Vị, Quận Ba Đình, Hà Nội","full_name":"C. Hạnh","new_full_address":"123, Hà Nội","new_province_id":"84_VN101","phone_number":"0983924977","post_code":"","province_id":"101","province_name":"Hà Nội","render_type":"old"},"shipping_fee":30000,"shop_id":20,"signature_type":0,"status":2,"tax":10,"template_code":"1","total_amount":130500,"verification_code":null,"voucher_book":null}]}}}}}}}}},"/shops/{SHOP_ID}/livestream_manager":{"get":{"summary":"List of livestream sessions","x-summary-i18n":{"vie":"Danh sách phiên livestream"},"description":"Get list of livestream sessions","tags":["Livestream"],"x-tags-i18n":{"vie":["Livestream"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LivestreamManager"},"examples":{"default":{"value":{"success":true,"data":[{"creator":{"avatar_url":null,"fb_id":"101281316987922","id":"b0097b97-8520-4a16-a89b-4ddcd76c3ec8","name":"Trần Ngọc Hoa"},"end_time":"2026-01-23T10:10:21","finisher":{"avatar_url":null,"fb_id":"101281316987922","id":"b0097b97-8520-4a16-a89b-4ddcd76c3ec8","name":"Trần Ngọc Hoa"},"id":"60cc3e38-f4e7-44d7-ba30-911ce398b46a","inserted_at":"2026-01-22T12:26:13.000000","name":"Live tối 22/1","origin_post_id":null,"post_ids":["105112292515661_1080067970899442"],"remain_warehouse_ids":["e2f0f8db-9937-4293-88a6-67637c6f4c25"],"shop_id":4,"start_time":"2026-01-22T12:31:10","total_comments":753,"total_customers":262,"warehouse_id":"e2f0f8db-9937-4293-88a6-67637c6f4c25"}],"page_number":1,"page_size":30,"total_entries":1,"total_pages":1}}}}}}}}},"/shops/{SHOP_ID}/marketplace/get_account_info":{"get":{"summary":"eCommerce Platform Account","x-summary-i18n":{"vie":"Tài khoản sàn thương mại điện tử"},"description":"Get eCommerce platform account information","tags":["eCommerce"],"x-tags-i18n":{"vie":["Sàn thương mại điện tử"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"account_id","in":"query","required":false,"schema":{"type":"string","example":"2284322048329488"},"description":"Account ID"},{"name":"marketplace_id","in":"query","required":false,"schema":{"type":"string","example":"1"},"description":"Marketplace ID"},{"name":"name","in":"query","required":false,"schema":{"type":"string","example":"Shopee"},"description":"Account name"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of eCommerce platform accounts","items":{"type":"object","properties":{"id":{"type":"string","description":"eCommerce Platform Shop ID"},"marketplace_id":{"type":"string","description":"eCommerce Platform ID (-2: Tiki, -3: Shopee, -4: Lazada, -6: Sendo, -9: TikTok, -16: WooCommerce, -17: Shopify, -20: Line Shopping, -25: Tokopedia, -27: Mercado Libre)"},"name":{"type":"string","description":"Account name"},"shop_id":{"type":"integer","description":"Shop ID"}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"1","marketplace_id":"-3","name":"Shopee","shop_id":1}]}}}}}}}}},"/shops/{SHOP_ID}/marketplace/products":{"get":{"summary":"eCommerce Platform Products","x-summary-i18n":{"vie":"Sản phẩm sàn thương mại điện tử"},"description":"Get eCommerce platform products information","tags":["eCommerce"],"x-tags-i18n":{"vie":["Sàn thương mại điện tử"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eCommerceProduct"},"examples":{"default":{"value":{"id":"46152996242","linked_product_custom_id":"ANPR","linked_product_name":"Áo nam Pari đẹp thời trang","marketplace_id":"-3","marketplace_shop_name":"Vũ Sơn shop","name":"Áo nam Pari đẹp thời trang","price":0,"sku":"ANPR","variations":[{"id":"375286372857","images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2025/9/17/abad91b33fa9a051b86d415f6cf63aba00d360ac.jpg"],"linked_product_custom_id":"ANPR","linked_variation_custom_id":"TESTMATDOS","linked_variation_fields":[{"id":"2b61c249-35dc-4b79-a3aa-a173c63a8061","keyValue":"BLUE","name":"Màu sắcaa","value":"blue"},{"id":"b053dfb9-b7b6-4d8a-9fb4-197d7b0d7556","keyValue":"L","name":"Sizeaaa","value":"L"}],"linked_variation_price":150000,"name":"blue L","price":165000,"quantity":1025,"sku":"TESTMATDOS"}],"warehouse":"Kho HN"}}}}}}}}},"/shops/{SHOP_ID}/shopee/evaluate":{"get":{"summary":"Evaluation list","x-summary-i18n":{"vie":"Danh sách đánh giá"},"description":"Get list of evaluations on eCommerce platform","tags":["eCommerce"],"x-tags-i18n":{"vie":["Sàn thương mại điện tử"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"},{"name":"field_time","in":"query","required":false,"schema":{"type":"string","enum":["evaluation_time","last_evaluation_time"],"x-enum-descriptions":["Creation time","Last evaluation time"],"example":"evaluation_time"},"description":"Filter evaluations by time"},{"name":"evaluation_time[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer","format":"unix","example":[1762448400,1763139599]}},"description":"Filter time interval"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of evaluations","items":{"type":"object","properties":{"buyer":{"type":"string","description":"Buyer"},"comment":{"type":"string","description":"Buyer comment"},"create_at":{"type":"string","format":"date-time","description":"Created at"},"last_rating":{"type":"integer","description":"Latest evaluation"},"order_id":{"type":"string","description":"Order ID"},"product":{"type":"object","description":"Product information","properties":{"images":{"type":"array","description":"Product images","items":{"type":"string","format":"uri"}},"marketplace_product_name":{"type":"string","description":"Marketplace product name"}}},"product_name":{"type":"string","description":"Product name"},"rating":{"type":"integer","description":"Evaluation"},"reply":{"type":"object","description":"Response information","properties":{"hidden":{"type":"boolean","description":"Reply hidden"},"reply":{"type":"string","description":"Response content"}}},"shop_id":{"type":"integer","description":"Shop ID"},"variation":{"type":"object","description":"Variation information","properties":{"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"marketplace_sku":{"type":"string","description":"Marketplace SKU"}}},"marketplace":{"type":"object","description":"eCommerce Platform information","properties":{"marketplace_shop_id":{"type":"string","description":"eCommerce Platform Shop ID"},"marketplace_shop_name":{"type":"string","description":"eCommerce Platform Shop Name"}}},"marketplace_id":{"type":"string","description":"eCommerce Platform ID"}}}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"buyer":"Vu Son","comment":"Giao nhanh, gói cẩn thận Đúng loại và sản phẩm y như mô tả Mình mua nhiều lần rồi và rất ưng vị của shop","create_at":"2024-08-12T08:31:22Z","last_rating":3,"order_id":"240806J7RNCBUB","product":{"images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2024/4/15/841a6d57f52f22176dea7a9a6fb35761c89fd4eb.jpg"],"marketplace_product_name":"Áo thun nam form rộng 12 con giáp tuổi Sửu ATD478 Miucho Iconic cotton cổ tròn in graphic"},"product_name":"Áo thun nam form rộng 12 con giáp tuổi Sửu ATD478 Miucho Iconic cotton cổ tròn in graphic","rating":5,"reply":{"hidden":false,"reply":"Cảm ơn quý khách đã mua hàng và đánh giá tốt cho shop!\nQuý khách thật tuyệt vời khi đã đặt hàng, nhận hàng và dành thời gian đánh giá tích cực.\nNếu có bất kể vấn đề gì quý khách cứ nhắn tin shop bảo đảm xử lý có lợi cho khách hàng.\nShop vô cùng cầu thị với mong muốn được phục vụ quý khách trong những đơn hàng tiếp theo.\nShop xin chúc quý khách cùng gia đình mạnh khoẻ, vui vẻ, may mắn, bình an!\n\n"},"shop_id":224,"variation":{"images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2024/4/15/0636d7492a531270596064c3712b0e228a843c3b.jpg"],"marketplace_sku":"ATD478-2X-CC-M"},"marketplace":{"marketplace_shop_id":"20732730","marketplace_shop_name":"Vũ Sơn shop"},"marketplace_id":"-3"}]}}}}}}}}},"/shops/{SHOP_ID}/marketplace/reverse_order":{"get":{"summary":"List of reverse orders","x-summary-i18n":{"vie":"Danh sách đơn đổi trả"},"description":"Get list of reverse orders on eCommerce platform","tags":["eCommerce"],"x-tags-i18n":{"vie":["Sàn thương mại điện tử"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"},{"name":"type_of_filter_time","in":"query","required":false,"schema":{"type":"string","enum":["inserted_at","updated_at"],"x-enum-descriptions":["Inserted at","Updated at"],"example":"inserted_at"},"description":"Filter reverse orders by time"},{"name":"time[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer","format":"unix","example":[1762448400,1763139599]}},"description":"Filter time interval"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of reverse orders","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Refund amount"},"buyer":{"type":"string","description":"Buyer"},"id":{"type":"integer","description":"Reverse order ID"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"items":{"type":"array","description":"List of refunded products","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount"},"images":{"type":"array","description":"Product images","items":{"type":"string","format":"uri"}},"item_id":{"type":"string","description":"Item ID"},"item_price":{"type":"integer","description":"Item price"},"item_sku":{"type":"string","description":"Item SKU"},"model_id":{"type":"integer","description":"Model ID"},"name":{"type":"string","description":"Product name"},"refund_amount":{"type":"integer","description":"Refund amount"},"variation_sku":{"type":"string","description":"Variation SKU"}}}},"marketplace_id":{"type":"string","description":"eCommerce Platform ID"},"marketplace_shop_name":{"type":"string","description":"eCommerce Platform Shop Name"},"note":{"type":"string","nullable":true,"description":"Note"},"order_id":{"type":"string","description":"Order ID"},"original_order":{"type":"string","description":"Order ID to returned"},"reason":{"type":"string","description":"Reason for return"},"shop_id":{"type":"integer","description":"Shop ID"},"status":{"type":"string","description":"Status"},"tracking_number":{"type":"string","description":"Partner extend code"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}},"example":[{"amount":143834,"buyer":"phuongthaole28","id":21,"inserted_at":"2025-10-14T14:12:16","items":[{"amount":1,"images":["https://cf.shopee.sg/file/4ecbb6fa567e42c1b1e02993ad53df12"],"item_id":"ANPR","item_price":168630,"item_sku":"USB","model_id":297082992992,"name":"Áo nam Pari đẹp thời trang","refund_amount":143834,"variation_sku":"ANPR"}],"marketplace_id":"-3","marketplace_shop_name":"hoanganh230321131223","note":null,"order_id":"2408280F4HVBQRA","original_order":"HGL_RSO_1","reason":"DIFFERENT_DESCRIPTION","shop_id":20,"status":"completed","tracking_number":"fbjdnsdhuhwu","updated_at":"2025-10-24T08:04:56"}]},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}}}}}}}},"/shops/{SHOP_ID}/order_call_laters":{"get":{"summary":"List of call later and remind","x-summary-i18n":{"vie":"Danh sách hẹn gọi & nhắc nhở"},"description":"Get list of call later and remind","tags":["Call Later"],"x-tags-i18n":{"vie":["Hẹn gọi & nhắc nhở"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page_number","in":"query","required":false,"schema":{"type":"integer","default":1},"description":"Page number","example":1},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30},"description":"Page size","example":30},{"name":"key","in":"query","required":false,"schema":{"type":"string","enum":["today","upcoming","overdue","completed"]},"description":"Quick filter: `today` (scheduled today), `upcoming` (scheduled after today), `overdue` (scheduled before now), `completed` (successfully processed).\nOmit this parameter to filter only by the time range. If provided, it is combined with the time filters (AND).\n","example":"today"},{"name":"filter_by_time","in":"query","required":false,"schema":{"type":"string"},"description":"Time filter as a JSON-encoded object. Send as a single query parameter (URL-encode the JSON), not nested query parameters.\n- `type`: `inserted_at` (creation time, default), `called_at` (processed time; excludes unprocessed reminders), or `appointment_time` (scheduled call time, field `needs_call_at`).\n- `start_time`, `end_time`: integer Unix timestamps in seconds (UTC), both required for the filter to apply. Both bounds are inclusive. Convert the desired local date range to Unix timestamps before sending.\n- `editor_ids`: array of user IDs, required when filtering by time. Use `[\"-1\"]` for all staff. Filters by the last editor for `called_at`, otherwise by the creator.\nExamples below cover October 15, 2026, 00:00:00–23:59:59 in UTC+7.\n","examples":{"inserted_at":{"summary":"Creation time / Thời điểm tạo","value":"{\"type\":\"inserted_at\",\"start_time\":1791997200,\"end_time\":1792083599,\"editor_ids\":[\"-1\"]}"},"called_at":{"summary":"Processed time / Đã xử lý lúc","value":"{\"type\":\"called_at\",\"start_time\":1791997200,\"end_time\":1792083599,\"editor_ids\":[\"-1\"]}"},"appointment_time":{"summary":"Scheduled call time / Thời điểm hẹn gọi","value":"{\"type\":\"appointment_time\",\"start_time\":1791997200,\"end_time\":1792083599,\"editor_ids\":[\"-1\"]}"}}},{"name":"start_needs_call","in":"query","required":false,"schema":{"type":"integer","format":"int64"},"description":"Inclusive start of the scheduled call time range (`needs_call_at`), as a Unix timestamp in seconds. Must be sent with `end_needs_call`. Combined with other filters (AND).","example":1791997200},{"name":"end_needs_call","in":"query","required":false,"schema":{"type":"integer","format":"int64"},"description":"Inclusive end of the scheduled call time range (`needs_call_at`), as a Unix timestamp in seconds. Must be sent with `start_needs_call`.","example":1792083599},{"name":"status","in":"query","required":false,"schema":{"type":"integer","default":-1,"enum":[-1,0,3,1,2,7],"x-enum-descriptions":["All status","No process","Calling / Processing","Processed","Not listening / Unsuccessful","Removed"],"example":-1},"description":"Status"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of call later and remind","items":{"$ref":"#/components/schemas/CallLater"}},"key":{"type":"string","description":"Key"},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"called_at":"2024-01-30T01:54:17","creator":{"avatar_url":null,"email":"vuson897654@gmail.com","fb_id":"377936050731194","id":"cee3c05e-5f85-43c4-b27e-889b99c50097","name":"Vũ Sơn","phone_number":null},"display_id":70,"id":"1885d8d4-e210-4e56-bb32-683988a032f5","need_notify_users":["cee3c05e-5f85-43c4-b27e-889b99c50097"],"needs_call_at":"2024-01-30T02:20:48","notice_created":"Gọi lại cho khách","order_display_id":"SOICUN-12943-02","order_id":106703,"status":1,"type":"call"}],"key":"today","page_number":1,"page_size":30,"total_entries":3,"total_pages":1}}}}}}}},"post":{"summary":"Create call later and remind","x-summary-i18n":{"vie":"Tạo hẹn gọi & nhắc nhở"},"description":"Create call later and remind","tags":["Call Later"],"x-tags-i18n":{"vie":["Hẹn gọi & nhắc nhở"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Request body containing call later and remind information","content":{"application/json":{"schema":{"type":"object","required":["order_call_later"],"properties":{"order_call_later":{"type":"object","required":["needs_call_at","phone_number"],"properties":{"status":{"type":"integer","description":"Status"},"need_notify_users":{"type":"array","description":"Process staff","items":{"type":"string"}},"notice_created":{"type":"string","description":"Notice information"},"needs_call_at":{"type":"string","format":"date-time","description":"Need call at"},"phone_number":{"type":"string","description":"Phone number"},"order_ids":{"type":"array","description":"Order IDs","items":{"type":"string"}}}}},"example":{"order_call_later":{"status":0,"need_notify_users":["cee3c05e-5f85-43c4-b27e-889b99c50097"],"notice_created":"Gọi lại xác nhận","needs_call_at":"2024-08-29T05:50:31.700Z","phone_number":"0929911922","order_ids":["106703"]}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/customers":{"get":{"summary":"Customer list","x-summary-i18n":{"vie":"Danh sách khách hàng"},"description":"Get list of customers","tags":["Customer"],"x-tags-i18n":{"vie":["Khách hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"},{"name":"page_number","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"search","in":"query","required":false,"schema":{"type":"string","example":"0999999999"},"description":"Search keyword"},{"name":"start_time_inserted_at","in":"query","required":false,"schema":{"type":"integer","example":0},"description":"Start time inserted"},{"name":"end_time_inserted_at","in":"query","required":false,"schema":{"type":"integer","example":0},"description":"End time inserted"},{"name":"start_time_updated_at","in":"query","required":false,"schema":{"type":"integer","example":0},"description":"Start time updated"},{"name":"end_time_updated_at","in":"query","required":false,"schema":{"type":"integer","example":0},"description":"End time updated"},{"name":"customer_ids","in":"query","required":false,"schema":{"type":"string","example":"96a8e283-3fba-492e-a35a-970f72a30a02,4c74b7cf-f87b-484e-8549-6872d964f78f"},"description":"Customer IDs (comma-separated)"},{"name":"selectedLevel[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"example":["508c9819-a681-4ae2-bcff-acf92bf4e5fa"]},"description":"Customer level IDs"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of customers","items":{"$ref":"#/components/schemas/Customer"}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"b0110315-b102-436b-8b3b-ed8d16740327","name":"Trần Văn Hoàng","gender":"male","emails":["thudo@gmail.com"],"phone_numbers":["0999999999"],"date_of_birth":"1999-09-01","reward_point":10,"is_discount_by_level":true,"tags":[],"is_block":false,"assigned_user_id":"cee3c05e-5f85-43c4-b27e-889b99c50097","level_id":null,"notes":[],"shop_customer_address":[{"id":"0fefd213-7d0c-4d5b-bdbf-35694da80857","country_code":null,"province_id":"101","district_id":"10101","commune_id":null,"address":"lê văn lương","full_address":"lê văn lương, Quận Ba Đình, Hà Nội","full_name":"test","phone_number":"0999999999"}],"order_count":108,"purchased_amount":0,"succeed_order_count":8,"last_order_at":"2020-04-01T10:18:41Z","conversation_link":"https://pancake.vn/2284322048329488?customer_id=fc0dda4f-8d2a-4e70-a34a-7a6a434c6475","referral_code":"1nw4geGA","fb_id":null,"customer_id":"96a8e283-3fba-492e-a35a-970f72a30a02","pages_customers":[{"id":256469571170000,"name":"Clonners","platform":"facebook"}]}]}}}}}}}},"post":{"summary":"Create customer","x-summary-i18n":{"vie":"Tạo khách hàng"},"description":"Create customer","tags":["Customer"],"x-tags-i18n":{"vie":["Khách hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Request body containing customer information to create","content":{"application/json":{"schema":{"type":"object","required":["name","phoneNumber"],"properties":{"name":{"type":"string","description":"Customer name"},"phoneNumber":{"type":"string","description":"Phone number"},"createType":{"type":"string","description":"Create type"},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth"},"last_order_at":{"type":"integer","description":"Last order timestamp"},"shop_customer_address":{"type":"array","description":"Customer addresses","items":{"type":"object","properties":{"full_address":{"type":"string","description":"Full address"},"full_name":{"type":"string","description":"Full name"},"phone_number":{"type":"string","description":"Phone number"}}}}},"example":{"name":"Hoang","phoneNumber":"0909090909","createType":"force","dateOfBirth":"1995-02-01","last_order_at":1715878800,"shop_customer_address":[{"full_address":"190, phường dịch vọng, cầu giấy, hà nội","full_name":"hoang","phone_number":"0972868874"},{"full_address":"190, Mỹ đình 2, Nam từ liêm, hà nội","full_name":"hoang","phone_number":"0972868875"}]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Customer"},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":{"id":"9e749e68-142f-4587-a3b1-70279c30b5c2","name":"Nguyen Van Hoang","gender":null,"emails":[],"phone_numbers":["0903924956"],"date_of_birth":"1995-02-01","reward_point":0,"is_discount_by_level":true,"tags":[],"is_block":false,"assigned_user_id":"e4cec6de-96fa-4c16-9523-07910ddfee8e","level_id":null,"notes":[],"shop_customer_address":[{"id":"deeb419a-e7b6-42fd-9684-52ec6a72a41a","country_code":84,"province_id":null,"district_id":null,"commune_id":null,"address":null,"full_address":null,"full_name":null,"phone_number":"0903924956"}],"order_count":0,"purchased_amount":0,"succeed_order_count":0,"last_order_at":"2024-05-16T17:00:00Z","conversation_link":null,"referral_code":"gqo7ulKf","fb_id":null,"customer_id":"5b717afb-1856-48c9-9b6e-b8ac9db7d520"}}}}}}}}}},"/shops/{SHOP_ID}/customers/{CUSTOMER_ID}":{"get":{"summary":"Customer detail","x-summary-i18n":{"vie":"Thông tin chi tiết khách hàng"},"description":"Get detail information of a customer","tags":["Customer"],"x-tags-i18n":{"vie":["Khách hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"CUSTOMER_ID","in":"path","required":true,"schema":{"type":"string","example":"3f6e0e3c-7450-4af6-9a9f-50a6516e42e1"},"description":"Customer ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Customer"},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"b0110315-b102-436b-8b3b-ed8d16740327","name":"Trần Văn Hoàng","gender":"male","emails":["thudo@gmail.com"],"phone_numbers":["0999999999"],"date_of_birth":"1999-09-01","reward_point":10,"is_discount_by_level":true,"tags":[],"is_block":false,"assigned_user_id":"cee3c05e-5f85-43c4-b27e-889b99c50097","level_id":null,"notes":[],"shop_customer_address":[{"id":"0fefd213-7d0c-4d5b-bdbf-35694da80857","country_code":null,"province_id":"101","district_id":"10101","commune_id":null,"address":"lê văn lương","full_address":"lê văn lương, Quận Ba Đình, Hà Nội","full_name":"test","phone_number":"0999999999"}],"order_count":108,"purchased_amount":0,"succeed_order_count":8,"last_order_at":"2020-04-01T10:18:41Z","conversation_link":"https://pancake.vn/2284322048329488?customer_id=fc0dda4f-8d2a-4e70-a34a-7a6a434c6475","referral_code":"1nw4geGA","fb_id":null,"customer_id":"96a8e283-3fba-492e-a35a-970f72a30a02","pages_customers":[{"id":256469571170000,"name":"Clonners","platform":"facebook"}]}]}}}}}}}},"put":{"summary":"Update customer","x-summary-i18n":{"vie":"Cập nhật khách hàng"},"description":"Update customer","tags":["Customer"],"x-tags-i18n":{"vie":["Khách hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"CUSTOMER_ID","in":"path","required":true,"schema":{"type":"string","example":"96a8e283-3fba-492e-a35a-970f72a30a02"},"description":"Customer ID"}],"requestBody":{"required":true,"description":"Request body containing customer information to update","content":{"application/json":{"schema":{"type":"object","required":["customer"],"properties":{"customer":{"$ref":"#/components/schemas/Customer"}},"example":{"customer":{"name":"Nguyễn Thị Hằng","gender":"female","emails":["pancake@gmail.com","hoang@gmail.com"],"phone_numbers":["0983925966"],"date_of_birth":"1995-03-04","reward_point":20,"is_discount_by_level":false,"tags":["Hay hoàn"],"is_block":false,"assigned_user_id":"cee3c05e-5f85-43c4-b27e-889b99c50097","level_id":"f8dced06-965d-4070-a765-dd8268373f1e","notes":[{"id":"8a6f5380-4674-44e9-aaf2-40d898d460f5","message":"Khách hàng thân thiết","images":[{"url":"https://content.pancake.vn/user-content-dev2.pancake.vn/2023/9/6/655ae9172118ba9ffde16fa129a7001a392d1fff.png"}]}],"shop_customer_address":[{"id":"df631f21-3841-4d1c-8204-b85a7ecfce0c","country_code":84,"province_id":"101","district_id":"10113","commune_id":"1011309","address":"190 Cầu Giấy","full_name":"sơn","phone_number":"0972868874"}],"order_count":7,"purchased_amount":1000000}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/customers/point_logs":{"get":{"summary":"Customer reward point history","x-summary-i18n":{"vie":"Lịch sử điểm thưởng khách hàng"},"description":"Get reward point history for a customer","tags":["Customer"],"x-tags-i18n":{"vie":["Khách hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"shop_customer_id","in":"query","required":true,"schema":{"type":"string","example":"96a8e283-3fba-492e-a35a-970f72a30a02"},"description":"Customer ID"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"},{"name":"page_number","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of point logs","items":{"type":"object","properties":{"amount":{"type":"number","description":"Number of points changed"},"creator":{"type":"object","description":"Creator information","properties":{"id":{"type":"string"},"name":{"type":"string"},"fb_id":{"type":"string"},"avatar_url":{"type":"string"}}},"current_point":{"type":"number","description":"Current point"},"inserted_at":{"type":"string","format":"date-time","description":"Created at"},"note":{"type":"string","description":"Reason for changing reward point"}}}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"amount":10,"creator":{"id":"8fbe2a6f-b0b2-4227-a698-19d18c43f7c8","name":"Hoang Anh","fb_id":"2042723249341651","avatar_url":null},"current_point":100,"inserted_at":"2024-01-01T00:00:00Z","note":"Tích điểm từ đơn hàng"}]}}}}}}}}},"/shops/{SHOP_ID}/promotion_advance/create_multi":{"post":{"summary":"Create promotions by customer","x-summary-i18n":{"vie":"Tạo khuyến mãi theo khách hàng"},"description":"Create promotions for specific customers","tags":["Customer"],"x-tags-i18n":{"vie":["Khách hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["promotion_advance"],"properties":{"promotion_advance":{"type":"object","required":["promotion","shop_customer_ids"],"properties":{"promotion":{"type":"object","required":["type","is_activated","promo_code_info"],"properties":{"start_time":{"type":"string","format":"date-time","description":"Start time"},"end_time":{"type":"string","format":"date-time","description":"End time"},"warehouse_ids":{"type":"array","description":"Warehouse IDs to apply","items":{"type":"string"}},"customer_tags":{"type":"array","description":"Customer tags","items":{"type":"string"}},"type":{"type":"string","description":"Promotion type"},"is_activated":{"type":"boolean","description":"Activate"},"promo_code_info":{"type":"object","required":["discount","is_percent"],"properties":{"discount":{"type":"integer","description":"Discount value"},"is_percent":{"type":"boolean","description":"Is percent"},"max_discount_by_percent":{"type":"integer","description":"Maximum discount amount"},"disable":{"type":"boolean","description":"Disable"},"order_price_min":{"type":"integer","description":"Minimum order value"},"order_price_max":{"type":"integer","description":"Maximum order value"},"no_applied_products_in_other_promotions":{"type":"boolean","description":"Not applicable to products already included in other promotions"},"discount_after_other_discount":{"type":"boolean","description":"Discount based on order value after deducting other discounts"}}}}},"shop_customer_ids":{"type":"array","description":"Customer IDs to apply","items":{"type":"string"}}}}},"example":{"promotion_advance":{"promotion":{"start_time":"2024-09-30T04:58:30.020Z","end_time":"2024-10-30T04:58:30.020Z","warehouse_ids":[],"customer_tags":[],"type":"discount_by_coupon_id","is_activated":true,"promo_code_info":{"discount":5,"is_percent":true,"max_discount_by_percent":100000,"disable":false,"order_price_min":2000000,"order_price_max":3000000,"no_applied_products_in_other_promotions":true,"discount_after_other_discount":true}},"shop_customer_ids":["a8c1113d-55c2-4f7e-b33a-d4ecd76668fd"]}}}}},"description":"Request body containing promotion information to create for customers"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/customers/{CUSTOMER_ID}/load_customer_notes":{"get":{"summary":"List of notes","x-summary-i18n":{"vie":"Danh sách ghi chú"},"description":"Get list of customer notes","tags":["Customer"],"x-tags-i18n":{"vie":["Khách hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"CUSTOMER_ID","in":"path","required":true,"schema":{"type":"string","example":"96a8e283-3fba-492e-a35a-970f72a30a02"},"description":"Customer ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customer_notes":{"type":"array","description":"List of customer notes","items":{"type":"object","properties":{"notes":{"type":"array","description":"Notes","items":{"type":"object","properties":{"id":{"type":"string","description":"Note ID"},"message":{"type":"string","description":"Note content"},"images":{"type":"array","description":"Note images","items":{"type":"string","format":"uri"}},"created_at":{"type":"integer","description":"Created at (unix timestamp)"},"updated_at":{"type":"integer","description":"Updated at (unix timestamp)"},"order_id":{"type":"string","description":"Order ID"},"created_by":{"type":"object","description":"Creator information","properties":{"uid":{"type":"string"},"fb_id":{"type":"string"},"fb_name":{"type":"string"}}},"edit_history":{"type":"array","description":"Edit history","items":{"type":"object"}}}}}}}}}},"examples":{"default":{"value":{"customer_notes":[{"notes":[{"id":"8a6f5380-4674-44e9-aaf2-40d898d460f5","message":"Khách hàng thân thiết","images":[{"url":"https://content.pancake.vn/user-content-dev2.pancake.vn/2023/9/6/655ae9172118ba9ffde16fa129a7001a392d1fff.png"}],"created_at":1693987200,"updated_at":1693987200,"order_id":"116947","created_by":{"uid":"cee3c05e-5f85-43c4-b27e-889b99c50097","fb_id":"377936050731194","fb_name":"Vũ Sơn"},"edit_history":[]}]}]}}}}}}}}},"/shops/{SHOP_ID}/customers/{CUSTOMER_ID}/create_note":{"post":{"summary":"Add note","x-summary-i18n":{"vie":"Thêm ghi chú"},"description":"Add a note to customer","tags":["Customer"],"x-tags-i18n":{"vie":["Khách hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"CUSTOMER_ID","in":"path","required":true,"schema":{"type":"string","example":"96a8e283-3fba-492e-a35a-970f72a30a02"},"description":"Customer ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"conversation_id":{"type":"string","description":"Conversation ID"},"page_id":{"type":"string","description":"Page ID"},"message":{"type":"string","description":"Note content"},"images":{"type":"array","description":"Note image information","items":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Image URL"},"preview_url":{"type":"string","format":"uri","description":"Preview URL"},"name":{"type":"string","description":"Image name"},"image_data":{"type":"object","properties":{"width":{"type":"integer"},"height":{"type":"integer"}}}}}},"order_id":{"type":"integer","description":"Order ID"}},"example":{"conversation_id":"117967746266487_9306266852780716","page_id":"117967746266487","message":"khách hàng mua nhiều lần","images":[{"image_data":{"height":225,"width":225},"name":"iship thai.jpeg","preview_url":"https://content.pancake.vn/user-content-dev2.pancake.vn/2025/2/25/2488ecb12514520d9828390f695abc9db69a1452.jpg","url":"https://content.pancake.vn/user-content-dev2.pancake.vn/2025/2/25/2488ecb12514520d9828390f695abc9db69a1452.jpg"}],"order_id":116947}}}},"description":"Request body containing customer note information"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/customer_levels":{"get":{"summary":"Customer level list","x-summary-i18n":{"vie":"Danh sách cấp độ khách hàng"},"description":"Get list of customer levels","tags":["Customer"],"x-tags-i18n":{"vie":["Khách hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"search","in":"query","required":false,"schema":{"type":"string","example":"Vip"},"description":"Customer level name"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of customer levels","items":{"type":"object","properties":{"id":{"type":"string","description":"Level ID"},"name":{"type":"string","description":"Level name"},"color_customer_level":{"type":"string","description":"Color code of the level"},"discount":{"type":"integer","description":"Discount value"},"discount_type":{"type":"integer","description":"Discount type"},"shop_id":{"type":"integer","description":"Shop ID"},"upgrade_by_order_count":{"type":"integer","description":"Upgrade by order count"},"upgrade_by_point":{"type":"integer","description":"Upgrade by point"},"upgrade_by_total_purchase":{"type":"integer","description":"Upgrade by total purchase"}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"84fdef8b-8e4b-44e7-8d61-8553ee7f5833","name":"cap 1","color_customer_level":"#87d068","discount":5,"discount_type":3,"shop_id":20,"upgrade_by_order_count":10,"upgrade_by_point":100,"upgrade_by_total_purchase":30000000}]}}}}}}}}},"/shops/{SHOP_ID}/ads_manager/ad_accounts":{"get":{"summary":"List of ad accounts","x-summary-i18n":{"vie":"Danh sách tài khoản quảng cáo"},"description":"Get list of ad accounts","tags":["Ads Manager"],"x-tags-i18n":{"vie":["Quảng cáo"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":26290},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","example":30},"description":"Number of records per page"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdAccount"},"examples":{"default":{"value":{"success":true,"data":[{"id":"786374497414442","name":"Jen Nhung","account_status":1,"currency":"VND","is_business":false,"sync_succeed_at":"2026-05-21T02:00:10","tags":["thẻ 2"]}],"page_number":1,"page_size":30,"total_entries":14,"total_pages":1}}}}}}}}},"/shops/{SHOP_ID}/ads_manager/campaigns_v2":{"get":{"summary":"List of ad campaigns","x-summary-i18n":{"vie":"Danh sách chiến dịch quảng cáo"},"description":"Get list of ad campaigns","tags":["Ads Manager"],"x-tags-i18n":{"vie":["Quảng cáo"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":26290},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","example":30},"description":"Number of records per page"},{"$ref":"#/components/parameters/AdsStartTime"},{"$ref":"#/components/parameters/AdsEndTime"},{"$ref":"#/components/parameters/AdsSelectFields"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignListResponse"},"examples":{"default":{"value":{"success":true,"data":[{"id":"120239433707310738","name":"Chiến dịch Valentine 2026","status":"ACTIVE","effective_status":"ACTIVE","objective":"OUTCOME_TRAFFIC","created_time":"2026-02-02T10:00:29","start_time":"2026-02-02T16:00:00","end_time":"2026-02-03T16:00:00","marketer_id":null,"product_id":"8d5e65f5-f1da-42bc-95b4-380f356388a9","product_category_id":null,"ad_account":{"id":"1427880307614733","name":"Quỳnh Dương","currency":"VND"},"insights":{"ad_ids":["120239433707300738"],"impressions":572,"clicks":14,"reach":512,"spend":59381,"cpc":4241.5,"cpm":103812.937063,"cpp":115978.515625,"ctr":2.44755244755245,"frequency":1.117188,"order_statistics":[{"id":0,"order_count":0},{"id":1,"order_count":0}]}}],"summary":{"impressions":11462,"clicks":19,"reach":11243,"spend":135140,"cpc":6827.631579,"cpm":11790.263479,"cpp":54927.700908,"ctr":0.165765137,"frequency":1.019478774},"page_number":1,"page_size":30,"total_entries":3,"total_pages":1}}}}}}}}},"/shops/{SHOP_ID}/ads_manager/ad_sets_v2":{"get":{"summary":"List of ad sets","x-summary-i18n":{"vie":"Danh sách nhóm quảng cáo"},"description":"Get list of ad sets","tags":["Ads Manager"],"x-tags-i18n":{"vie":["Quảng cáo"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":26290},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","example":30},"description":"Number of records per page"},{"$ref":"#/components/parameters/AdsStartTime"},{"$ref":"#/components/parameters/AdsEndTime"},{"$ref":"#/components/parameters/AdsSelectFields"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdSetListResponse"},"examples":{"default":{"value":{"success":true,"data":[{"id":"120239433707290738","name":"Nhóm nam giới","status":"ACTIVE","effective_status":"ACTIVE","created_time":"2026-02-02T10:00:30","start_time":"2026-02-02T16:00:00","end_time":"2026-02-03T16:00:00","bid_amount":0,"bid_strategy":null,"billing_event":"IMPRESSIONS","daily_budget":0,"lifetime_budget":0,"destination_type":"FACEBOOK_PAGE","optimization_goal":"PROFILE_VISIT","marketer_id":null,"product_id":null,"product_category_id":null,"ad_account":{"id":"1427880307614733","name":"Quỳnh Dương","currency":"VND"},"ad_campaign":{"id":"120239433707310738","name":"Chiến dịch Valentine 2026"},"insights":{"ad_ids":["120239433707300738"],"impressions":572,"clicks":14,"reach":512,"spend":59381,"cpc":4241.5,"cpm":103812.937063,"cpp":115978.515625,"ctr":2.44755244755245,"frequency":1.117188},"targeting":{"age_min":18,"age_max":65,"age_range":[18,45],"genders":[1],"device_platforms":["mobile","desktop"],"publisher_platforms":["facebook"],"facebook_positions":["feed","facebook_reels","story"],"locales":[27],"geo_locations":{"countries":["VN"],"location_types":["home","recent"]},"flexible_spec":[{"interests":[{"id":"6003070856229","name":"Game (giải trí)"}],"behaviors":[{"id":"6002714895372","name":"Frequent Travelers"}],"life_events":[{"id":"6002714398172","name":"Newlywed (1 year)"}],"relationship_statuses":[2,4,3]}],"targeting_automation":{"advantage_audience":1}}}],"summary":{"impressions":11462,"clicks":19,"reach":11243,"spend":135140,"cpc":6827.631579,"cpm":11790.263479,"cpp":54927.700908,"ctr":0.165765137,"frequency":1.019478774},"page_number":1,"page_size":30,"total_entries":4,"total_pages":1}}}}}}}}},"/shops/{SHOP_ID}/ads_manager/ads_v2":{"get":{"summary":"List of ads","x-summary-i18n":{"vie":"Danh sách quảng cáo"},"description":"Get list of ads","tags":["Ads Manager"],"x-tags-i18n":{"vie":["Quảng cáo"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":26290},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","example":30},"description":"Number of records per page"},{"$ref":"#/components/parameters/AdsStartTime"},{"$ref":"#/components/parameters/AdsEndTime"},{"$ref":"#/components/parameters/AdsSelectFields"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdListResponse"},"examples":{"default":{"value":{"success":true,"data":[{"id":"120238954106070738","name":"Quảng cáo sale nam giới","status":"ACTIVE","effective_status":"ACTIVE","created_time":"2026-01-21T09:12:15","marketer_id":null,"product_id":null,"product_category_id":null,"ad_account":{"id":"1427880307614733","name":"Quỳnh Dương","currency":"VND"},"ad_campaign":{"id":"120238946624470738","name":"Chiến dịch siêu sale tháng 2/2026"},"ad_set":{"id":"120238954106080738","name":"Nhóm nam giới"},"ad_creative":{"id":"1175732824344796","name":"✨ CƠ HỘI DUY NHẤT ĐỂ SỞ HỮU TRANG SỨC NIMORA VỚI ƯU ĐÃI ĐẾN 70% ✨","object_story_id":"926757717191948_122108102433202138","object_story_spec":null},"insights":{"ad_ids":["120238954106070738"],"impressions":8252,"clicks":4,"reach":8121,"spend":57381,"cpc":14345.25000025,"cpm":6953.58700888221,"cpp":7078.91138298451,"ctr":0.0484730974309258,"frequency":1.011012}}],"summary":{"impressions":11462,"clicks":19,"reach":11243,"spend":135140,"cpc":6827.631579,"cpm":11790.263479,"cpp":54927.700908,"ctr":0.165765137,"frequency":1.019478774},"page_number":1,"page_size":30,"total_entries":4,"total_pages":1}}}}}}}}},"/shops/{SHOP_ID}/debt":{"get":{"summary":"List of debt","x-summary-i18n":{"vie":"Danh sách công nợ"},"description":"Get list of debts","tags":["Debt"],"x-tags-i18n":{"vie":["Công nợ"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"},{"name":"status","in":"query","required":false,"schema":{"type":"integer","default":-1,"enum":[-1,0,1,2],"x-enum-descriptions":["All status","Not transacted / Partial payment","Traded","Canceled"],"example":-1},"description":"Status"},{"name":"shop_customer_id","in":"query","required":false,"schema":{"type":"string","example":"96a8e283-3fba-492e-a35a-970f72a30a02"},"description":"Customer ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of debts","items":{"$ref":"#/components/schemas/Debt"}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"},"sum":{"type":"integer","description":"Sum"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"3990cdc9-3f40-4086-9267-cd98a9d39a99","display_id":3597,"name_debt":"Công nợ tạo tự động","description":"Công nợ được tạo tự động từ tiền nợ khách đơn hàng #19872","status":1,"type":0,"money_must_pay_or_collect":100000,"money_payed_or_collected":100000,"currency":null,"shop_id":20,"shop_customer_id":"9f222ccc-920d-47f5-89b9-edd10b488b3b","shop_customer":{"id":"9f222ccc-920d-47f5-89b9-edd10b488b3b","name":"C. Hạnh","phone_numbers":["0334913933"],"customer":{"id":"6ef36ea4-08f6-42db-ba7b-6e5198ede786","name":"C. Hạnh","fb_id":null,"global_id":null,"psid":null}},"order_id":123106,"order":{"id":123106,"display_id":19872,"custom_id":null,"total_price":147485,"cod":-332536,"assigning_seller_id":"3b782812-babe-482c-b520-cd0bc9728062"},"purchase_id":null,"export_id":null,"supplier_products_id":null,"transaction_id":null,"partner_id":null,"creator_id":"cee3c05e-5f85-43c4-b27e-889b99c50097","last_editor_id":"cee3c05e-5f85-43c4-b27e-889b99c50097","user":{"id":"cee3c05e-5f85-43c4-b27e-889b99c50097","name":"Vũ Sơn","fb_id":"377936050731194","phone_number":null},"inserted_at":"2025-09-23T07:11:10Z","updated_at":"2025-09-23T07:11:10Z","expired_at":"2025-10-23T07:11:10Z","is_locked":null,"link":"https://pos.pancake.vn/shop/product/show-debt?link_key=c8a60d30-a147-4015-b5d8-3ad95f3a59aa"}]}}}}}}}}},"/shops/{SHOP_ID}/transactions":{"get":{"summary":"List of transaction","x-summary-i18n":{"vie":"Danh sách thu chi"},"description":"Get list of transactions","tags":["Transaction"],"x-tags-i18n":{"vie":["Thu chi"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"},{"name":"status","in":"query","required":false,"schema":{"type":"integer","default":-1,"enum":[-1,0,1,2,3],"x-enum-descriptions":["All status","New","Effective","Canceled","Deleted"],"example":-1},"description":"Status"},{"name":"startDateTime","in":"query","required":false,"schema":{"type":"integer","example":0},"description":"Start time"},{"name":"endDateTime","in":"query","required":false,"schema":{"type":"integer","example":0},"description":"End time"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of transactions","items":{"$ref":"#/components/schemas/Transaction"}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"5b6bbae4-56b4-4189-a84d-d2ecfecead3e","display_id":"KH6815","name":"Giao dịch công nợ #1692 trả nhà cung cấp","note":"trả nhà cung cấp","amount":-70000,"status":1,"is_locked":false,"is_canceled":false,"is_accounting":false,"payment_debts_to_suppliers":false,"payments":["cash"],"tag_ids":["193a-e877-359a-b340-01d8-4d2e-2050","55f6-111c-2fd5-38e8-5b9d-009f-d3b1"],"supplier_products_id":293,"advertising_cost_id":null,"shop_id":20,"creator_id":"d6e6a545-f102-439e-9943-8ac8369f9735","creator":{"id":"d6e6a545-f102-439e-9943-8ac8369f9735","name":"vudzung12","fb_id":"1286585024855632","avatar_url":null},"images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"],"inserted_at":"2023-09-23T05:00:20Z","time_incurred":"2023-09-23T05:00:20Z","table_name":"debts","orderId":null}]}}}}}}}},"post":{"summary":"Create transaction","x-summary-i18n":{"vie":"Tạo phiếu thu chi"},"description":"Create transaction","tags":["Transaction"],"x-tags-i18n":{"vie":["Thu chi"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transaction"],"properties":{"transaction":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Transaction name"},"note":{"type":"string","description":"Note"},"amount":{"type":"integer","description":"Amount of money"},"is_locked":{"type":"boolean","description":"Locked"},"tag_ids":{"type":"array","description":"Transaction tags","items":{"type":"string"}},"payments":{"type":"array","description":"Payment method","items":{"type":"string","enum":["cash","transfer_money","charged_by_card","charged_by_momo","charged_by_vnpay","charged_by_kredivo","charged_by_fundiin","charged_by_qrpay"],"x-enum-descriptions":["Cash","Transfer money","Charged by card","Momo","VNPay","Kredivo","Fundiin","QRpay"]}},"supplier_products_id":{"type":"integer","description":"Supplier products ID"},"is_accounting":{"type":"boolean","description":"Financial accounting"},"time_incurred":{"type":"string","format":"date-time","description":"Time incurred"},"payment_debts_to_suppliers":{"type":"boolean","description":"Paying off debts to suppliers"},"images":{"type":"array","description":"Image links","items":{"type":"string","format":"uri"}},"orderId":{"type":"string","description":"Order ID"}}}},"example":{"transaction":{"name":"Thanh toán tiền hàng","note":"thanh toán tiền hàng","amount":-1000000,"is_locked":false,"tag_ids":["193a-e877-359a-b340-01d8-4d2e-2050"],"payments":["transfer_money"],"supplier_products_id":293,"is_accounting":true,"time_incurred":"2023-09-23T08:41:54.404Z","payment_debts_to_suppliers":true,"images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"],"orderId":"19785"}}}}},"description":"Request body containing transaction information to create"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/reconciliations":{"get":{"summary":"List of reconciliation sessions","x-summary-i18n":{"vie":"Danh sách phiếu đối soát"},"description":"Get list of reconciliation sessions. Each session includes its orders in the `orders` array","tags":["Reconciliation"],"x-tags-i18n":{"vie":["Đối soát"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":10,"maximum":50,"example":10},"description":"Page size. Default 10, maximum 50 (larger values are clamped to 50)"},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","enum":["updated_at"],"example":"updated_at"},"description":"Sort by `updated_at` ascending (then `system_id`) for incremental sync. If omitted, sessions are sorted by creation time descending"},{"name":"startDateUpdatedAt","in":"query","required":false,"schema":{"type":"integer","format":"int64","example":1758182400},"description":"Only sessions with `updated_at` >= this time (unix timestamp in seconds). Can be sent alone without `endDateUpdatedAt`"},{"name":"endDateUpdatedAt","in":"query","required":false,"schema":{"type":"integer","format":"int64","example":1758268800},"description":"Only sessions with `updated_at` <= this time (unix timestamp in seconds)"},{"name":"include_removed","in":"query","required":false,"schema":{"type":"boolean","default":false,"example":true},"description":"Include removed sessions (`is_removed: true`). Send `true` to enable"},{"name":"system_id[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer"}},"description":"Filter by internal session ID. Also accepts a single value as `system_id=123`","example":[123,124]},{"name":"display_id","in":"query","required":false,"schema":{"type":"integer","example":92},"description":"Filter by session code shown on the shop"},{"name":"search","in":"query","required":false,"schema":{"type":"string","example":"92 94"},"description":"Search by `display_id` or `custom_id` of the session. Multiple codes can be separated by space or comma; matches any of them"},{"name":"partner_id[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"Shipping partner ID on Pancake system (see Partner list). Also accepts a single value as `partner_id=1`","example":["1","3"]},{"name":"creator_id","in":"query","required":false,"schema":{"type":"string","format":"uuid","example":"d6e6a545-f102-439e-9943-8ac8369f9735"},"description":"Filter by creator user ID"},{"name":"order_id","in":"query","required":false,"schema":{"type":"integer","example":1418},"description":"Only sessions containing this order (internal order ID, `system_id` of the order)"},{"name":"startDate","in":"query","required":false,"schema":{"type":"integer","format":"int64","example":1756684800},"description":"Start of the session creation time range (unix timestamp in seconds). Applied only when both `startDate` and `endDate` are sent"},{"name":"endDate","in":"query","required":false,"schema":{"type":"integer","format":"int64","example":1759276800},"description":"End of the session creation time range (unix timestamp in seconds)"},{"name":"startDatePaidAt","in":"query","required":false,"schema":{"type":"integer","format":"int64","example":1756684800},"description":"Start of the payment time range (unix timestamp in seconds). Applied only when both `startDatePaidAt` and `endDatePaidAt` are sent; sessions without `paid_at` are excluded"},{"name":"endDatePaidAt","in":"query","required":false,"schema":{"type":"integer","format":"int64","example":1759276800},"description":"End of the payment time range (unix timestamp in seconds)"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"},"data":{"type":"array","description":"List of reconciliation sessions","items":{"$ref":"#/components/schemas/Reconciliation"}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"page_number":1,"page_size":10,"total_entries":1,"total_pages":1,"data":[{"system_id":123,"display_id":92,"custom_id":"7358901234567890123","partner_id":"1","control_type":"control_cod","note":"Đối soát COD tuần 38","excel_cod":1250000,"excel_fee":65000,"pos_cod":1250000,"paid_at":"2026-09-18T08:06:55","payment_status":"paid","creator":{"id":"d6e6a545-f102-439e-9943-8ac8369f9735","name":"vudzung12"},"updater":{"id":"d6e6a545-f102-439e-9943-8ac8369f9735","name":"vudzung12"},"inserted_at":"2026-09-17T03:12:40.512345","updated_at":"2026-09-18T08:06:55.000000","is_removed":false,"orders":[{"order_id":1418,"display_id":1418,"custom_id":null,"extend_code":"S58824.MB25.C3.500020713","order_number_vtp":null,"order_status":4,"result":"succeed","message":null,"cod_amount":750000,"partner_fee":35000,"pos_cod":750000,"currency":"VND","reconciliation_at":"2026-09-17T03:12:40"},{"order_id":1419,"display_id":1419,"custom_id":null,"extend_code":"S58824.MB25.C3.500020714","order_number_vtp":null,"order_status":4,"result":"mismatch","message":null,"cod_amount":500000,"partner_fee":30000,"pos_cod":520000,"currency":"VND","reconciliation_at":"2026-09-17T03:12:40"}]}]}}}}}},"403":{"description":"The API key is invalid or disabled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"invalid_api_key":{"value":{"success":false,"message":"api_key is invalid","error_code":105}}}}}}}}},"/shops/{SHOP_ID}/adv_costs":{"post":{"summary":"Create advertising cost","x-summary-i18n":{"vie":"Tạo chi phí quảng cáo"},"description":"Create advertising cost","tags":["Transaction"],"x-tags-i18n":{"vie":["Thu chi"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["params"],"properties":{"params":{"type":"object","required":["cost_date","transaction","items"],"properties":{"cost_date":{"type":"string","format":"date-time","description":"Cost date"},"transaction":{"type":"object","required":["name","status"],"properties":{"name":{"type":"string","description":"Transaction name"},"is_locked":{"type":"boolean","description":"Locked"},"note":{"type":"string","description":"Note"},"status":{"type":"string","description":"Status"},"time_incurred":{"type":"string","format":"date-time","description":"Time incurred"},"tags":{"type":"array","description":"Advertising tags","items":{"type":"string"}}}},"items":{"type":"array","description":"Advertising items","items":{"type":"object","required":["cost"],"properties":{"cost":{"type":"integer","description":"Cost"},"tax":{"type":"integer","description":"Tax percentage"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"is_livestream":{"type":"boolean","description":"Is livestream"},"product":{"type":"string","description":"Product ID"},"pke_mkter":{"type":"string","description":"Marketer ID"},"source":{"type":"object","description":"Source","properties":{"key":{"type":"string"},"account":{"type":"string"}}},"is_wholesale":{"type":"boolean","description":"Wholesale"},"post_ids":{"type":"array","description":"Post IDs","items":{"type":"string"}}}}}}}},"example":{"params":{"cost_date":"2023-09-07 22:00:00","transaction":{"name":"Chi phí quảng cáo","is_locked":false,"note":"example","status":"0","time_incurred":"2023-09-07 15:00:00","tags":["Thẻ 1","Thẻ 2"]},"items":[{"cost":10000,"tax":5,"warehouse_id":"IS","is_livestream":true,"product":"1","pke_mkter":"test@gmail.com","source":{"key":"-3","account":"3"},"is_wholesale":true,"post_ids":["127967746288487_545680607828820"]}]}}}}},"description":"Request body containing advertising cost information to create"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/payment_accounts/get_payment_histories":{"get":{"summary":"Transaction history","x-summary-i18n":{"vie":"Lịch sử giao dịch"},"description":"Get payment transaction history","tags":["Transaction"],"x-tags-i18n":{"vie":["Thu chi"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of payment histories","items":{"type":"object","description":"Payment history information"}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessEmptyDataResponse"}}}}}}}},"/shops/{SHOP_ID}/products":{"post":{"summary":"Create product","x-summary-i18n":{"vie":"Tạo sản phẩm"},"description":"Create product","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Request body containing product information to create","content":{"application/json":{"schema":{"type":"object","required":["product"],"properties":{"product":{"$ref":"#/components/schemas/Product"}},"example":{"product":{"name":"Ao so mi nam","type":"product","category_ids":[1290021044,201250699],"note_product":"Ghi chú sản phẩm","product_attributes":[{"name":"Màu","values":["Đen","Trắng","Đỏ"]},{"name":"Size","values":["S","M","L"]}],"tags":[193,51],"variations":[{"fields":[{"name":"Màu","value":"Trắng"},{"name":"Size","value":"M"}],"images":["https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"],"last_imported_price":30000,"retail_price":140000,"price_at_counter":123000,"retail_price_by_currency":[{"currency":"VND","retailPriceByCurrency":140000},{"currency":"USD","retailPriceByCurrency":6}],"weight":0,"barcode":"BARCODE123","custom_id":"VCUSTOMID","is_hidden":false,"variations_warehouses":[{"remain_quantity":10,"warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","batch_position":"lô 1","shelf_position":"1.2"}],"wholesale_price2":[{"levelProduct":"1","wholesalePrices":"100000"},{"levelProduct":"2","wholesalePrices":"200000"}]}],"weight":1,"custom_id":"PCUSTOMID","is_published":true,"materials":[182,193],"bonus_products":[{"quantity":1,"variation_id":"61fb5d14-107d-4b78-908d-8dc04f59d2d6","price_original":11000,"images":["https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"],"variation_info":{"id":"1","measure_group_id":"2220","measure_info":{"exchange_value":100000,"measure_id":2252},"name":"Combo 10 cây giống Cải nhún","product_id":"RAL10.2675","weight":1000}}],"keyword":"vai|cao cấp","brand_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/products/{PRODUCT_ID}":{"put":{"summary":"Update product information","x-summary-i18n":{"vie":"Cập nhật thông tin sản phẩm"},"description":"Update product information","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"PRODUCT_ID","in":"path","required":true,"schema":{"type":"string","example":"3487e126-b0d9-4dae-89a9-ee60bef2f4e9"},"description":"Product ID"}],"requestBody":{"required":true,"description":"Request body containing product information to update","content":{"application/json":{"schema":{"type":"object","required":["product"],"properties":{"product":{"$ref":"#/components/schemas/Product"}},"example":{"product":{"name":"Ao so mi nam","type":"product","category_ids":[1290021044,201250699],"note_product":"Ghi chú sản phẩm","product_attributes":[{"name":"Màu","values":["Đen","Trắng","Đỏ"]},{"name":"Size","values":["S","M","L"]}],"variations":[{"id":"3c3aca82-030e-4708-a75b-b2eaf538a2f5","fields":[{"name":"Màu","value":"Trắng"},{"name":"Size","value":"M"}],"images":[],"last_imported_price":30000,"retail_price":140000,"price_at_counter":123000,"retail_price_by_currency":[{"currency":"VND","retailPriceByCurrency":140000},{"currency":"USD","retailPriceByCurrency":6}],"weight":0,"barcode":"BARCODE123","custom_id":"VCUSTOMID","is_hidden":false,"variations_warehouses":[{"remain_quantity":10,"warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","batch_position":"lô 1","shelf_position":"1.2"}],"wholesale_price2":[{"levelProduct":"1","wholesalePrices":"100000"},{"levelProduct":"2","wholesalePrices":"200000"}]},{"fields":[{"name":"Màu","value":"Đỏ"},{"name":"Size","value":"L"}],"images":["https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"],"last_imported_price":30000,"retail_price":140000,"price_at_counter":123000,"retail_price_by_currency":[{"currency":"VND","retailPriceByCurrency":140000},{"currency":"USD","retailPriceByCurrency":6}],"weight":0,"barcode":"BARCODE123","custom_id":"VCUSTOMID2","is_hidden":false,"variations_warehouses":[{"remain_quantity":10,"warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","batch_position":"lô 1","shelf_position":"1.2"}],"wholesale_price2":[{"levelProduct":"1","wholesalePrices":"100000"},{"levelProduct":"2","wholesalePrices":"200000"}]}],"weight":1,"custom_id":"PCUSTOMID","is_published":true,"tags":[193,51],"materials":[182,193],"bonus_products":[{"quantity":1,"variation_id":"61fb5d14-107d-4b78-908d-8dc04f59d2d6","price_original":11000,"images":["https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"],"variation_info":{"id":"1","measure_group_id":"2220","measure_info":{"exchange_value":100000,"measure_id":2252},"name":"Combo 10 cây giống Cải nhún","product_id":"RAL10.2675","weight":1000}}],"keyword":"vai|cao cấp"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/variations/{VARIATION_ID}/update_quantity":{"post":{"summary":"Update inventory","x-summary-i18n":{"vie":"Cập nhật tồn kho"},"description":"Update inventory quantity for a variation","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"VARIATION_ID","in":"path","required":true,"schema":{"type":"string","example":"415040f4-ab63-465e-8699-e9ebfff4c6c7"},"description":"Variation ID"}],"requestBody":{"required":true,"description":"Request body containing inventory update information for a variation","content":{"application/json":{"schema":{"type":"object","required":["variations_warehouses"],"properties":{"variations_warehouses":{"type":"array","description":"Warehouse info","items":{"type":"object","required":["remain_quantity","warehouse_id"],"properties":{"remain_quantity":{"type":"integer","description":"Remain quantity"},"warehouse_id":{"type":"string","description":"Warehouse ID"}}}}},"example":{"variations_warehouses":[{"remain_quantity":20,"warehouse_id":"a41b5d73-9236-4a5d-9954-4db6d93242d1"},{"remain_quantity":20,"warehouse_id":"a41b5d73-9236-4a5d-9954-4db6d93242d4"},{"remain_quantity":20,"warehouse_id":"a41b5d73-9236-4a5d-9954-4db6d93242d5"}]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/variations/update_quantity":{"post":{"summary":"Updated inventory of many variations","x-summary-i18n":{"vie":"Cập nhật tồn kho nhiều mẫu mã"},"description":"Update inventory quantity for multiple variations","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Request body containing inventory update information for multiple variations","content":{"application/json":{"schema":{"type":"object","required":["variations_warehouses"],"properties":{"is_actual_remain_quantity":{"type":"boolean","description":"true: Update inventory, false: Update sellable quantity"},"variations_warehouses":{"type":"array","description":"Variations warehouses information","items":{"type":"object","required":["variation_id","remain_quantity","warehouse_id"],"properties":{"variation_id":{"type":"string","description":"Variation ID"},"remain_quantity":{"type":"integer","description":"Remain quantity"},"warehouse_id":{"type":"string","description":"Warehouse ID"}}}}},"example":{"is_actual_remain_quantity":true,"variations_warehouses":[{"variation_id":"20e7d183-c70c-445e-8ce2-4d7e3a378e34","remain_quantity":15,"warehouse_id":"229102e4-39c3-4523-bd57-4ed0a45a85ba"},{"variation_id":"5f0cfb8d-aee9-4ec0-9ff0-b5668d3143d2","remain_quantity":15,"warehouse_id":"24c4447e-c35f-4acc-affa-70e49eb354d1"}]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/variations/update_composite_product":{"post":{"summary":"Update composite product","x-summary-i18n":{"vie":"Cập nhật sản phẩm cấu thành"},"description":"Update composite product information","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Request body containing composite product update information","content":{"application/json":{"schema":{"type":"object","required":["variation_id","composite_products"],"properties":{"variation_id":{"type":"string","description":"Variation ID"},"composite_products":{"type":"array","description":"Composite products","items":{"type":"object","required":["quantity","component_id"],"properties":{"quantity":{"type":"integer","description":"Composite quantity"},"component_id":{"type":"string","description":"Composite variation ID"}}}}},"example":{"variation_id":"79aecce9-3b1e-4ad3-afe1-2ee658720687","composite_products":[{"quantity":1,"component_id":"67b19856-3226-457e-a746-df26e4ec1360"}]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/products/variations":{"get":{"summary":"Product list","x-summary-i18n":{"vie":"Danh sách sản phẩm"},"description":"Get list of products and variations, including per-warehouse stock, selling speed (for low-stock detection), and suppliers.","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size","example":30},{"name":"page_number","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number","example":1},{"name":"search","in":"query","required":false,"schema":{"type":"string","example":"áo sơ mi"},"description":"Search keyword","example":"áo sơ mi"},{"name":"selling_status","in":"query","required":false,"schema":{"type":"string","enum":["none","bad","normal","star"],"x-enum-descriptions":["Testing","Sell slow","Normal","Sell fast"],"example":"normal"},"description":"Selling speed"},{"name":"product_status","in":"query","required":false,"schema":{"type":"string","enum":["locked","not_locked"],"x-enum-descriptions":["Deactive","Active"],"example":"not_locked"},"description":"Product status"},{"name":"category_id[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer"}},"description":"Category IDs","example":[1290021044,201250699]},{"name":"is_filter_categories_by_or","in":"query","required":false,"schema":{"type":"boolean","default":true},"description":"Filter category by \"or\" condition","example":true},{"name":"filter_exclude_categories","in":"query","required":false,"schema":{"type":"boolean","default":false},"description":"Filter exclude category","example":false},{"name":"warehouse_until","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Get inventory information at time","example":"2024-01-01T00:00:00Z"},{"name":"promotion_advance[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"Promotion advance ID","example":["fb056b32-9cf6-4c5a-92de-0eb94db71121"]},{"name":"manipulationWarehouse[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"Manipulation warehouse ID","example":["a41b5d73-9236-4a5d-9954-4db6d93242d1"]},{"name":"startDate","in":"query","required":false,"schema":{"type":"integer"},"description":"Product creation start time","example":1699635600},{"name":"endDate","in":"query","required":false,"schema":{"type":"integer"},"description":"Product creation end time","example":1699635600},{"name":"start_time_update","in":"query","required":false,"schema":{"type":"integer"},"description":"Product update start time","example":1699635600},{"name":"end_time_update","in":"query","required":false,"schema":{"type":"integer"},"description":"Product update end time","example":1699635600},{"name":"included_composite","in":"query","required":false,"schema":{"type":"string","enum":["parent","children",false],"x-enum-descriptions":["Product is composed of other products","Composite product for other products","No filter"]},"description":"Filter composite products","example":"false"},{"name":"variation_ids[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"Filter by variation ID","example":["20e7d183-c70c-445e-8ce2-4d7e3a378e34"]},{"name":"product_attributes[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"Filter by product attribute","example":["blue"]},{"name":"remainQuantity","in":"query","required":false,"schema":{"type":"string","example":"{\"type\":\"smallerOrEqual\",\"value\":5,\"warehouseId\":\"all\"}"},"description":"Filter variations by **remaining (sellable) quantity** (`remain_quantity`). JSON-encoded object:\n - `type`: `\"greaterOrEqual\"` | `\"smallerOrEqual\"` | `\"between\"`\n - `value`: threshold for `greaterOrEqual` / `smallerOrEqual`\n - `minValue`, `maxValue`: range for `between`\n - `warehouseId`: `\"all\"` | a warehouse UUID | array of UUIDs — restricts which warehouses participate\n - `isFilterTotal`: `false` (default) compares per-warehouse; `true` compares SUM across the selected warehouses\nWhen any quantity filter (`remainQuantity` / `actualQuantity` / `waittingQuantity` / `returningQuantity` / `pendingQuantity` / `totalQuantity`) is set, response variations include a `warehouse_ids` array listing the warehouses that matched.\n"},{"name":"actualQuantity","in":"query","required":false,"schema":{"type":"string","example":"{\"type\":\"greaterOrEqual\",\"value\":10,\"warehouseId\":\"all\"}"},"description":"Filter variations by **actual on-hand quantity** (`actual_remain_quantity`). Same JSON shape as `remainQuantity`.\n"},{"name":"waittingQuantity","in":"query","required":false,"schema":{"type":"string","example":"{\"type\":\"greaterOrEqual\",\"value\":1,\"warehouseId\":\"all\"}"},"description":"Filter variations by **waiting/pending-to-ship quantity** (`waitting_quantity`). Same JSON shape as `remainQuantity`. (Note: param name keeps the `waitt-` spelling for backward compatibility with existing clients.)\n"},{"name":"returningQuantity","in":"query","required":false,"schema":{"type":"string","example":"{\"type\":\"greaterOrEqual\",\"value\":1,\"warehouseId\":\"all\"}"},"description":"Filter variations by **quantity in return process** (`returning_quantity`). Same JSON shape as `remainQuantity`.\n"},{"name":"pendingQuantity","in":"query","required":false,"schema":{"type":"string","example":"{\"type\":\"greaterOrEqual\",\"value\":1,\"warehouseId\":\"all\"}"},"description":"Filter variations by **reserved/pending quantity** (`pending_quantity`). Same JSON shape as `remainQuantity`.\n"},{"name":"totalQuantity","in":"query","required":false,"schema":{"type":"string","example":"{\"type\":\"between\",\"minValue\":1,\"maxValue\":100,\"warehouseId\":\"all\"}"},"description":"Filter variations by **total quantity** (`total_quantity`). Same JSON shape as `remainQuantity`.\n"},{"name":"limit_quantity_to_warn","in":"query","required":false,"schema":{"type":"boolean","example":true},"description":"When `true`, return only products whose remaining stock has reached the per-product warning threshold — i.e. **\"running out of stock\"**. The threshold is configured per-product (`limit_quantity_to_warn` on Product or Variation, depending on the product's `warning_by_variation` setting).\n"},{"name":"defectQuantity","in":"query","required":false,"schema":{"type":"boolean","example":true},"description":"When `true`, return only variations that have **damaged/defective stock** (`defect_quantity > 0` in at least one warehouse).\n"},{"name":"nearly_out","in":"query","required":false,"schema":{"type":"boolean","example":true},"description":"When `true`, return only variations flagged as **nearly out of stock** in at least one warehouse (the precomputed `nearly_out` flag on the warehouse row). Similar to `limit_quantity_to_warn` but reads the stored per-warehouse flag instead of recomputing the threshold at query time.\n"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of products and variations","items":{"type":"object","description":"Variation with product information","properties":{"average_imported_price":{"type":"integer","description":"Average imported price"},"barcode":{"type":"string","nullable":true,"description":"Variation barcode"},"display_id":{"type":"string","description":"Display ID"},"is_hidden":{"type":"boolean","description":"Is hidden"},"is_locked":{"type":"boolean","description":"Is locked"},"is_sell_negative_variation":{"type":"boolean","description":"Is sell negative variation"},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"}}}},"id":{"type":"string","description":"Variation ID"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"last_imported_price":{"type":"integer","description":"Last imported price"},"price_at_counter":{"type":"integer","description":"Counter price"},"product_id":{"type":"string","description":"Product ID"},"product":{"type":"object","description":"Product information","properties":{"note":{"type":"string","description":"Internal note"},"note_product":{"type":"string","description":"Product note"},"categories":{"type":"array","description":"Categories","items":{"type":"object"}},"display_id":{"type":"string","description":"Display ID"},"image":{"type":"string","format":"uri","description":"Product image"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"measure_group_id":{"type":"integer","description":"Measure group ID","example":58},"name":{"type":"string","description":"Product name"},"supplier_product_ids":{"type":"array","description":"Supplier product IDs","items":{"type":"integer"}},"tags":{"type":"array","description":"Product tags","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"note":{"type":"string","description":"Tag note"}}}},"is_published":{"type":"boolean","description":"Is published"},"manipulation_warehouses":{"type":"array","description":"Manipulation warehouses","items":{"type":"string"}},"product_attributes":{"type":"array","description":"Product attributes","items":{"type":"object","description":"Attribute","properties":{"name":{"type":"string","description":"Attribute name"},"values":{"type":"array","description":"Attribute values","items":{"type":"string"}}}}},"brand_id":{"type":"string","format":"uuid","description":"Brand ID"},"bonus_products":{"type":"array","description":"Bonus products","items":{"type":"object","properties":{"quantity":{"type":"integer","description":"Bonus product quantity"},"variation_id":{"type":"string","description":"Variation ID of the bonus product"},"price_original":{"type":"integer","description":"Original price of the bonus product"},"images":{"type":"array","description":"Bonus product images","items":{"type":"string","format":"uri"}},"variation_info":{"type":"object","description":"Variation information of the bonus product","properties":{"id":{"type":"string","description":"Variation info ID"},"measure_group_id":{"type":"string","description":"Measure group ID"},"measure_info":{"type":"object","description":"Measure unit information (present when measure_group_id exists)","properties":{"exchange_value":{"type":"integer","description":"Exchange value"},"measure_id":{"type":"integer","description":"Measure ID"}}},"name":{"type":"string","description":"Variation name"},"product_id":{"type":"string","description":"Product ID"},"weight":{"type":"integer","description":"Weight"}}}}}}}},"remain_quantity":{"type":"integer","description":"Remain quantity"},"retail_price":{"type":"integer","description":"Retail price"},"retail_price_by_currency":{"type":"array","description":"Retail prices by currency","items":{"$ref":"#/components/schemas/RetailPriceByCurrency"}},"size":{"$ref":"#/components/schemas/VariationSize"},"total_purchase_price":{"type":"integer","description":"Total purchase price"},"variations_warehouses":{"type":"array","description":"Warehouse info","items":{"$ref":"#/components/schemas/VariationWarehouse"}},"warehouse_ids":{"type":"array","description":"Warehouse IDs that matched the active quantity filter. Only present in the response when one of `remainQuantity` / `actualQuantity` / `waittingQuantity` / `returningQuantity` / `pendingQuantity` / `totalQuantity` is set in the request.\n","items":{"type":"string"}},"wholesale_price":{"type":"array","description":"Wholesale prices","items":{"type":"object"}},"price_table":{"type":"array","description":"Price table","items":{"type":"object","properties":{"id":{"type":"string","description":"Price table ID"},"name":{"type":"string","description":"Price table name"},"price":{"type":"integer","description":"Price"}}}},"keyword":{"type":"string","description":"Keyword"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"average_imported_price":50000,"barcode":null,"display_id":"ADXL","is_hidden":false,"is_locked":false,"is_sell_negative_variation":true,"fields":[{"id":"b032c515-3f71-4a1b-8e1d-77721ae72f37","name":"màu","value":"nâu"},{"id":"677c14b5-458f-4af6-8d73-08bcb2245547","name":"size","value":"s"}],"id":"e190db2b-1163-4cc3-b956-7a9528fbf5ef","images":["https://cf.shopee.vn/file/03e670d02803fcfbb17b2b719762ee17","https://cf.shopee.vn/file/9070bb1b0e6fcc84b46b6e5057544023"],"inserted_at":"2024-01-10T14:34:44.000000","last_imported_price":55000,"price_at_counter":123000,"product_id":"3b98a639-9d40-4faa-a692-6662f20e128d","product":{"note":"Dễ vỡ","note_product":"Ghi chú sản phẩm","categories":[],"display_id":"ADXL","image":"https://content.pancake.vn/user-content-dev2.pancake.vn/2024/11/7/1fdf82943574017240257bf9c88bc70a06a8813a.png","inserted_at":"2024-01-10T14:34:44","measure_group_id":58,"name":"ASOS đen XL","supplier_product_ids":[270],"tags":[{"id":51,"note":"the 3"},{"id":193,"note":"thẻ 1"}],"is_published":true,"manipulation_warehouses":["c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"],"product_attributes":[{"name":"Color","values":["black","white"]},{"name":"Size","values":["S","M"]}],"bonus_products":[{"quantity":1,"variation_id":"61fb5d14-107d-4b78-908d-8dc04f59d2d6","price_original":11000,"images":["https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"],"variation_info":{"id":"1","measure_group_id":"2220","measure_info":{"exchange_value":100000,"measure_id":2252},"name":"Combo 10 cây giống Cải nhún","product_id":"RAL10.2675","weight":1000}}]},"remain_quantity":20,"retail_price":140000,"retail_price_by_currency":[{"currency":"VND","retailPriceByCurrency":"140000"},{"currency":"USD","retailPriceByCurrency":"6"}],"size":{"length":10,"width":10,"height":10},"total_purchase_price":4500000,"variations_warehouses":[{"actual_remain_quantity":100,"pending_quantity":0,"remain_quantity":20,"returning_quantity":0,"selling_avg":0.23,"total_quantity":102,"warehouse_id":"a41b5d73-9236-4a5d-9954-4db6d93242d1"}],"wholesale_price":[],"price_table":[{"id":"a07c-3f7b-2db0-8002-6a88-7d4c-e7c3","name":"Giá bán sỉ","price":200000},{"id":"2251-43fa-9de5-765f-89ab-7246-c67b","name":"Giá bán lẻ","price":150000}],"keyword":"ANPR","updated_at":"2026-03-09T01:45:58.013616"}],"page_number":1,"page_size":30,"total_entries":751,"total_pages":26}}}}}}}}},"/shops/{SHOP_ID}/products/{PRODUCT_SKU}":{"get":{"summary":"Get product information","x-summary-i18n":{"vie":"Lấy thông tin 1 sản phẩm"},"description":"Get product information","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"PRODUCT_SKU","in":"path","required":true,"schema":{"type":"string","example":"3487e126-b0d9-4dae-89a9-ee60bef2f4e9"},"description":"Product SKU or ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"},"examples":{"default":{"value":{"measure_group_id":58,"name":"Ao so mi nam","category_ids":[1290021044,201250699],"note":"dễ vỡ","note_product":"Ghi chú sản phẩm","product_attributes":[{"name":"Color","values":["black","white"]},{"name":"Size","values":["s","m"]}],"tags":[193,51],"weight":1,"custom_id":"PCUSTOMID","is_published":true,"variations":[{"id":null,"fields":[{"name":"Màu","value":"Trắng"},{"name":"Size","value":"M"}],"images":["https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"],"last_imported_price":30000,"retail_price":140000,"retail_price_by_currency":[{"currency":"VND","retailPriceByCurrency":"140000"},{"currency":"USD","retailPriceByCurrency":"6"}],"price_at_counter":123000,"weight":0,"size":{"length":10,"width":10,"height":10},"barcode":"BARCODE123","custom_id":"VCUSTOMID","is_hidden":false,"variations_warehouses":[{"remain_quantity":10,"warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","batch_position":"lô 1","shelf_position":"1.2"}],"is_removed":false,"keyword":"VCUSTOMID"}],"variations_warehouses":[{"remain_quantity":10,"warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","batch_position":"lô 1","shelf_position":"1.2"}],"materials":[182,193],"bonus_products":[{"quantity":1,"variation_id":"61fb5d14-107d-4b78-908d-8dc04f59d2d6","price_original":11000,"images":["https://statics.pancake.vn/user-content.pancake.vn/2021/8/5/fccd6.jpg"],"variation_info":{"id":"1","measure_group_id":"2220","measure_info":{"exchange_value":100000,"measure_id":2252},"name":"Combo 10 cây giống Cải nhún","product_id":"RAL10.2675","weight":1000}}],"keyword":"vai|cao cấp"}}}}}}}}},"/shops/{SHOP_ID}/products/update_hide":{"put":{"summary":"Hide product","x-summary-i18n":{"vie":"Ẩn sản phẩm"},"description":"Hide product","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Request body containing product hide/show information","content":{"application/json":{"schema":{"type":"object","required":["is_hide","product_ids"],"properties":{"is_hide":{"type":"boolean","description":"Hide product"},"product_ids":{"type":"array","description":"Product IDs","items":{"type":"string"}}},"example":{"is_hide":true,"product_ids":["3cbf2227-0205-446e-8c0e-584995f3cb23","36b1e64c-f1f7-4518-afeb-1f9d2edc0f3e"]}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/tags_products":{"get":{"summary":"Product tags","x-summary-i18n":{"vie":"Danh sách thẻ sản phẩm"},"description":"Get list of product tags (removed tags are excluded), sorted by index ascending","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of product tags","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"note":{"type":"string","description":"Tag name"},"index":{"type":"integer","nullable":true,"description":"Display order (null if never reordered)"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Created at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":358,"index":0,"inserted_at":"2025-07-15T10:38:48","updated_at":"2025-07-15T14:43:16","note":"Hàng dễ vỡ","shop_id":224},{"id":359,"index":1,"inserted_at":"2025-07-15T11:05:21","updated_at":"2025-07-15T14:43:16","note":"Hàng mới về","shop_id":224}]}}}}}}}},"post":{"summary":"Create product tag","x-summary-i18n":{"vie":"Tạo thẻ sản phẩm"},"description":"Create product tag","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Request body containing product tag information to create","content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Tag name"}},"example":{"name":"Sản phẩm dễ vỡ"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"Product tag information","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"},"note":{"type":"string","description":"Tag note"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Created at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":{"id":368,"index":null,"inserted_at":"2025-09-19T10:26:38","note":"Sản phẩm dễ vỡ","shop_id":20,"updated_at":"2025-09-19T10:26:38"}}}}}}}}}},"/shops/{SHOP_ID}/categories":{"get":{"summary":"Product categories","x-summary-i18n":{"vie":"Danh mục sản phẩm"},"description":"Get list of product categories","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of categories","items":{"type":"object","properties":{"id":{"type":"integer","description":"Category ID"},"text":{"type":"string","description":"Category name"},"nodes":{"type":"array","description":"Sub-categories","items":{"type":"object"}}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":865301,"nodes":[],"text":"AirSense Áo Khoác Siêu Nhẹ"},{"id":30163,"nodes":[{"id":30167,"nodes":[],"text":"Áo Thun"},{"id":30169,"nodes":[{"id":865293,"nodes":[],"text":"Áo Thun In Họa Tiết"}],"text":"Áo Cardigan"},{"id":865292,"nodes":[],"text":"Áo Nỉ & Áo Hoodie"}],"text":"ÁO"}]}}}}}}}},"post":{"summary":"Create product category","x-summary-i18n":{"vie":"Tạo danh mục sản phẩm"},"description":"Create product category","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"description":"Request body containing product category information to create","content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Category name"},"parent_id":{"type":"string","description":"Parent category ID"}},"example":{"name":"Sản phẩm dễ vỡ","parent_id":30163}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"},"examples":{"default":{"value":{"success":true,"data":{"id":3299,"name":"Sản phẩm dễ vỡ"}}}}}}}}}},"/shops/{SHOP_ID}/brand":{"get":{"summary":"Product brand list","x-summary-i18n":{"vie":"Danh sách thương hiệu sản phẩm"},"description":"Get list of product brands","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"},{"name":"search","in":"query","required":false,"schema":{"type":"string","example":"Movado"},"description":"Search by brand name or brand ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of brands","items":{"$ref":"#/components/schemas/Brand"}}}},"examples":{"default":{"value":{"data":[{"id":"921f6676-4103-4b63-8503-78737fa74d11","name":"Movado","description":"Brand of Viet Nam","inserted_at":"2025-09-05T08:43:54","updated_at":"2025-09-05T08:43:54","shop_id":2044252,"display_id":170}]}}}}}}}}},"/shops/{SHOP_ID}/materials_products":{"get":{"summary":"Product material","x-summary-i18n":{"vie":"Chất liệu sản phẩm"},"description":"Get list of product materials","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of materials","items":{"type":"object","properties":{"description":{"type":"string","description":"Description"},"id":{"type":"integer","description":"Material ID"},"name":{"type":"string","description":"Material name"},"nodes":{"type":"array","description":"Children materials","items":{"type":"object","properties":{"description":{"type":"string","description":"Description"},"id":{"type":"integer","description":"Material ID"},"name":{"type":"string","description":"Material name"},"nodes":{"type":"array","description":"Children materials","items":{"type":"object"}}}}}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"description":"cao cấp","id":180,"name":"vai","nodes":[{"description":"chất liệu bò","id":181,"name":"vải bò","nodes":[]}]}]}}}}}}}}},"/shops/{SHOP_ID}/product_measurements/get_measure":{"get":{"summary":"List of measure groups","x-summary-i18n":{"vie":"Danh sách nhóm đơn vị tính"},"description":"Get list of measure groups","tags":["Product"],"x-tags-i18n":{"vie":["Sản phẩm"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of measure groups","items":{"type":"object","properties":{"id":{"type":"integer","description":"Measure group ID"},"name":{"type":"string","description":"Measure group name"},"nodes":{"type":"array","description":"Measure group information","items":{"type":"object","properties":{"exchange_value":{"type":"integer","description":"Exchange value"},"id":{"type":"integer","description":"Measure ID"},"is_default":{"type":"boolean","description":"Default measure"},"name":{"type":"string","description":"Measure name"},"parent_id":{"type":"integer","description":"Measure group ID"}}}},"shop_id":{"type":"integer","description":"Shop ID"}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":58,"name":"Nước hoa 1","nodes":[{"exchange_value":30,"id":61,"is_default":false,"name":"30 ml","parent_id":58}],"shop_id":20}]}}}}}}}}},"/shops/{SHOP_ID}/supplier":{"get":{"summary":"Supplier list","x-summary-i18n":{"vie":"Danh sách nhà cung cấp"},"description":"Get list of suppliers","tags":["Supplier"],"x-tags-i18n":{"vie":["Nhà cung cấp"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of suppliers","items":{"type":"object","properties":{"address":{"type":"string","description":"Shipping address"},"commune_id":{"type":"string","description":"Commune ID"},"country_code":{"type":"integer","description":"Country code"},"custom_id":{"type":"string","description":"Supplier products ID"},"debt_must_pay":{"type":"string","description":"Debt must pay"},"description":{"type":"string","description":"Description"},"district_id":{"type":"string","description":"District ID"},"full_address":{"type":"string","description":"Full address"},"id":{"type":"integer","description":"Supplier ID"},"images":{"type":"array","description":"Image links","items":{"type":"string","format":"uri"}},"is_activated":{"type":"boolean","description":"Active status"},"name":{"type":"string","description":"Supplier name"},"payment_info":{"type":"object","description":"Payment information","properties":{"account_name":{"type":"string","description":"Account name"},"account_number":{"type":"string","description":"Account number"},"partner_code":{"type":"string","description":"Partner code"}}},"phone_number":{"type":"string","description":"Phone number"},"province_id":{"type":"string","description":"Province ID"},"tags":{"type":"array","description":"Tags","items":{"type":"integer"}},"total_purchase":{"type":"string","description":"Total purchase"},"type":{"type":"integer","description":"Supplier type"}}}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_debt":{"type":"integer","description":"Total debt"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"address":"90 cầu giấy","commune_id":"1011309","country_code":84,"custom_id":"HH","debt_must_pay":"88334","description":null,"district_id":"10113","full_address":"90 cầu giấy, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội","id":988,"images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2025/7/9/8029d570d92ca81812c6ed59465fe75db042e7f9.png"],"is_activated":true,"name":"CT TNHH Hồng Hà","payment_info":{"account_name":"THANG LONG","account_number":"123456789","partner_code":"CTG"},"phone_number":"0983239908","province_id":"101","tags":[5],"total_purchase":"344444","type":0}]}}}}}}}}},"/shops/{SHOP_ID}/purchases":{"get":{"summary":"List of purchases","x-summary-i18n":{"vie":"Danh sách phiếu nhập kho"},"description":"Get list of purchases","tags":["Purchase"],"x-tags-i18n":{"vie":["Phiếu nhập kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"},{"name":"status","in":"query","required":false,"schema":{"type":"integer","default":-2,"enum":[-2,-1,0,1,2],"x-enum-descriptions":["All status","New","Confirmed","Imported goods","Canceled"],"example":-2},"description":"Status"},{"name":"type","in":"query","required":false,"schema":{"type":"string","default":"product","example":"product"},"description":"Type"},{"name":"get_time_import","in":"query","required":false,"schema":{"type":"boolean","default":false,"example":true},"description":"Get time import"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of purchases","items":{"$ref":"#/components/schemas/Purchase"}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"96bbc665-3fd5-4efc-9d8a-0110ecfa1754","display_id":6392,"status":0,"time_import":"2025-12-02T07:41:50.363889","total_quantity":1,"total_remain_quantity":1,"total_price":200000,"total_remain_price":200000,"note":"nhập kho sản phẩm","warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","supplier_products_id":293,"supplier":{"id":724,"name":"CT TNHH Hồng Hà","custom_id":"HH"},"discount":10000,"transport_fee":10000,"prepaid_debt":100000,"auto_create_debts":true,"not_create_transaction":true,"is_lock":null,"created_type":"actual_purchase","tags":[1],"tag_info":[{"id":1,"name":"Nhập hàng để bán"}],"items":[{"id":"02cb1ff3-9b21-4e1c-9288-a29c16bd907d","imported_price":200000,"gross_price":200000,"discount":10000,"quantity":1,"variation_id":"20e7d183-c70c-445e-8ce2-4d7e3a378e34","product_name":"Áo nam","note_purchase":"áo nam thời trang","selling_status":"bad","variation":{"id":"69416fa6-4c3d-451f-897d-9faa0420c060","display_id":"mauma1","barcode":"mauma1","product_id":"f210413c-dc84-45e5-b722-9dc72ff7c9af","retail_price":10000,"retail_price_after_discount":10000,"remain_quantity":9,"weight":0,"product":{"display_id":"Áo nam","name":"Áo nam"},"variations_warehouses":[]}}],"images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"],"bill_images":[],"user_id":"cee3c05e-5f85-43c4-b27e-889b99c50097","user":{"id":"cee3c05e-5f85-43c4-b27e-889b99c50097","name":"Vũ Sơn","fb_id":"377936050731194","avatar_url":null},"inserted_at":"2023-09-20T02:21:51Z","updated_at":"2023-09-20T02:22:05Z","received_at":"2023-09-21T00:00:00Z","separate_by_display_ids":null}]}}}}}}}},"post":{"summary":"Create purchase","x-summary-i18n":{"vie":"Tạo phiếu nhập kho"},"description":"Create purchase","tags":["Purchase"],"x-tags-i18n":{"vie":["Phiếu nhập kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["purchase"],"properties":{"purchase":{"type":"object","required":["status","warehouse_id","items"],"properties":{"note":{"type":"string","description":"Note"},"status":{"type":"integer","description":"Status"},"not_create_transaction":{"type":"boolean","description":"Not create transaction"},"auto_create_debts":{"type":"boolean","description":"Auto create debts"},"supplier_products_id":{"type":"integer","description":"Supplier products ID"},"shop_id":{"type":"integer","description":"Shop ID"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"change_received_at":{"type":"boolean","description":"Change received at"},"received_at":{"type":"integer","description":"Received at (unix timestamp)"},"images":{"type":"array","description":"Purchase images","items":{"type":"string","format":"uri"}},"items":{"type":"array","description":"List of products","items":{"type":"object","required":["imported_price","quantity"],"properties":{"imported_price":{"type":"integer","description":"Imported price"},"gross_price":{"type":"integer","description":"Gross price"},"discount":{"type":"integer","description":"Discount on product"},"quantity":{"type":"integer","description":"Import quantity"},"variation_id":{"type":"string","description":"Variation ID"},"index":{"type":"integer","description":"Product sort order"}}}}}}},"example":{"purchase":{"note":"","status":1,"not_create_transaction":false,"auto_create_debts":true,"supplier_products_id":169,"shop_id":20,"warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","change_received_at":true,"received_at":1651683600,"images":["https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"],"items":[{"imported_price":100000,"gross_price":100000,"discount":10000,"quantity":1,"variation_id":"29044dcf-2f4c-492f-a0a9-e447b20e21da","index":0}]}}}}},"description":"Request body containing purchase information to create"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/purchases/{PURCHASE_ID}":{"get":{"summary":"Get purchase","x-summary-i18n":{"vie":"Chi tiết phiếu nhập kho"},"description":"Get one purchase by ID or display ID, in the same shape as an item of the purchase list. Purchases in warehouses the caller cannot view are reported as not found.","tags":["Purchase"],"x-tags-i18n":{"vie":["Phiếu nhập kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"PURCHASE_ID","in":"path","required":true,"schema":{"type":"string","example":"fb056b32-9cf6-4c5a-92de-0eb94db71121"},"description":"Purchase ID (UUID) or display ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Purchase"},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":{"id":"96bbc665-3fd5-4efc-9d8a-0110ecfa1754","display_id":6392,"status":0,"time_import":"2025-12-02T07:41:50.363889","total_quantity":1,"total_remain_quantity":1,"total_price":200000,"total_remain_price":200000,"note":"nhập kho sản phẩm","warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","supplier_products_id":293,"supplier":{"id":724,"name":"CT TNHH Hồng Hà","custom_id":"HH"},"discount":10000,"transport_fee":10000,"prepaid_debt":100000,"auto_create_debts":true,"not_create_transaction":true,"is_lock":null,"created_type":"actual_purchase","tags":[1],"tag_info":[{"id":1,"name":"Nhập hàng để bán"}],"items":[{"id":"02cb1ff3-9b21-4e1c-9288-a29c16bd907d","imported_price":200000,"gross_price":200000,"discount":10000,"quantity":1,"variation_id":"20e7d183-c70c-445e-8ce2-4d7e3a378e34","product_name":"Áo nam","note_purchase":"áo nam thời trang","selling_status":"bad","variation":{"id":"69416fa6-4c3d-451f-897d-9faa0420c060","display_id":"mauma1","barcode":"mauma1","product_id":"f210413c-dc84-45e5-b722-9dc72ff7c9af","retail_price":10000,"retail_price_after_discount":10000,"remain_quantity":9,"weight":0,"product":{"display_id":"Áo nam","name":"Áo nam"},"variations_warehouses":[]}}],"images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"],"bill_images":[],"user_id":"cee3c05e-5f85-43c4-b27e-889b99c50097","user":{"id":"cee3c05e-5f85-43c4-b27e-889b99c50097","name":"Vũ Sơn","fb_id":"377936050731194","avatar_url":null},"inserted_at":"2023-09-20T02:21:51Z","updated_at":"2023-09-20T02:22:05Z","received_at":"2023-09-21T00:00:00Z","separate_by_display_ids":null}}}}}}},"404":{"description":"The purchase does not exist or is not visible to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"message":"Purchase order not found"}}}}}},"put":{"summary":"Update purchase","x-summary-i18n":{"vie":"Cập nhật phiếu nhập kho"},"description":"Update purchase","tags":["Purchase"],"x-tags-i18n":{"vie":["Phiếu nhập kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"PURCHASE_ID","in":"path","required":true,"schema":{"type":"string","example":"fb056b32-9cf6-4c5a-92de-0eb94db71121"},"description":"Purchase ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["purchase"],"properties":{"purchase":{"type":"object","required":["warehouse_id"],"properties":{"note":{"type":"string","description":"Note"},"status":{"type":"integer","description":"Status","enum":[-1,0,1,2],"x-enum-descriptions":["New","Confirmed","Imported goods","Canceled"]},"not_create_transaction":{"type":"boolean","description":"Not create transaction"},"auto_create_debts":{"type":"boolean","description":"Auto create debts"},"supplier_products_id":{"type":"integer","description":"Supplier products ID"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"change_received_at":{"type":"boolean","description":"Change received at"},"received_at":{"type":"integer","description":"Received at"},"images":{"type":"array","description":"Purchase images","items":{"type":"string","format":"uri"}},"items":{"type":"array","description":"List of products","items":{"type":"object","required":["imported_price"],"properties":{"imported_price":{"type":"integer","description":"Imported price"},"quantity":{"type":"integer","description":"Import quantity"},"variation_id":{"type":"string","description":"Variation ID"}}}}}}},"example":{"purchase":{"note":"","status":1,"not_create_transaction":false,"auto_create_debts":true,"supplier_products_id":169,"warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","change_received_at":true,"received_at":1651683600,"images":["https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"],"items":[{"imported_price":100000,"quantity":1,"variation_id":"29044dcf-2f4c-492f-a0a9-e447b20e21da"}]}}}}},"description":"Request body containing purchase information to update"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/purchases/separate":{"post":{"summary":"Separate purchase","x-summary-i18n":{"vie":"Tách phiếu nhập kho"},"description":"Separate a purchase into multiple purchases","tags":["Purchase"],"x-tags-i18n":{"vie":["Phiếu nhập kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["newPurchase","oldPurchase"],"properties":{"newPurchase":{"type":"object","description":"New purchase information","properties":{"auto_create_debts":{"type":"boolean","description":"Auto create debts"},"discount":{"type":"integer","description":"Discount"},"images":{"type":"array","description":"Purchase images","items":{"type":"string","format":"uri"}},"items":{"type":"array","description":"List of products","items":{"type":"object","required":["imported_price","quantity","variation_id"],"properties":{"imported_price":{"type":"integer","description":"Imported price"},"quantity":{"type":"integer","description":"Import quantity"},"variation_id":{"type":"string","description":"Variation ID"},"index":{"type":"integer","description":"Product sort order"}}}},"not_create_transaction":{"type":"boolean","description":"Not create transaction"},"note":{"type":"string","description":"Note"},"prepaid_debt":{"type":"integer","description":"Prepaid debt"},"received_at":{"type":"integer","description":"Received at"},"status":{"type":"integer","description":"Status"},"supplier_products_id":{"type":"integer","description":"Supplier products ID"},"tags":{"type":"array","description":"Tag IDs","items":{"type":"integer"}},"transport_fee":{"type":"integer","description":"Shipping fee"},"warehouse_id":{"type":"string","description":"Warehouse ID"}}},"oldPurchase":{"type":"object","description":"Old purchase information","required":["id"],"properties":{"id":{"type":"string","description":"Purchase ID"},"auto_create_debts":{"type":"boolean","description":"Auto create debts"},"discount":{"type":"integer","description":"Discount"},"images":{"type":"array","description":"Purchase images","items":{"type":"string","format":"uri"}},"items":{"type":"array","description":"List of products","items":{"type":"object","required":["imported_price","quantity","variation_id"],"properties":{"imported_price":{"type":"integer","description":"Imported price"},"quantity":{"type":"integer","description":"Import quantity"},"variation_id":{"type":"string","description":"Variation ID"},"index":{"type":"integer","description":"Product sort order"}}}},"not_create_transaction":{"type":"boolean","description":"Not create transaction"},"note":{"type":"string","description":"Note"},"prepaid_debt":{"type":"integer","description":"Prepaid debt"},"received_at":{"type":"integer","description":"Received at"},"status":{"type":"integer","description":"Status"},"supplier_products_id":{"type":"integer","description":"Supplier products ID"},"tags":{"type":"array","description":"Tag IDs","items":{"type":"integer"}},"transport_fee":{"type":"integer","description":"Shipping fee"},"warehouse_id":{"type":"string","description":"Warehouse ID"}}}},"example":{"newPurchase":{"auto_create_debts":true,"discount":500,"images":["https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"],"items":[{"imported_price":100000,"quantity":1,"variation_id":"ddefd476-bc91-4151-8cd2-2cf5ad227f09","index":0}],"not_create_transaction":false,"note":"Tách phiếu nhập","prepaid_debt":20000,"received_at":1683997200,"status":0,"supplier_products_id":293,"tags":[1],"transport_fee":0,"warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"},"oldPurchase":{"auto_create_debts":true,"discount":500,"id":"0ecbdb3b-a376-4a3d-9b8a-174ae15ae886","images":["https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"],"items":[{"imported_price":100000,"quantity":23,"variation_id":"ddefd476-bc91-4151-8cd2-2cf5ad227f09","index":0}],"not_create_transaction":false,"note":"Nhập hàng để bán","prepaid_debt":20000,"received_at":1683997200,"status":0,"supplier_products_id":293,"tags":[1],"transport_fee":0,"warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da"}}}}},"description":"Request body containing purchase separation information"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/export":{"get":{"summary":"List of exports","x-summary-i18n":{"vie":"Danh sách phiếu xuất kho"},"description":"Get list of exports","tags":["Export"],"x-tags-i18n":{"vie":["Phiếu xuất kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"},{"name":"status","in":"query","required":false,"schema":{"type":"integer","default":-1,"enum":[-1,0,1,2],"x-enum-descriptions":["All status","New","Completed","Canceled"],"example":-1},"description":"Status"},{"name":"type","in":"query","required":false,"schema":{"type":"integer","default":0,"enum":[0,1],"x-enum-descriptions":["Normal export","Product defect export"],"example":0},"description":"Type of export"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of exports","items":{"$ref":"#/components/schemas/Export"}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"8095ca3c-a485-4378-9914-5013e1179d55","display_id":472,"status":0,"type":0,"total":1,"total_price":0,"note":"Xuất bán hàng","warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","supplier_products_id":400037328,"tags":[1],"export_items":[{"id":"78dfe47a-a3dd-4d47-8f8b-16eb1ccd69ee","imported_price":0,"quantity":1,"variation_id":"76887a5b-8a27-472c-a15a-661ea59434dd","display_id":0,"inserted_at":"2024-01-25T16:18:20Z"}],"images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"],"user_id":"d6e6a545-f102-439e-9943-8ac8369f9735","user":{"id":"d6e6a545-f102-439e-9943-8ac8369f9735","name":"vudzung12","fb_id":"1286585024855632","avatar_url":null},"inserted_at":"2024-01-25T16:18:20Z","updated_at":"2024-01-25T16:18:20Z"}]}}}}}}}},"post":{"summary":"Create export","x-summary-i18n":{"vie":"Tạo phiếu xuất kho"},"description":"Create export","tags":["Export"],"x-tags-i18n":{"vie":["Phiếu xuất kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["export_list"],"properties":{"export_list":{"type":"object","required":["status","warehouse_id","export_items"],"properties":{"note":{"type":"string","description":"Note"},"supplier_products_id":{"type":"integer","description":"Supplier products ID"},"tags":{"type":"array","description":"Export tags","items":{"type":"integer"}},"status":{"type":"integer","description":"Export status","enum":[0,1,2],"x-enum-descriptions":["New (type 0) / Defect export (type 1)","Completed (type 0) / Elimination export (type 1)","Canceled"]},"type":{"type":"integer","description":"Type of export","enum":[0,1],"x-enum-descriptions":["Normal export","Product defect export"]},"shop_id":{"type":"integer","description":"Shop ID"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"change_inserted_at":{"type":"boolean","description":"Change date of create export"},"inserted_at":{"type":"integer","description":"Date of create export (unix timestamp)"},"images":{"type":"array","description":"Export images","items":{"type":"string","format":"uri"}},"export_items":{"type":"array","description":"List of products","items":{"type":"object","required":["imported_price","quantity","variation_id"],"properties":{"id":{"type":"string","description":"Export item ID"},"imported_price":{"type":"integer","description":"Export price"},"quantity":{"type":"integer","description":"Export quantity"},"variation_id":{"type":"string","description":"Variation ID"}}}}}}},"example":{"export_list":{"note":"","supplier_products_id":169,"tags":[1],"status":0,"type":0,"shop_id":20,"warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","change_inserted_at":true,"inserted_at":1651683600,"images":["https://statics.pancake.vn/user-content-dev2.pancake.vn/2021/12/27/18c4500c320cb2e993b3ff4b3be81165df64d3ba.png"],"export_items":[{"id":"13d7ddf6-4cd9-4e1f-a5c1-ac3cd7a7fc17","imported_price":100000,"quantity":1,"variation_id":"29044dcf-2f4c-492f-a0a9-e447b20e21da"}]}}}}},"description":"Request body containing export information to create"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/export/{EXPORT_ID}":{"get":{"summary":"Get export","x-summary-i18n":{"vie":"Chi tiết phiếu xuất kho"},"description":"Get one export by ID or display ID, in the same shape as an item of the export list. Exports in warehouses the caller cannot view are reported as not found.","tags":["Export"],"x-tags-i18n":{"vie":["Phiếu xuất kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"EXPORT_ID","in":"path","required":true,"schema":{"type":"string","example":"8095ca3c-a485-4378-9914-5013e1179d55"},"description":"Export ID (UUID) or display ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Export"},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":{"id":"8095ca3c-a485-4378-9914-5013e1179d55","display_id":472,"status":0,"type":0,"total":1,"total_price":0,"note":"Xuất bán hàng","warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","supplier_products_id":400037328,"tags":[1],"export_items":[{"id":"78dfe47a-a3dd-4d47-8f8b-16eb1ccd69ee","imported_price":0,"quantity":1,"variation_id":"76887a5b-8a27-472c-a15a-661ea59434dd","display_id":0,"inserted_at":"2024-01-25T16:18:20Z"}],"user_id":"d6e6a545-f102-439e-9943-8ac8369f9735","inserted_at":"2024-01-25T16:18:20Z","updated_at":"2024-01-25T16:18:20Z"}}}}}}},"404":{"description":"The export does not exist or is not visible to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"message":"Export not found"}}}}}},"put":{"summary":"Update export","x-summary-i18n":{"vie":"Cập nhật phiếu xuất kho"},"description":"Update export","tags":["Export"],"x-tags-i18n":{"vie":["Phiếu xuất kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"EXPORT_ID","in":"path","required":true,"schema":{"type":"string","example":"8fbe2a6f-b0b2-4227-a698-19d18c43f7c8"},"description":"Export ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["export_list"],"properties":{"export_list":{"type":"object","properties":{"images":{"type":"array","description":"Export images","items":{"type":"string","format":"uri"}},"inserted_at":{"type":"integer","description":"Date of create export (unix timestamp)"},"note":{"type":"string","description":"Note"},"status":{"type":"integer","description":"Export status","enum":[0,1,2],"x-enum-descriptions":["New (type 0) / Defect export (type 1)","Completed (type 0) / Elimination export (type 1)","Canceled"]},"supplier_products_id":{"type":"integer","description":"Supplier products ID"},"tags":{"type":"array","description":"Export tags","items":{"type":"integer"}},"type":{"type":"integer","description":"Type of export","enum":[0,1],"x-enum-descriptions":["Normal export","Product defect export"]},"export_items":{"type":"array","description":"List of products","items":{"type":"object","required":["id","imported_price","quantity","variation_id"],"properties":{"id":{"type":"string","description":"Export item ID"},"imported_price":{"type":"integer","description":"Export price"},"quantity":{"type":"integer","description":"Export quantity"},"variation_id":{"type":"string","description":"Variation ID"}}}}}}},"example":{"export_list":{"images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2022/5/27/ee3be79d1574735ed35539ca48f7f6e9d7137706.jpg"],"inserted_at":1695142800,"note":"xuất bán hàng","status":0,"supplier_products_id":319,"tags":[1],"export_items":[{"id":"13d7ddf6-4cd9-4e1f-a5c1-ac3cd7a7fc17","imported_price":1000,"quantity":1,"variation_id":"d1e522eb-2f6f-4d22-b8a1-ec25df4a33a4"}]}}}}},"description":"Request body containing export information to create"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/transfers":{"get":{"summary":"List of warehouse transfers","x-summary-i18n":{"vie":"Danh sách chuyển kho"},"description":"Get list of warehouse transfers","tags":["Warehouse Transfer"],"x-tags-i18n":{"vie":["Chuyển kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"},{"name":"status","in":"query","required":false,"schema":{"type":"integer","default":1,"enum":[0,1,2],"x-enum-descriptions":["Waiting for pick up","Shipping","Completed"],"example":1},"description":"Status"},{"name":"startDate","in":"query","required":false,"schema":{"type":"integer","example":0},"description":"Start date"},{"name":"endDate","in":"query","required":false,"schema":{"type":"integer","example":0},"description":"End date"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of warehouse transfers","items":{"$ref":"#/components/schemas/WarehouseTransfer"}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"5c9ef4a6-2411-4d5f-9a91-1bc22dbb7eb1","display_id":309,"status":0,"from_warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","from_warehouse_name":"Kho HCM","to_warehouse_id":"229102e4-39c3-4523-bd57-4ed0a45a85ba","to_warehouse_name":"Cho tao cơm","total_quantity":1,"shipping_fee":30000,"note":"Chuyển kho bán hàng","items":[{"id":"f80bdc16-a000-4bf1-a979-c3fd4033f551","variation_id":"3b11fb7b-9081-42c0-9546-dfac62b9c9ca","quantity":3,"product_display_id":"áo nam","product_name":"áo nam","variation_display_id":"XANH-M","variation_fields":[{"id":"beb75502-5a50-48d6-bed8-89ea8ddc9a66","name":"màu","value":"xanh dương","keyValue":"xanh dương"},{"id":"8eee6f85-0a76-46da-9dd7-6668bc6d8729","name":"size","value":"M","keyValue":"M"}]}],"images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"],"shop_id":20,"creator_id":"cee3c05e-5f85-43c4-b27e-889b99c50097","inserted_at":"2023-09-13T09:34:37Z","updated_status_at":"2023-09-13T09:34:37Z"}]}}}}}}}}},"/shops/{SHOP_ID}/transfers/multi":{"post":{"summary":"Create warehouse transfer","x-summary-i18n":{"vie":"Tạo phiếu chuyển kho"},"description":"Create warehouse transfer","tags":["Warehouse Transfer"],"x-tags-i18n":{"vie":["Chuyển kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transfer"],"properties":{"transfer":{"type":"object","required":["from_warehouse_id","to_warehouse_ids","items"],"properties":{"from_warehouse_id":{"type":"string","description":"From warehouse ID"},"to_warehouse_ids":{"type":"array","description":"To warehouse IDs","items":{"type":"string"}},"shipping_fee":{"type":"integer","description":"Shipping fee"},"note":{"type":"string","description":"Note"},"images":{"type":"array","description":"Transfer images","items":{"type":"string","format":"uri"}},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"items":{"type":"array","description":"List of products","items":{"type":"object","required":["quantity","variation_id"],"properties":{"quantity":{"type":"integer","description":"Quantity"},"variation_id":{"type":"string","description":"Variation ID"}}}}}}},"example":{"transfer":{"from_warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","to_warehouse_ids":["229102e4-39c3-4523-bd57-4ed0a45a85ba"],"shipping_fee":20000,"items":[{"quantity":1,"variation_id":"20e7d183-c70c-445e-8ce2-4d7e3a378e34"}],"note":"đây là ghi chú","images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2022/5/27/ee3be79d1574735ed35539ca48f7f6e9d7137706.jpg"],"inserted_at":"2025-03-11T09:24:42"}}}}},"description":"Request body containing warehouse transfer information to create"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/transfers/{TRANSFER_ID}":{"get":{"summary":"Get warehouse transfer","x-summary-i18n":{"vie":"Chi tiết phiếu chuyển kho"},"description":"Get one warehouse transfer by ID or display ID, in the same shape as an item of the warehouse transfer list. A transfer is visible when the caller can view transfers in its source or destination warehouse; otherwise it is reported as not found.","tags":["Warehouse Transfer"],"x-tags-i18n":{"vie":["Chuyển kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"TRANSFER_ID","in":"path","required":true,"schema":{"type":"string","example":"b482ae3a-b89a-4d64-9859-ed6e3af5a476"},"description":"Warehouse transfer ID (UUID) or display ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WarehouseTransfer"},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":{"id":"5c9ef4a6-2411-4d5f-9a91-1bc22dbb7eb1","display_id":309,"status":0,"from_warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","from_warehouse_name":"Kho HCM","to_warehouse_id":"229102e4-39c3-4523-bd57-4ed0a45a85ba","to_warehouse_name":"Cho tao cơm","total_quantity":1,"shipping_fee":30000,"note":"Chuyển kho bán hàng","items":[{"id":"f80bdc16-a000-4bf1-a979-c3fd4033f551","variation_id":"3b11fb7b-9081-42c0-9546-dfac62b9c9ca","quantity":3,"product_display_id":"áo nam","product_name":"áo nam","variation_display_id":"XANH-M","variation_fields":[{"id":"beb75502-5a50-48d6-bed8-89ea8ddc9a66","name":"màu","value":"xanh dương","keyValue":"xanh dương"},{"id":"8eee6f85-0a76-46da-9dd7-6668bc6d8729","name":"size","value":"M","keyValue":"M"}]}],"images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2022/7/7/eb376f0bf90f47d25396d49e4d547700f182981b.jpg"],"shop_id":20,"creator_id":"cee3c05e-5f85-43c4-b27e-889b99c50097","inserted_at":"2023-09-13T09:34:37Z","updated_status_at":"2023-09-13T09:34:37Z"}}}}}}},"404":{"description":"The warehouse transfer does not exist or is not visible to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"message":"Warehouse transfer not found"}}}}}},"put":{"summary":"Update warehouse transfer","x-summary-i18n":{"vie":"Cập nhật phiếu chuyển kho"},"description":"Update warehouse transfer","tags":["Warehouse Transfer"],"x-tags-i18n":{"vie":["Chuyển kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"TRANSFER_ID","in":"path","required":true,"schema":{"type":"string","example":"b482ae3a-b89a-4d64-9859-ed6e3af5a476"},"description":"Transfer ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transfer"],"properties":{"transfer":{"type":"object","required":["status","from_warehouse_id"],"properties":{"status":{"type":"integer","description":"Status","enum":[0,1,2],"x-enum-descriptions":["Waiting for pick up","Shipping","Completed"]},"from_warehouse_id":{"type":"string","description":"From warehouse ID"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"note":{"type":"string","description":"Note"},"images":{"type":"array","description":"Transfer images","items":{"type":"string","format":"uri"}},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"change_inserted_at":{"type":"boolean","description":"Change creation time"},"items":{"type":"array","description":"List of products","items":{"type":"object","required":["variation_id","quantity"],"properties":{"variation_id":{"type":"string","description":"Variation ID"},"quantity":{"type":"integer","description":"Transfer quantity"}}}}}}},"example":{"transfer":{"status":1,"from_warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","shipping_fee":10000,"items":[{"variation_id":"51bb0bb7-77e9-407e-9f57-5072a0236cb4","quantity":1}],"note":"Chuyển kho bán hàng","images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2024/8/30/7886ccd76d3629808d21fa3e59849c8e79a28162.png"],"inserted_at":"2025-03-11T09:24:42","change_inserted_at":true}}}}},"description":"Request body containing warehouse transfer information to update"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/transfers/get_status_history/{TRANSFER_ID}":{"get":{"summary":"History of warehouse transfer status updates","x-summary-i18n":{"vie":"Lịch sử cập nhật trạng thái chuyển kho"},"description":"Get history of warehouse transfer status updates","tags":["Warehouse Transfer"],"x-tags-i18n":{"vie":["Chuyển kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"TRANSFER_ID","in":"path","required":true,"schema":{"type":"string","example":"b482ae3a-b89a-4d64-9859-ed6e3af5a476"},"description":"Transfer ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of status history","items":{"type":"object","description":"Status history information","properties":{"id":{"type":"string","description":"Status history ID"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Updated status"},"transfer_id":{"type":"string","description":"Warehouse transfer ID"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"user_id":{"type":"string","description":"Updated employee ID"},"user":{"type":"object","description":"User information","properties":{"avatar_url":{"type":"string","format":"uri","description":"Avatar URL"},"fb_id":{"type":"string","description":"Facebook ID"},"name":{"type":"string","description":"Name"}}}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"4c961f28-9a1c-11f0-9d68-0242ac1a000a","old_status":0,"status":1,"transfer_id":"ed386c72-ba0c-4b2a-85dd-c8b1903badc2","updated_at":"2025-09-25T14:31:18Z","user_id":"cee3c05e-5f85-43c4-b27e-889b99c50097","user":{"avatar_url":null,"fb_id":"377936050731194","name":"Vũ Sơn"}}]}}}}}}}}},"/shops/{SHOP_ID}/stocktakings":{"get":{"summary":"Stocktaking list","x-summary-i18n":{"vie":"Danh sách kiểm hàng"},"description":"Get list of stocktakings","tags":["Stocktaking"],"x-tags-i18n":{"vie":["Kiểm hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"},{"name":"status","in":"query","required":false,"schema":{"type":"integer","default":-2,"enum":[-2,-1,0,1,2],"x-enum-descriptions":["All status","Creating","Stocktaking","Stocktook","Canceled"],"example":-2},"description":"Status"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of stocktakings","items":{"$ref":"#/components/schemas/Stocktaking"}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"4d0f479d-feab-489b-bc82-4a656902a20b","display_id":null,"status":0,"warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","stocktaking_by":"category_ids","stocktaking_by_value":["1315"],"stocktaking_at":"2023-10-11T08:24:56Z","progress":0,"note":"Kiểm hàng tồn","items":[{"id":"cb244b25-100e-4eaa-8b8f-0e72c5642631","variation_id":"27b3f94b-c945-4560-b694-a59526cae9a5","changed_quantity":12,"current_quantity":0,"note":null,"variation":{"id":"27b3f94b-c945-4560-b694-a59526cae9a5","display_id":"1","barcode":"12ml-6291107458328","product_id":"61894c4f-d759-45b7-acf7-ff5e88082016","retail_price":240000,"last_imported_price":20000,"weight":1000,"fields":[],"images":["https://statics.pancake.vn/user-content.pancake.vn/2023/4/12/05138842c6f772cde332fd8e1be1bff58245f19e.png"],"product":{"display_id":"12ml-6291107458328","name":"12ml Badee Al Oud","image":null,"note_product":""}},"inserted_at":"2024-12-02T10:42:39Z","updated_at":"2024-12-02T10:42:39Z"}],"shop_id":20,"creator_id":"cee3c05e-5f85-43c4-b27e-889b99c50097","inserted_at":"2023-10-11T08:25:18Z","updated_at":"2023-10-11T09:03:03Z","updated_status_at":"2023-10-11T08:25:18Z"}]}}}}}}}},"post":{"summary":"Create stocktaking","x-summary-i18n":{"vie":"Tạo phiếu kiểm hàng"},"description":"Create stocktaking","tags":["Stocktaking"],"x-tags-i18n":{"vie":["Kiểm hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["stocktaking"],"properties":{"stocktaking":{"type":"object","required":["warehouse_id","items","status"],"properties":{"warehouse_id":{"type":"string","description":"Warehouse ID"},"items":{"type":"array","description":"List of products","items":{"type":"object","required":["variation_id","changed_quantity"],"properties":{"variation_id":{"type":"string","description":"Variation ID"},"changed_quantity":{"type":"integer","description":"Changed quantity"}}}},"note":{"type":"string","description":"Note"},"status":{"type":"integer","description":"Status"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"stocktaking_at":{"type":"string","format":"date-time","description":"Stocktaking at"},"stocktaking_by":{"type":"string","description":"Stocktaking by"},"stocktaking_by_value":{"type":"array","description":"Category ID / Supplier products ID / Brand ID","items":{"type":"string"}}}}},"example":{"stocktaking":{"warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","items":[{"variation_id":"20e7d183-c70c-445e-8ce2-4d7e3a378e34","changed_quantity":-1}],"note":"Kiểm hàng tồn","status":0,"inserted_at":"2025-04-04T10:42:40.100Z","stocktaking_at":"2023-10-11T10:38:34.542Z","stocktaking_by":"category_ids","stocktaking_by_value":["1315"]}}}}},"description":"Request body containing stocktaking information to create"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/stocktakings/{STOCKTAKING_ID}":{"get":{"summary":"Get stocktaking information","x-summary-i18n":{"vie":"Lấy thông tin 1 phiếu kiểm hàng"},"description":"Get stocktaking information","tags":["Stocktaking"],"x-tags-i18n":{"vie":["Kiểm hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"STOCKTAKING_ID","in":"path","required":true,"schema":{"type":"string","example":"949f1396-f6fa-45d9-93b6-4c37503a9950"},"description":"Stocktaking ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Stocktaking"},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":{"id":"4d0f479d-feab-489b-bc82-4a656902a20b","display_id":null,"status":0,"warehouse_id":"c52e67ad-d9d0-4276-abe4-e0c9f1f7d2da","stocktaking_by":"category_ids","stocktaking_by_value":["1315"],"stocktaking_at":"2023-10-11T08:24:56Z","progress":0,"note":"Kiểm hàng tồn","items":[{"id":"cb244b25-100e-4eaa-8b8f-0e72c5642631","variation_id":"27b3f94b-c945-4560-b694-a59526cae9a5","changed_quantity":12,"current_quantity":0,"note":null,"variation":{"id":"27b3f94b-c945-4560-b694-a59526cae9a5","display_id":"1","barcode":"12ml-6291107458328","product_id":"61894c4f-d759-45b7-acf7-ff5e88082016","retail_price":240000,"last_imported_price":20000,"weight":1000,"fields":[],"images":["https://statics.pancake.vn/user-content.pancake.vn/2023/4/12/05138842c6f772cde332fd8e1be1bff58245f19e.png"],"product":{"display_id":"12ml-6291107458328","name":"12ml Badee Al Oud","image":null,"note_product":""}},"inserted_at":"2024-12-02T10:42:39Z","updated_at":"2024-12-02T10:42:39Z"}],"shop_id":20,"creator_id":"cee3c05e-5f85-43c4-b27e-889b99c50097","inserted_at":"2023-10-11T08:25:18Z","updated_at":"2023-10-11T09:03:03Z","updated_status_at":"2023-10-11T08:25:18Z"}}}}}}}}},"put":{"summary":"Update stocktaking","x-summary-i18n":{"vie":"Cập nhật kiểm hàng"},"description":"Update stocktaking","tags":["Stocktaking"],"x-tags-i18n":{"vie":["Kiểm hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"STOCKTAKING_ID","in":"path","required":true,"schema":{"type":"string","example":"949f1396-f6fa-45d9-93b6-4c37503a9950"},"description":"Stocktaking ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["stocktaking"],"properties":{"stocktaking":{"type":"object","properties":{"items":{"type":"array","description":"List of products","items":{"type":"object","properties":{"id":{"type":"string","description":"Stocktaking item ID"},"variation_id":{"type":"string","description":"Variation ID"},"changed_quantity":{"type":"integer","description":"Changed quantity"},"note":{"type":"string","description":"Note"}}}},"note":{"type":"string","description":"Note"},"status":{"type":"integer","description":"Status"},"stocktaking_at":{"type":"string","format":"date-time","description":"Stocktaking at"},"stocktaking_by":{"type":"string","description":"Stocktaking by"},"stocktaking_by_value":{"type":"array","description":"Category ID / Supplier products ID / Brand ID","items":{"type":"string"}}}}},"example":{"stocktaking":{"items":[{"id":"cb244b25-100e-4eaa-8b8f-0e72c5642631","variation_id":"27b3f94b-c945-4560-b694-a59526cae9a5","changed_quantity":12,"note":null}],"note":"Kiểm hàng tồn","status":0,"stocktaking_at":"2023-10-11T10:38:34","stocktaking_by":"category_ids","stocktaking_by_value":["1315"]}}}}},"description":"Request body containing stocktaking information to update"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/lots":{"get":{"summary":"Lot list (expiry date)","x-summary-i18n":{"vie":"Danh sách lô hạn sử dụng"},"description":"Get the list of expiry-date lots of products (products with type `LOT`). Each lot has a lot code (`custom_id`), manufacturing date and expiry date, and is linked to one or more variations of the product via `lot_variations`.\n\nDatetime values (`expire_date`, `manufacturing_date`, ...) are in UTC.\n","tags":["Lot"],"x-tags-i18n":{"vie":["Lô hạn sử dụng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":20},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":30,"example":30},"description":"Page size"},{"name":"search","in":"query","required":false,"schema":{"type":"string","example":"LO-XA"},"description":"Search by lot code, product code/display ID or variation code/display ID"},{"name":"warehouse_ids[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"example":["20c3c8b1-d83d-47b1-8c81-d9156d881563"]},"description":"Filter lots that have stock records in these warehouses (lots without any stock record are still returned)"},{"name":"remain_quantity","in":"query","required":false,"schema":{"type":"string","example":"{\"type\":\"greaterOrEqual\",\"value\":1,\"warehouseId\":\"all\",\"isFilterTotal\":true}"},"description":"Filter by sellable quantity of the lot, JSON with fields:\n- `type`: `greaterOrEqual` | `smallerOrEqual` | `between`\n- `value`: quantity (for `greaterOrEqual` / `smallerOrEqual`)\n- `minValue`, `maxValue`: range (for `between`)\n- `warehouseId`: warehouse ID, `all` for all warehouses\n- `isFilterTotal`: `true` to compare the total across warehouses, otherwise compare each warehouse record\n"},{"name":"actual_remain_quantity","in":"query","required":false,"schema":{"type":"string","example":"{\"type\":\"between\",\"minValue\":1,\"maxValue\":100,\"warehouseId\":\"all\",\"isFilterTotal\":true}"},"description":"Filter by stock (quantity physically on hand) of the lot, same JSON format as `remain_quantity`"},{"name":"min_retail_price","in":"query","required":false,"schema":{"type":"integer","example":100000},"description":"Filter lots having a linked variation with retail price greater than or equal to this value"},{"name":"max_retail_price","in":"query","required":false,"schema":{"type":"integer","example":500000},"description":"Filter lots having a linked variation with retail price less than or equal to this value"},{"name":"expiry_date","in":"query","required":false,"schema":{"type":"string","example":"in_date"},"description":"Filter by expiry date, only lots that still have sellable stock (`remain_quantity > 0`) in at least one warehouse are returned:\n- `in_date`: not expired yet\n- `out_of_date`: already expired\n- JSON `{\"start_date\": <unix>, \"end_date\": <unix>}`: expiry date within the range (unix timestamp in seconds)\n"},{"name":"range","in":"query","required":false,"schema":{"type":"string","example":"{\"key\":\"expire\",\"since\":1759276800,\"until\":1767225599}"},"description":"Filter by time range, JSON `{\"key\": ..., \"since\": <unix>, \"until\": <unix>}` (unix timestamp in seconds, `until` defaults to now). `key`:\n- `inserted_at`: by created time (default)\n- `manufacturing`: by manufacturing date\n- `expire`: by expiry date\n"},{"name":"sort_field","in":"query","required":false,"schema":{"type":"string","example":"{\"field\":\"exp\",\"order\":\"ascend\"}"},"description":"Sort, JSON `{\"field\": ..., \"order\": \"ascend\" | \"descend\"}`. `field`: `mfg` (manufacturing date), `exp` (expiry date), `inserted_at` (created time), `updated_at` (updated time). Default: expiry date descending, then created time descending\n"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of lots","items":{"$ref":"#/components/schemas/LotProduct"}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"d0e4a4b0-0c6d-4dc1-8252-447bba021b3e","custom_id":"LO-XA","expire_date":"2027-10-11T17:00:00","manufacturing_date":"2026-10-11T17:00:00","inserted_at":"2026-10-12T07:35:10.000000","updated_at":"2026-10-12T07:35:10.000000","product":{"id":"da9b9e28-af65-4456-916e-ac8f8eb00334","name":"TEST6972#2","type":"LOT","image":null,"tags":[],"custom_id":"SP-L","display_id":13721,"bonus_products":[],"brand_id":null,"creator_id":"84616be7-7a6b-4f58-af37-2c64d9ee04a9","inserted_at":"2026-10-12T07:29:45","is_published":true,"is_sell_negative":null,"limit_quantity_to_warn":0,"limit_quantity_to_warn_by_warehouse":null,"manipulation_warehouses":[],"materials":[],"measure_group_id":null,"note":null,"note_product":"","product_attributes":[],"supplier_product_ids":[],"warning_by_variation":false,"categories":[]},"lot_variations":[{"id":"a560ac18-8d5b-46ef-82f6-bf1474ad1c8f","variation_id":"daf62728-ae6f-4354-94e4-4a12855c4293","inserted_at":"2026-10-12T07:35:10.000000","updated_at":"2026-10-12T07:35:10.000000"}]}],"page_number":1,"page_size":30,"total_entries":1,"total_pages":1}}}}}}}}},"/shops/{SHOP_ID}/promotion_advance":{"get":{"summary":"Get promotion product list","x-summary-i18n":{"vie":"Danh sách khuyến mãi"},"description":"Get list of promotions","tags":["Promotion"],"x-tags-i18n":{"vie":["Khuyến mãi"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":10,"example":10},"description":"Page size"},{"name":"textSearch","in":"query","required":false,"schema":{"type":"string","example":"áo sơ mi"},"description":"Text search"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of promotions","items":{"$ref":"#/components/schemas/Promotion"}},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"260a0d45-ba88-457b-8b31-afa3fda0ce0e","display_id":50,"name":"km 345","type":"discount_by_product","start_time":"2022-03-10T05:04:11Z","end_time":"2022-03-11T05:04:13Z","warehouse_ids":[],"customer_tags":[],"order_sources":[],"group_name":"Nhóm 1","is_activated":true,"is_variation":true,"is_used":null,"is_free_shipping":false,"is_discount_in_birthday_customer":false,"coupon_info":{"discount":0,"is_percent":false},"promo_code_info":{"discount":0,"is_percent":false,"max_discount_by_percent":0},"discount_by_quantity":1,"items":[{"id":"bd11e48a-6fec-4e3a-a1b7-8ef834a98dae","promotion_advance_id":"260a0d45-ba88-457b-8b31-afa3fda0ce0e","shop_id":3,"product_id":null,"variation_id":"2f3aea54-5c0c-44db-9f9b-2c987c298795","category_id":null,"product":null,"variation":{"id":"2f3aea54-5c0c-44db-9f9b-2c987c298795","display_id":"SB21-M-DEN","product_id":"d6d13d0b-320e-4651-a368-de2c9e30ae66","retail_price":250000,"retail_price_after_discount":238000},"level_info":[{"discount":30000,"is_percent":false,"from_quantity":1,"to_quantity":4}],"fixed_prices":0,"coupon_item_info":{"discount":0,"is_percent":false},"limited_quantity":0,"limited_quantity_used":0,"attachment_product_info":[],"discount_info_by_attachment_product":null}],"bonus_items":[],"total_quantity_bonus":0,"arr_level_promotion":[],"level_order_prices":[],"priority_level":null,"type_employee":"all","post_ids":[],"shop_id":3,"creator_id":"4eab0efc-2994-4b96-acf0-e4c847668555","inserted_at":"2022-03-10T05:04:33Z","updated_at":"2022-04-08T08:14:58Z"}]}}}}}}}},"post":{"summary":"Create promotion product","x-summary-i18n":{"vie":"Tạo khuyến mãi"},"description":"Create promotion","tags":["Promotion"],"x-tags-i18n":{"vie":["Khuyến mãi"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["promotion_advance"],"properties":{"promotion_advance":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"Promotion name"},"start_time":{"type":"integer","description":"Start time"},"end_time":{"type":"integer","description":"End time"},"warehouse_ids":{"type":"array","description":"Warehouse IDs","items":{"type":"string"}},"customer_tags":{"type":"array","description":"Customer tags","items":{"type":"string"}},"order_sources":{"type":"array","description":"Order sources","items":{"type":"object"}},"type":{"type":"string","description":"Promotion type","enum":["discount_by_product","discount_by_order_price","fixed_prices","coupon","double_reward_point","discount_by_coupon_id","discount_by_attachment_products"],"x-enum-descriptions":{"discount_by_product":"Giảm giá theo số lượng sản phẩm","discount_by_order_price":"Khuyến mãi theo giá trị đơn hàng","fixed_prices":"Đồng giá","coupon":"Khuyến mãi chung","double_reward_point":"Khuyến mãi x2 điểm thưởng","discount_by_coupon_id":"Mã khuyến mãi (voucher)","discount_by_attachment_products":"Khuyến mãi sản phẩm theo sản phẩm đính kèm"}},"group_name":{"type":"string","description":"Promotion group"},"is_activated":{"type":"boolean","description":"Is activated"},"is_variation":{"type":"boolean","description":"Is variation"},"coupon_info":{"type":"object","description":"Coupon information","properties":{"discount":{"type":"integer","description":"Discount"},"is_percent":{"type":"boolean","description":"Is percent"},"is_categories":{"type":"boolean","description":"Is categories"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}}}},"promo_code_info":{"type":"object","description":"Promotion code information","properties":{"discount":{"type":"integer","description":"Discount"},"is_percent":{"type":"boolean","description":"Is percent"},"max_discount_by_percent":{"type":"integer","description":"Maximum discount by percent"}}},"items":{"type":"array","description":"Promotion items","items":{"type":"object","properties":{"variation_id":{"type":"string","description":"Variation ID"},"product_id":{"type":"string","nullable":true,"description":"Product ID"},"category_id":{"type":"string","nullable":true,"description":"Category ID"},"category":{"type":"object","description":"Category"},"level_info":{"type":"array","description":"Level info","items":{"type":"object","properties":{"from_quantity":{"type":"integer","description":"From quantity"},"to_quantity":{"type":"integer","description":"To quantity"},"discount":{"type":"integer","description":"Discount"},"is_percent":{"type":"boolean","description":"Is percent"}}}},"fixed_prices":{"type":"integer","description":"Fixed prices"},"coupon_item_info":{"type":"object","description":"Coupon item info","properties":{"discount":{"type":"integer","description":"Discount"},"is_percent":{"type":"boolean","description":"Is percent"},"max_discount_by_percent":{"type":"integer","description":"Maximum discount by percent"}}}}}},"is_free_shipping":{"type":"boolean","description":"Is free shipping"},"discount_by_quantity":{"type":"integer","description":"Discount by quantity"},"bonus_items":{"type":"array","description":"Bonus items","items":{"type":"object"}},"is_discount_in_birthday_customer":{"type":"boolean","description":"Is discount in birthday customer"},"arr_level_promotion":{"type":"array","description":"Level promotion array","items":{"type":"object"}},"total_quantity_bonus":{"type":"integer","description":"Total quantity bonus"},"priority_level":{"type":"integer","description":"Priority level"},"type_employee":{"type":"string","description":"Type employee"},"free_products":{"type":"array","description":"Free products","items":{"type":"object","properties":{"is_active":{"type":"boolean","description":"Is active"},"products_count":{"type":"integer","description":"Products count"},"count_free_products":{"type":"integer","description":"Count free products"},"type":{"type":"string","description":"Type"}}}}}}}}}},"description":"Request body containing promotion information to create"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/promotion_advance/{PROMOTION_ID}":{"put":{"summary":"Update promotion product","x-summary-i18n":{"vie":"Cập nhật khuyến mãi"},"description":"Update promotion","tags":["Promotion"],"x-tags-i18n":{"vie":["Khuyến mãi"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"PROMOTION_ID","in":"path","required":true,"schema":{"type":"string","example":"949f1396-f6fa-45d9-93b6-4c37503a9950"},"description":"Promotion ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["promotion_advance"],"properties":{"promotion_advance":{"$ref":"#/components/schemas/Promotion"}}}}},"description":"Request body containing promotion information to update"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/promotion_advance/delete_multi":{"post":{"summary":"Activate/Deactivate/Delete promotions","x-summary-i18n":{"vie":"Kích hoạt/Vô hiệu hóa/Xóa khuyến mãi"},"description":"Activate, deactivate or delete multiple promotions","tags":["Promotion"],"x-tags-i18n":{"vie":["Khuyến mãi"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ids","type_action"],"properties":{"ids":{"type":"array","description":"Promotion IDs","items":{"type":"string"}},"type_action":{"type":"string","description":"Action type","enum":["DEACTIVE_PROMOTIONS","ACTIVE_PROMOTIONS","DELETE_PROMOTIONS"],"x-enum-descriptions":["Deactivate promotions","Activate promotions","Delete promotions"]}},"example":{"ids":["0fe988a1-26a5-4772-b4b6-a9c17c9f40cd"],"type_action":"DEACTIVE_PROMOTIONS"}}}},"description":"Request body containing promotion IDs to delete"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/vouchers":{"get":{"summary":"List of voucher","x-summary-i18n":{"vie":"Danh sách phiếu giảm giá"},"description":"Get list of vouchers","tags":["Voucher"],"x-tags-i18n":{"vie":["Mã giảm giá"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of vouchers","items":{"$ref":"#/components/schemas/Voucher"}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"9589b791-013f-4a5b-b8d1-164fad73d84e","display_id":7,"name":"d5IvGYtj","type":"discount_by_coupon_id","start_time":"2021-12-09T04:27:23Z","end_time":"2021-12-10T04:27:26Z","promo_code_info":{"discount":4534,"is_percent":false,"max_discount_by_percent":0},"is_free_shipping":false,"is_activated":true,"is_used":null,"customer_tags":["Tiềm năng"],"shop_id":3,"creator_id":"d6e6a545-f102-439e-9943-8ac8369f9735","inserted_at":"2021-12-06T04:27:40Z","updated_at":"2021-12-10T02:26:59Z"}]}}}}}}}},"post":{"summary":"Create voucher","x-summary-i18n":{"vie":"Tạo phiếu giảm giá"},"description":"Create voucher","tags":["Voucher"],"x-tags-i18n":{"vie":["Mã giảm giá"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","promo_code_info","start_time","end_time"],"properties":{"name":{"type":"string","description":"Voucher name"},"promo_code_info":{"type":"object","description":"Voucher promo code information","required":["discount","is_percent"],"properties":{"discount":{"type":"integer","description":"Discount value"},"is_percent":{"type":"boolean","description":"Is percent"},"max_discount_by_percent":{"type":"integer","description":"Maximum discount by percent"}}},"is_free_shipping":{"type":"boolean","description":"Is free shipping"},"is_activated":{"type":"boolean","description":"Is activated"},"customer_tags":{"type":"array","description":"Customer tags","items":{"type":"string"}},"start_time":{"type":"string","format":"date-time","description":"Voucher start time"},"end_time":{"type":"string","format":"date-time","description":"Voucher end time"}},"example":{"name":"test_voucher_5","promo_code_info":{"discount":53635,"is_percent":false},"is_free_shipping":false,"is_activated":true,"customer_tags":["New tag"],"start_time":"2021-12-09T04:27:23","end_time":"2021-12-10T04:27:26"}}}},"description":"Request body containing voucher information to create"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/vouchers/{VOUCHER_ID}":{"get":{"summary":"Get voucher info","x-summary-i18n":{"vie":"Lấy thông tin phiếu giảm giá"},"description":"Get voucher information","tags":["Voucher"],"x-tags-i18n":{"vie":["Mã giảm giá"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"VOUCHER_ID","in":"path","required":true,"schema":{"type":"string","example":"949f1396-f6fa-45d9-93b6-4c37503a9950"},"description":"Voucher ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Voucher"},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":{"id":"9589b791-013f-4a5b-b8d1-164fad73d84e","display_id":7,"name":"d5IvGYtj","type":"discount_by_coupon_id","start_time":"2021-12-09T04:27:23Z","end_time":"2021-12-10T04:27:26Z","promo_code_info":{"discount":4534,"is_percent":false,"max_discount_by_percent":0},"is_free_shipping":false,"is_activated":true,"is_used":null,"customer_tags":["Tiềm năng","Hay hoàn"],"shop_id":3,"creator_id":"d6e6a545-f102-439e-9943-8ac8369f9735","inserted_at":"2021-12-06T04:27:40Z","updated_at":"2021-12-06T04:27:40Z"}}}}}}}}}},"/shops/{SHOP_ID}/combo_products":{"get":{"summary":"Combo list","x-summary-i18n":{"vie":"Danh sách combo"},"description":"Get list of combo products","tags":["Combo"],"x-tags-i18n":{"vie":["Combo"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of combo products","items":{"type":"object","description":"Combo product information"}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessEmptyDataResponse"}}}}}}},"post":{"summary":"Create combo","x-summary-i18n":{"vie":"Tạo combo"},"description":"Create combo product","tags":["Combo"],"x-tags-i18n":{"vie":["Combo"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["combo_product"],"properties":{"combo_product":{"type":"object","required":["name","order_types","is_value_combo","is_use_percent","is_variation"],"properties":{"name":{"type":"string","description":"Combo name"},"currency":{"type":"string","description":"Currency"},"start_time":{"type":"integer","description":"Start time"},"end_time":{"type":"integer","description":"End time"},"order_sources":{"type":"array","description":"Order sources","items":{"type":"object"}},"order_types":{"type":"array","description":"Order types","items":{"type":"string","enum":["all","online","offline"]}},"livestream_manager_ids":{"type":"array","description":"Livestream manager IDs","items":{"type":"string"}},"is_value_combo":{"type":"boolean","description":"Discount type (true: combo value / false: discount combo)"},"value_combo":{"type":"integer","description":"Combo value"},"is_use_percent":{"type":"boolean","description":"Discount by percent"},"discount_amount":{"type":"integer","description":"Discount value"},"discount_by_percent":{"type":"integer","description":"Percentage discount"},"max_discount_by_percent":{"type":"integer","description":"Maximum discount value"},"is_free_shipping":{"type":"boolean","description":"Is free shipping"},"bonus_products":{"type":"array","description":"Bonus products","items":{"type":"object"}},"is_variation":{"type":"boolean","description":"Apply to variation (true) / Apply to product (false)"},"variations":{"type":"array","description":"Applicable variation information","items":{"type":"object","required":["count","product_id"],"properties":{"count":{"type":"integer","description":"Quantity"},"product_id":{"type":"string","description":"Product ID"},"variation_id":{"type":"string","description":"Variation ID"}}}},"is_categories":{"type":"boolean","description":"Apply to category"},"categories":{"type":"array","description":"Applicable categories","items":{"type":"object","properties":{"id":{"type":"string","description":"Category ID"},"quantity":{"type":"integer","description":"Quantity"}}}}}}},"example":{"combo_product":{"name":"Combo 1","currency":"VND","start_time":1745946000,"end_time":1746637199,"order_sources":[{"key":"-3","account":null},{"key":"-1","account":"406"}],"order_types":["all"],"is_value_combo":false,"value_combo":0,"is_use_percent":false,"discount_amount":100000,"discount_by_percent":5,"max_discount_by_percent":100000,"is_free_shipping":false,"is_variation":true,"variations":[{"count":1,"product_id":"0cffd0a6-0a06-4471-a139-cf81aa1fcc6f","variation_id":"821e1337-a04b-473a-b07c-805a572c465a"}]}}}}},"description":"Request body containing combo product information to create"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}},"/shops/{SHOP_ID}/analytics/sale":{"get":{"summary":"Order statistics","x-summary-i18n":{"vie":"Thống kê đơn hàng"},"description":"Get order statistics","tags":["Statistics"],"x-tags-i18n":{"vie":["Thống kê"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time","example":"2024-01-01T00:00:00Z"},"description":"Start date"},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date-time","example":"2024-12-31T23:59:59Z"},"description":"End date"},{"name":"split_by[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["Time.hour","Time.day","Time.month","Time.year","Order.source","Order.order_sources","Order.status","Order.warehouse_id","Order.post_id","Order.partner_id","Order.marketplace_id","Order.country_code","Order.province_id","Order.district_id","Order.commune_id","Order.region_filter","Order.tag","Order.is_wholesale","Order.is_livestream","Order.livestream_manager_ids","Order.total_price","Order.ads_or_normal","Order.ad_account_id","Order.ad_id","User.id","User.sale_group","User.department_id","Customer.id","Customer.level_id","Customer.new","Variation.id","Variation.product_id","Variation.category","Variation.supplier","Variation.brand_id","Variation.tag","Variation.price_range","Variation.quantity_range","Variation.upsale","Variation.quantity","UTM.p_utm_source","UTM.p_utm_campaign","UTM.p_utm_medium","UTM.p_utm_term","UTM.p_utm_content","Promotion.default","Promotion.advance","Promotion.combo","Ads.ad_id","Ads.ad_set_id","Ads.ad_campaign_id"]},"example":["Time.day"]},"description":"Group statistics by one or more dimensions. Each value is a `<Table>.<field>` key.\n- `Time.hour` / `Time.day` / `Time.month` / `Time.year` — by date bucket\n- `Order.source` / `Order.order_sources` — by order source / account\n- `Order.status` — by order status code\n- `Order.warehouse_id` — by warehouse\n- `Order.post_id` — by Facebook post\n- `Order.partner_id` — by shipping carrier\n- `Order.marketplace_id` — by e-commerce marketplace\n- `Order.country_code` / `Order.province_id` / `Order.district_id` / `Order.commune_id` / `Order.region_filter` — by shipping geography\n- `Order.tag` — by order tag\n- `Order.is_wholesale` / `Order.is_livestream` — wholesale / livestream flag\n- `Order.livestream_manager_ids` — by livestream manager\n- `Order.total_price` — by order total price bucket\n- `Order.ads_or_normal` / `Order.ad_account_id` / `Order.ad_id` — ad partitioning\n- `User.id` / `User.sale_group` / `User.department_id` — by staff / sale group / department\n- `Customer.id` / `Customer.level_id` / `Customer.new` — by customer / level / new vs. old\n- `Variation.id` / `Variation.product_id` — by variation / product\n- `Variation.category` / `Variation.supplier` / `Variation.brand_id` / `Variation.tag` — by product taxonomy\n- `Variation.price_range` / `Variation.quantity_range` — by product price/quantity bucket\n- `Variation.upsale` / `Variation.quantity` — upsell flag / sold quantity\n- `UTM.p_utm_source` / `UTM.p_utm_campaign` / `UTM.p_utm_medium` / `UTM.p_utm_term` / `UTM.p_utm_content` — by UTM tag\n- `Promotion.default` / `Promotion.advance` / `Promotion.combo` — by promotion / combo\n- `Ads.ad_id` / `Ads.ad_set_id` / `Ads.ad_campaign_id` — by ad / ad set / campaign\n"},{"name":"filter","in":"query","required":false,"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"example":{"Variation.product_id":["4a6fc152-5989-4202-83d4-a11a2ab28078"],"Order.status":["3"]}},"description":"Filter applied to the order set. Object keyed by `<Table>.<field>`; each value is an array of strings.\nAppend `_exclude` to a key to negate it (e.g. `Order.status_exclude`, `Variation.category_exclude`).\nAppend `_and` to AND-combine multi-valued list filters (e.g. `Variation.tags_and`).\nCommon keys:\n- `Variation.id` / `Variation.product_id` — by variation / product\n- `Variation.category` / `Variation.supplier` / `Variation.brand_id` / `Variation.brand` — by product taxonomy\n- `Variation.tag` / `Variation.tags` / `Variation.attribute` — by product tag / attribute\n- `Variation.price_range` / `Variation.quantity_range` / `Variation.quantity` — by product price/quantity\n- `Variation.upsale` / `Variation.one_time_product` / `Variation.is_bonus_product` / `Variation.product_price_of_zero` / `Variation.unlink_ecommerce` — flag filters\n- `Order.source` / `Order.source_exclude` / `Order.order_sources` — order source\n- `Order.status` — order status code\n- `Order.warehouse_id` / `Order.post_id` / `Order.partner_id` / `Order.shop_partner_id` / `Order.marketplace_id` — operational filters\n- `Order.country_code` / `Order.province_id` / `Order.district_id` / `Order.commune_id` / `Order.region_filter` / `Order.region_filter_phil` — shipping geography\n- `Order.tag` / `Order.is_wholesale` / `Order.is_livestream` / `Order.received_at_shop` / `Order.is_upsale_order` — order flags\n- `Order.total_price` / `Order.revenue` — by total/revenue bucket\n- `Order.ad_id` / `Order.ads_source` / `Order.ad_account_id` / `Order.ads_or_normal` — ads filters\n- `Order.order_currency` — order currency\n- `Order.id` / `Order.project` — by order id / project\n- `Order.p_utm_source` / `Order.p_utm_campaign` / `Order.p_utm_medium` / `Order.p_utm_term` / `Order.p_utm_content` / `Order.utm_affiliate` / `Order.link` — UTM filters\n- `Order.instant` / `Order.N24H` / `Order.GSGN` — service partner filters\n- `Order.livestream_manager_id` / `Order.livestream_manager_ids` — livestream manager\n- `User.id` / `User.sale_group` / `User.department_id` / `User.pke_mkter` / `User.assigning_seller_id` / `User.assigning_care_id` / `User.item_assign_seller_id` — staff filters\n- `Customer.id` / `Customer.level_id` / `Customer.gender` / `Customer.tag` / `Customer.conversation_tags` / `Customer.new` / `Customer.referral_code` — customer filters\n- `Promotion.default` / `Promotion.advance` / `Promotion.id` / `Promotion.combo` — promotion filters\n"},{"name":"success_status","in":"query","required":false,"schema":{"type":"string","example":"send_to_partner"},"description":"Success status"},{"name":"success_record","in":"query","required":false,"schema":{"type":"string","example":"inserted_at"},"description":"Success record"},{"name":"user_type","in":"query","required":false,"schema":{"type":"string","example":"create"},"description":"User type"},{"name":"returned_record","in":"query","required":false,"schema":{"type":"string","example":"inserted_at"},"description":"Returned record"},{"name":"select_fields[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"example":["cod","price","order_count"]},"description":"Select fields"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"Statistics data","items":{"type":"object","description":"Statistics item. Fields depend on split_by and select_fields parameters","additionalProperties":true,"properties":{"Time.day":{"type":"string","description":"Statistic day"},"returned":{"type":"object","nullable":true,"description":"Returned order statistics","additionalProperties":true,"properties":{"cod":{"type":"integer","description":"COD amount"},"discount":{"type":"integer","description":"Discount total"},"order_count":{"type":"integer","description":"Order count"},"price":{"type":"integer","description":"Goods price"},"avg_price":{"type":"integer","description":"Average price"},"product_count":{"type":"integer","description":"Product count"},"shipping_fee":{"type":"integer","description":"Shipping fee"}}},"success":{"type":"object","description":"Success order statistics","additionalProperties":true,"properties":{"cod":{"type":"integer","description":"COD amount"},"discount":{"type":"integer","description":"Discount total"},"order_count":{"type":"integer","description":"Order count"},"price":{"type":"integer","description":"Goods price"},"avg_price":{"type":"integer","description":"Average price"},"product_count":{"type":"integer","description":"Product count"},"shipping_fee":{"type":"integer","description":"Shipping fee"}}}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"Time.day":"2020-07-22","returned":null,"success":{"cod":1710000,"discount":0,"order_count":3,"price":1800000,"product_count":18,"shipping_fee":0,"custom_formula_d6ae-ad02-be3d-b26e-3f65-d497-33c4":1000000}},{"Time.day":"2020-07-27","returned":null,"success":{"cod":570000,"discount":0,"order_count":1,"price":600000,"avg_price":600000,"product_count":6,"shipping_fee":0,"custom_formula_d6ae-ad02-be3d-b26e-3f65-d497-33c4":1000000}},{"Time.day":"2020-07-28","returned":null,"success":{"cod":5130000,"discount":0,"order_count":9,"price":5400000,"avg_price":600000,"product_count":54,"shipping_fee":0,"custom_formula_d6ae-ad02-be3d-b26e-3f65-d497-33c4":1200000}},{"Time.day":"2020-07-30","returned":null,"success":{"cod":570000,"discount":0,"order_count":1,"price":600000,"avg_price":600000,"product_count":6,"shipping_fee":0,"custom_formula_d6ae-ad02-be3d-b26e-3f65-d497-33c4":1200000}}]}}}}}}}}},"/shops/{SHOP_ID}/analytics/get_list_formula":{"get":{"summary":"List of customized formulas","x-summary-i18n":{"vie":"Danh sách công thức tùy chỉnh"},"description":"Get list of customized formulas","tags":["Statistics"],"x-tags-i18n":{"vie":["Thống kê"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of formulas","items":{"type":"object","properties":{"formula":{"type":"string","description":"Formula"},"id":{"type":"string","description":"Formula ID"},"name":{"type":"string","description":"Formula name"},"unit":{"type":"string","description":"Unit"}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"formula":"{price} - {shipping_fee}","id":"0ea7-bc72-ae51-0769-a7c9-ca34-fff6","name":"tien hang - phi ship","unit":"currency"},{"formula":"{revenue} + {transfer_money}","id":"3db3-72a7-c426-066a-4eed-a63b-be49","name":"doanh thu + ck$","unit":"currency"}]}}}}}}}}},"/shops/{SHOP_ID}/analytics/get_analytic_fields":{"get":{"summary":"List of analytic fields","x-summary-i18n":{"vie":"Danh sách số liệu mặc định"},"description":"Get list of analytic fields","tags":["Statistics"],"x-tags-i18n":{"vie":["Thống kê"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of analytic fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Analytic field ID"},"name":{"type":"string","description":"Analytic field name (localized via Accept-Language)"},"description":{"type":"string","description":"Optional explanation of the field (localized via Accept-Language). Present only for fields that have a tooltip."}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"price","name":"Tiền hàng"},{"id":"avg_price","name":"Giá bán trung bình"},{"id":"shipping_fee","name":"Phí VC thu của khách","description":"Tiền vận chuyển thu của khách."},{"id":"discount","name":"Chiết khấu","description":"Tổng số tiền giảm giá trên từng sản phẩm."},{"id":"product_count","name":"SL bán thực","description":"Hàng bán ra đã trừ SL hoàn/đổi trả"},{"id":"close_rate","name":"Tỷ lệ chốt","description":"Số đơn chốt / (Tổng số đơn - SL đơn xoá)."},{"id":"commissions","name":"Hoa hồng","description":"Hoa hồng cho nhân viên, có thể cài đặt trong phần cấu hình."}]}}}}}}}}},"/shops/{SHOP_ID}/statistic_custom/folders":{"get":{"summary":"List of custom statistic folders","x-summary-i18n":{"vie":"Danh sách thư mục báo cáo tùy chỉnh"},"description":"Get list of custom statistic folders and their report items (folder_items). Each folder groups related custom reports configured for the shop (e.g. revenue, orders, products, finance, debts).","tags":["Statistics"],"x-tags-i18n":{"vie":["Thống kê"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"},"folders":{"type":"array","description":"List of custom statistic folders","items":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"Folder name (system key)"},"label":{"type":"string","description":"Folder display label"},"order":{"type":"integer","description":"Display order"},"shop_id":{"type":"integer","description":"Shop ID"},"creator_id":{"type":"string","nullable":true,"description":"Creator user ID (null for system default folders)"},"last_editor_id":{"type":"string","nullable":true,"description":"Last editor user ID"},"can_remove":{"type":"boolean","description":"Whether the folder can be removed"},"is_removed":{"type":"boolean","nullable":true,"description":"Whether the folder is removed"},"setting":{"type":"object","nullable":true,"additionalProperties":true,"description":"Folder-level settings"},"total_price_ranges":{"type":"array","nullable":true,"items":{"type":"object","additionalProperties":true},"description":"Price range buckets configured for the folder"},"inserted_at":{"type":"string","format":"date-time","description":"Created at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"folder_items":{"type":"array","description":"List of custom report items in the folder","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string","description":"Report item ID"},"name":{"type":"string","description":"Report name (system key or custom title)"},"label":{"type":"string","nullable":true,"description":"Report display label"},"description":{"type":"string","nullable":true,"description":"Report description"},"folder_name":{"type":"string","description":"Parent folder system name"},"parent_id":{"type":"string","nullable":true,"description":"Parent report item ID (for nested items)"},"order":{"type":"integer","description":"Display order within the folder"},"shop_id":{"type":"integer","description":"Shop ID"},"creator_id":{"type":"string","nullable":true,"description":"Creator user ID"},"last_editor_id":{"type":"string","nullable":true,"description":"Last editor user ID"},"can_remove":{"type":"boolean","description":"Whether the report can be removed"},"is_removed":{"type":"boolean","nullable":true,"description":"Whether the report is removed"},"attributes":{"type":"array","nullable":true,"items":{"type":"string"},"description":"Group-by attributes (e.g. \"Time.day\", \"Variation.product_id\", \"Order.source\")"},"fields":{"type":"array","items":{"type":"string"},"description":"Selected metric fields (e.g. \"price\", \"revenue\", \"profit\")"},"filter":{"nullable":true,"description":"Report filter. Either an array of filter conditions or an object; each entry is keyed by attribute name with the filter value","oneOf":[{"type":"array","items":{"type":"object","additionalProperties":true}},{"type":"object","additionalProperties":true}]},"children":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Nested report items"},"charts":{"type":"array","nullable":true,"description":"Chart configurations rendered for this report","items":{"type":"object","additionalProperties":true,"properties":{"field":{"type":"string","description":"Metric field plotted by the chart"},"type":{"type":"string","description":"Chart type (e.g. \"bar-chart\", \"line-chart\")"},"top":{"type":"string","description":"Top-N filter (e.g. \"all\", \"10\")"},"width":{"type":"integer","description":"Chart width in percent"}}}},"compare_ranges":{"type":"object","additionalProperties":true,"description":"Comparison range configuration","properties":{"chart":{"type":"string","description":"Comparison chart type"},"field":{"type":"string","nullable":true,"description":"Field to compare"},"ranges":{"type":"array","description":"Comparison ranges","items":{"type":"object","properties":{"range":{"type":"string","description":"Range value"}}}}}},"fill_color":{"type":"boolean","description":"Whether rows are color-filled in the report"},"setting":{"type":"object","additionalProperties":true,"description":"Per-report setting. Common keys:\n- `success_record` ('inserted_at' | 'updated_at' | 'success_record'): when revenue is counted\n- `success_status` (integer or string, e.g. 0, 1, 3, 'send_to_partner'): order status that counts as success\n- `returned_record` ('inserted_at' | 'updated_at' | 'success_record'): when returns are deducted\n- `returned_status` (integer): order status counted as returned\n- `user_type` ('create' | 'update' | 'assign' | 'care' | 'marketer'): how to attribute orders to staff\n- `product_price_range` (array): product price buckets\n"},"sort_by_field":{"nullable":true,"description":"Sort configuration. Either a single sort object `{columnKey, field, order}`,\na multi-sort wrapper `{multi: [...]}`, or an empty object/null when not set.\n","oneOf":[{"type":"object","additionalProperties":true,"properties":{"columnKey":{"type":"string","description":"Column key being sorted"},"field":{"type":"string","description":"Field being sorted"},"order":{"type":"string","enum":["ascend","descend"],"description":"Sort direction"},"multi":{"type":"array","description":"Multi-column sort definitions","items":{"type":"object","properties":{"columnKey":{"type":"string"},"field":{"type":"string"},"order":{"type":"string","enum":["ascend","descend"]}}}}}}]},"time_range":{"type":"array","description":"Time range for the report. Values may be:\n- Number of days as string (e.g. \"1\", \"7\", \"30\", \"90\")\n- Keyword (e.g. \"monthAgo\")\n- Two ISO date-time strings for an explicit range\n- Empty array for no preset\n","items":{"type":"string"}},"users_can_see":{"type":"array","nullable":true,"items":{"type":"string"},"description":"User IDs allowed to view this report (null means no restriction)"},"inserted_at":{"type":"string","format":"date-time","description":"Created at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}}}}}}},"examples":{"default":{"value":{"success":true,"folders":[{"name":"OtherReports","label":"Báo cáo khác","order":-1,"shop_id":4,"creator_id":null,"last_editor_id":null,"can_remove":false,"is_removed":null,"setting":null,"total_price_ranges":null,"inserted_at":"2024-02-26T08:21:01","updated_at":"2024-02-26T08:21:01","folder_items":[{"id":"9d80f8b9-1c68-4026-81e6-70ed2381d360","name":"pages.shop.statistic.salesStatistics","label":"Doanh số","description":null,"folder_name":"employee","parent_id":null,"order":0,"shop_id":4,"creator_id":null,"last_editor_id":null,"can_remove":false,"is_removed":null,"attributes":null,"fields":["total_order_count","order_count","price","shipping_fee","discount","capital","product_count"],"filter":null,"children":[],"charts":null,"compare_ranges":{"chart":"bar-chart","field":"product_count","ranges":[{"range":"7"},{"range":"-7"}]},"fill_color":false,"setting":{"returned_record":"success_record","success_record":"inserted_at","success_status":0,"user_type":"assign"},"sort_by_field":null,"time_range":["90"],"users_can_see":null,"inserted_at":"2024-02-26T08:21:01","updated_at":"2024-02-26T08:21:01"}]},{"name":"Revenue","label":"Báo cáo doanh thu","order":1,"shop_id":4,"creator_id":null,"last_editor_id":null,"can_remove":false,"is_removed":null,"setting":null,"total_price_ranges":null,"inserted_at":"2023-09-20T03:01:25","updated_at":"2023-09-20T03:01:25","folder_items":[{"id":"9783d2e9-d973-4f6f-a735-f5883f4e678f","name":"commons.time","label":"Thời gian","description":null,"folder_name":"Revenue","parent_id":null,"order":0,"shop_id":4,"creator_id":null,"last_editor_id":null,"can_remove":false,"is_removed":null,"attributes":["Variation.product_id"],"fields":["success_order_count","returned_order_count","price","sales","revenue","capital","profit"],"filter":[],"children":[],"charts":[{"field":"success_order_count","top":"all","type":"bar-chart","width":100}],"compare_ranges":{"chart":"bar-chart","field":"profit","ranges":[{"range":"7"},{"range":"-7"}]},"fill_color":false,"setting":{"returned_record":"success_record","success_record":"updated_at","success_status":1,"user_type":"update"},"sort_by_field":{"multi":[{"columnKey":"product_count","field":"product_count","order":"descend"}]},"time_range":["30"],"users_can_see":null,"inserted_at":"2023-09-20T03:01:25","updated_at":"2026-05-05T04:33:58"}]}]}}}}}}}}},"/shops/{SHOP_ID}/inventory_analytics/inventory":{"get":{"summary":"Statistics by variant","x-summary-i18n":{"vie":"Báo cáo xuất nhập kho theo mẫu mã"},"description":"Get inventory statistics grouped by product variant","tags":["Statistics inventory analytics"],"x-tags-i18n":{"vie":["Báo cáo xuất nhập kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","example":30},"description":"Page size"},{"name":"start_date","in":"query","required":true,"schema":{"type":"integer","format":"unix timestamp","example":1760720400},"description":"Start date (unix timestamp)"},{"name":"end_date","in":"query","required":true,"schema":{"type":"integer","format":"unix timestamp","example":1763398799},"description":"End date (unix timestamp)"},{"name":"type","in":"query","required":true,"schema":{"type":"string","enum":["actual","remain"],"x-enum-descriptions":["inventory","Remain quantity"],"example":"actual"},"description":"Statistics by"},{"$ref":"#/components/parameters/InventoryAnalyticsWarehouseIds"},{"$ref":"#/components/parameters/InventoryAnalyticsVariationIds"},{"$ref":"#/components/parameters/InventoryAnalyticsIsExcludeVariation"},{"$ref":"#/components/parameters/InventoryAnalyticsProductIds"},{"$ref":"#/components/parameters/InventoryAnalyticsIsExcludeProduct"},{"$ref":"#/components/parameters/InventoryAnalyticsCategoryIds"},{"$ref":"#/components/parameters/InventoryAnalyticsBrandIds"},{"$ref":"#/components/parameters/InventoryAnalyticsProductTags"},{"$ref":"#/components/parameters/InventoryAnalyticsFilterExcludeTag"},{"$ref":"#/components/parameters/InventoryAnalyticsSupplierProductIds"},{"$ref":"#/components/parameters/InventoryAnalyticsIsFilterSupplierByOr"},{"$ref":"#/components/parameters/InventoryAnalyticsManipulationWarehouseIds"},{"$ref":"#/components/parameters/InventoryAnalyticsIsFilterManipulationWarehouseByOr"},{"$ref":"#/components/parameters/InventoryAnalyticsDataSort"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"Statistics by variant","items":{"type":"object","properties":{"id":{"type":"string","description":"Variant ID"},"begin_inventory":{"type":"number","format":"float","description":"Beginning inventory quantity"},"begin_inventory_value":{"type":"integer","description":"Beginning inventory value"},"end_inventory":{"type":"number","format":"float","description":"Ending inventory quantity"},"end_inventory_value":{"type":"integer","description":"Ending inventory value"},"purchase_import":{"type":"number","format":"float","description":"Purchase import quantity"},"return_import":{"type":"number","format":"float","description":"Return import quantity"},"stocktaking_import":{"type":"number","format":"float","description":"Stocktaking import quantity"},"transfer_import":{"type":"number","format":"float","description":"Transfer import quantity"},"total_import":{"type":"number","format":"float","description":"Total import quantity"},"total_import_value":{"type":"integer","description":"Total import value"},"purchase_export":{"type":"number","format":"float","description":"Purchase export quantity"},"transfer_export":{"type":"number","format":"float","description":"Transfer export quantity"},"sell_export":{"type":"number","format":"float","description":"Sell export quantity"},"stocktaking_export":{"type":"number","format":"float","description":"Stocktaking export quantity"},"total_export":{"type":"number","format":"float","description":"Total export quantity"},"total_export_value":{"type":"integer","description":"Total export value"},"variation":{"type":"object","description":"Variant information","properties":{"id":{"type":"string","description":"Variant ID"},"product_id":{"type":"string","description":"Product ID"},"shop_id":{"type":"integer","description":"Shop ID"},"custom_id":{"type":"string","description":"Custom ID"},"display_id":{"type":"integer","description":"Display ID"},"barcode":{"type":"string","nullable":true,"description":"Barcode"},"images":{"type":"array","description":"Variant images","items":{"type":"string"}},"fields":{"type":"array","description":"Variant fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"},"keyValue":{"type":"string","description":"Key value"}}}},"product":{"type":"object","description":"Product information","properties":{"id":{"type":"string","description":"Product ID"},"name":{"type":"string","description":"Product name"},"custom_id":{"type":"string","description":"Custom ID"},"display_id":{"type":"integer","description":"Display ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"images":{"type":"array","description":"Product images","items":{"type":"string"}},"inserted_at":{"type":"string","format":"date-time","description":"Created at"}}}}}}}},"page_number":{"type":"integer","description":"Current page number"},"page_size":{"type":"integer","description":"Page size"},"total_entries":{"type":"integer","description":"Total number of entries"},"total_pages":{"type":"integer","description":"Total number of pages"},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"id":"d9005a9f-257b-4ce7-af6e-bad339598ea6","begin_inventory":1099,"begin_inventory_value":109900000,"end_inventory":1128,"end_inventory_value":112800000,"purchase_import":30,"return_import":0,"stocktaking_import":2,"transfer_import":5,"total_import":37,"total_import_value":3700000,"purchase_export":0,"transfer_export":-5,"sell_export":0,"stocktaking_export":0,"total_export":-8,"total_export_value":800000,"variation":{"id":"d9005a9f-257b-4ce7-af6e-bad339598ea6","product_id":"dee8f2c3-2ecc-4d9b-a9ff-603b5bde7e3d","shop_id":20,"custom_id":"TESTMATDOS","display_id":15,"barcode":null,"images":["https://content.pancake.vn/user-content-dev2.pancake.vn/2025/9/30/d05f44dcf2b9f96312d88b718da35aa5317242d6.jpg"],"fields":[{"id":"2b61c249-35dc-4b79-a3aa-a173c63a8061","keyValue":"BLUE","name":"Color","value":"blue"},{"id":"b053dfb9-b7b6-4d8a-9fb4-197d7b0d7556","keyValue":"L","name":"Size","value":"L"}],"product":{"category_ids":[567],"custom_id":"ANTT","display_id":13038,"images":[],"inserted_at":"2024-11-18T03:18:03","name":"Áo nam Pari đẹp thời trang"}}}],"page_number":1,"page_size":30,"total_entries":4,"total_pages":1}}}}}}}}},"/shops/{SHOP_ID}/inventory_analytics/inventory_by_product":{"get":{"summary":"Statistics by product","x-summary-i18n":{"vie":"Báo cáo xuất nhập kho theo sản phẩm"},"description":"Get inventory statistics grouped by product","tags":["Statistics inventory analytics"],"x-tags-i18n":{"vie":["Báo cáo xuất nhập kho"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","example":30},"description":"Page size"},{"name":"start_date","in":"query","required":true,"schema":{"type":"integer","format":"unix timestamp","example":1760720400},"description":"Start date (unix timestamp)"},{"name":"end_date","in":"query","required":true,"schema":{"type":"integer","format":"unix timestamp","example":1763398799},"description":"End date (unix timestamp)"},{"name":"type","in":"query","required":true,"schema":{"type":"string","enum":["actual","remain"],"x-enum-descriptions":["inventory","Remain quantity"],"example":"actual"},"description":"Statistics by"},{"$ref":"#/components/parameters/InventoryAnalyticsWarehouseIds"},{"$ref":"#/components/parameters/InventoryAnalyticsVariationIds"},{"$ref":"#/components/parameters/InventoryAnalyticsIsExcludeVariation"},{"$ref":"#/components/parameters/InventoryAnalyticsProductIds"},{"$ref":"#/components/parameters/InventoryAnalyticsIsExcludeProduct"},{"$ref":"#/components/parameters/InventoryAnalyticsCategoryIds"},{"$ref":"#/components/parameters/InventoryAnalyticsBrandIds"},{"$ref":"#/components/parameters/InventoryAnalyticsProductTags"},{"$ref":"#/components/parameters/InventoryAnalyticsFilterExcludeTag"},{"$ref":"#/components/parameters/InventoryAnalyticsSupplierProductIds"},{"$ref":"#/components/parameters/InventoryAnalyticsIsFilterSupplierByOr"},{"$ref":"#/components/parameters/InventoryAnalyticsManipulationWarehouseIds"},{"$ref":"#/components/parameters/InventoryAnalyticsIsFilterManipulationWarehouseByOr"},{"$ref":"#/components/parameters/InventoryAnalyticsDataSort"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"Statistics by product","items":{"type":"object","properties":{"id":{"type":"string","description":"Product ID"},"product_id":{"type":"string","description":"Product ID"},"begin_inventory":{"type":"number","format":"float","description":"Beginning inventory quantity"},"begin_inventory_value":{"type":"integer","description":"Beginning inventory value"},"end_inventory":{"type":"number","format":"float","description":"Ending inventory quantity"},"end_inventory_value":{"type":"integer","description":"Ending inventory value"},"purchase_import":{"type":"number","format":"float","description":"Purchase import quantity"},"return_import":{"type":"number","format":"float","description":"Return import quantity"},"stocktaking_import":{"type":"number","format":"float","description":"Stocktaking import quantity"},"transfer_import":{"type":"number","format":"float","description":"Transfer import quantity"},"total_import":{"type":"number","format":"float","description":"Total import quantity"},"total_import_value":{"type":"integer","description":"Total import value"},"purchase_export":{"type":"number","format":"float","description":"Purchase export quantity"},"transfer_export":{"type":"number","format":"float","description":"Transfer export quantity"},"sell_export":{"type":"number","format":"float","description":"Sell export quantity"},"stocktaking_export":{"type":"number","format":"float","description":"Stocktaking export quantity"},"total_export":{"type":"number","format":"float","description":"Total export quantity"},"total_export_value":{"type":"integer","description":"Total export value"},"product":{"type":"object","description":"Product information","properties":{"id":{"type":"string","description":"Product ID"},"name":{"type":"string","description":"Product name"},"custom_id":{"type":"string","description":"Custom ID"},"display_id":{"type":"integer","description":"Display ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"images":{"type":"array","description":"Product images","items":{"type":"string"}},"inserted_at":{"type":"string","format":"date-time","description":"Created at"}}}}}},"page_number":{"type":"integer","description":"Current page number"},"page_size":{"type":"integer","description":"Page size"},"total_entries":{"type":"integer","description":"Total number of entries"},"total_pages":{"type":"integer","description":"Total number of pages"},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"page_number":1,"page_size":30,"total_entries":1,"total_pages":1,"data":[{"id":"dee8f2c3-2ecc-4d9b-a9ff-603b5bde7e3d","product_id":"dee8f2c3-2ecc-4d9b-a9ff-603b5bde7e3d","begin_inventory":2597,"begin_inventory_value":259700000,"end_inventory":2870,"end_inventory_value":287000000,"purchase_import":130,"return_import":5,"stocktaking_import":2,"transfer_import":5,"total_import":296,"total_import_value":29600000,"purchase_export":0,"transfer_export":-5,"sell_export":-15,"stocktaking_export":0,"total_export":-23,"total_export_value":2300000,"product":{"category_ids":[567],"custom_id":"ANTT","display_id":13038,"images":[],"inserted_at":"2024-11-18T03:18:03","name":"Áo nam Pari đẹp thời trang"}}]}}}}}}}}},"/shops/{SHOP_ID}/customer_analytics/report":{"get":{"summary":"Customer overview report","x-summary-i18n":{"vie":"Báo cáo tổng quan khách hàng"},"description":"Get all figures of the Customer overview report (Statistics -> Customer screen) in a single call:\nnew/old customer counts and spending, gender, age groups, customer levels,\ndistribution by successful order count, purchase cycle and the paginated customer list.\n\nTo paginate / sort / search the customer list only (without recomputing the summary blocks),\ncall the same endpoint with `section=customer_orders` — the response then contains only `customer_orders`.\n","tags":["Statistics customer analytics"],"x-tags-i18n":{"vie":["Báo cáo khách hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"},{"name":"startDate","in":"query","required":false,"schema":{"type":"integer","example":1784394000},"description":"Start of the reporting period (unix timestamp, seconds). Customers created from this time are counted as new customers."},{"name":"endDate","in":"query","required":false,"schema":{"type":"integer","example":1787072399},"description":"End of the reporting period (unix timestamp, seconds)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1},"description":"Page number of the customer list (default 1)"},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","example":30},"description":"Number of customers per page (default 10)"},{"name":"data_sort","in":"query","required":false,"schema":{"type":"string","example":"{\"asc_desc\":\"desc\",\"sort_by\":\"order_success_amount\"}"},"description":"Sort the customer list. JSON-encoded object:\n- `sort_by`: `order_count` | `order_success` | `order_return` | `order_success_amount` (default)\n- `asc_desc`: `asc` | `desc` (default)\n"},{"name":"search","in":"query","required":false,"schema":{"type":"string","example":"0999999999"},"description":"Search the customer list by customer name or phone number"},{"name":"section","in":"query","required":false,"schema":{"type":"string","enum":["customer_orders"],"example":"customer_orders"},"description":"Set to `customer_orders` to return only the paginated customer list"},{"name":"sale_form","in":"query","required":false,"schema":{"type":"string","enum":["all","retail","wholesale"],"example":"all"},"description":"Filter by sale form (retail / wholesale customers, based on shop wholesale tag settings)"},{"name":"warehouse_id[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"example":["fef177ba-1a5f-4c07-b1f4-e327ba71a596"]},"description":"Filter orders by warehouse"},{"name":"order_sources[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"example":["{\"order_sources\":\"-1\"}"]},"description":"Filter by order source. Each item is a JSON-encoded object `{\"order_sources\": \"<source>\", \"account\": \"<account_id>\"}`.\nSource values are the same as on web (see the `/shops/{SHOP_ID}/order_source` endpoint).\n"},{"name":"is_filter_exclude_source","in":"query","required":false,"schema":{"type":"string","enum":["true","false"],"example":"false"},"description":"Exclude (instead of include) the sources in `order_sources[]`"},{"name":"order_tag[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"example":["1"]},"description":"Filter orders by order tag IDs. Special value `no_tag` filters orders without tags."},{"name":"is_filter_tag_by_or","in":"query","required":false,"schema":{"type":"string","enum":["true","false"],"example":"true"},"description":"`true` (default): order matches ANY tag in `order_tag[]`; `false`: order must contain ALL tags"},{"name":"is_filter_exclude","in":"query","required":false,"schema":{"type":"string","enum":["true","false"],"example":"false"},"description":"Exclude (instead of include) the tags in `order_tag[]`"},{"name":"selectedLevel[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"example":["2d058084-4219-4ef3-bf4c-e7b77889224c"]},"description":"Filter by customer level IDs (see the `/shops/{SHOP_ID}/customer_levels` endpoint)"},{"name":"gender[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["male","female","none"]},"example":["male"]},"description":"Filter by customer gender (`none` = no gender information)"},{"name":"typeCustomer[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["online","offline"]},"example":["online"]},"description":"Filter by customer type: `online` (has a linked social account) / `offline`"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"},"data":{"type":"object","properties":{"customer":{"type":"object","description":"Customer counts. Old customers were created before `startDate`, new customers within the period. `old_customer` is null when `startDate` is not provided.","properties":{"new_customer":{"type":"integer","description":"Number of new customers"},"old_customer":{"type":"integer","nullable":true,"description":"Number of old customers"}}},"customer_purchased":{"type":"object","description":"Spending of new vs old customers (numeric string)","properties":{"new_customer":{"type":"string","nullable":true,"description":"Spending of new customers"},"old_customer":{"type":"string","nullable":true,"description":"Spending of old customers"}}},"customer_gender":{"type":"object","description":"Customer counts by gender","properties":{"male":{"type":"integer","description":"Male customers"},"female":{"type":"integer","description":"Female customers"},"unknown":{"type":"integer","description":"Customers without gender information"}}},"customer_age":{"type":"object","description":"Customer counts and revenue by age group (based on date of birth)","properties":{"under_18":{"type":"integer","description":"Customers under 18"},"revenue_under_18":{"type":"number","nullable":true,"description":"Revenue from customers under 18"},"from_18_to_24":{"type":"integer","description":"Customers aged 18-24"},"revenue_from_18_to_24":{"type":"number","nullable":true,"description":"Revenue from customers aged 18-24"},"from_25_to_34":{"type":"integer","description":"Customers aged 25-34"},"revenue_from_25_to_34":{"type":"number","nullable":true,"description":"Revenue from customers aged 25-34"},"from_35_to_44":{"type":"integer","description":"Customers aged 35-44"},"revenue_from_35_to_44":{"type":"number","nullable":true,"description":"Revenue from customers aged 35-44"},"from_45_to_54":{"type":"integer","description":"Customers aged 45-54"},"revenue_from_45_to_54":{"type":"number","nullable":true,"description":"Revenue from customers aged 45-54"},"over_55":{"type":"integer","description":"Customers over 55"},"revenue_over_55":{"type":"number","nullable":true,"description":"Revenue from customers over 55"},"havent_birthday":{"type":"integer","description":"Customers without date of birth"},"revenue_total":{"type":"number","nullable":true,"description":"Total revenue of all age groups"}}},"customer_level":{"type":"array","description":"Customer statistics by level. Customers having the shop's level-exclusion tags are not counted.","items":{"type":"object","properties":{"id":{"type":"string","nullable":true,"description":"Customer level ID (see `/shops/{SHOP_ID}/customer_levels`), null = no level"},"count":{"type":"integer","description":"Number of customers in this level"},"total_amount":{"type":"string","nullable":true,"description":"Spending of customers in this level (numeric string)"}}}},"customer_order_count":{"type":"array","description":"Distribution of customers by number of successful orders","items":{"type":"object","properties":{"order_success_quantity":{"type":"integer","description":"Number of successful orders"},"customer_count":{"type":"integer","description":"Number of customers with that many successful orders"},"amount":{"type":"string","nullable":true,"description":"Total successful-order amount of those customers (numeric string)"}}}},"new_customer":{"type":"object","description":"New customer details","properties":{"old_customer":{"type":"integer","nullable":true,"description":"Number of old customers"},"analytic_new_customer":{"type":"object","properties":{"count":{"type":"integer","description":"Number of new customers"},"count_1":{"type":"integer","description":"New customers with exactly 1 order"},"count_2":{"type":"integer","description":"New customers with more than 1 order"},"count_tags":{"type":"integer","description":"New customers having tags"}}}}},"customer_analytic":{"type":"array","description":"Purchase-cycle statistics. One row per cycle range:\n`range` = 0: single-purchase customers; 1 / 31 / 61: repeat customers with an average buying cycle of 1-30 / 31-60 / 61-90 days; 91: cycle over 90 days.\nWithin each row, customers are counted by days elapsed since their last order (compared to `endDate`).\n","items":{"type":"object","properties":{"range":{"type":"integer","description":"Cycle range key (0, 1, 31, 61, 91)"},"from_1_to_30":{"type":"integer","description":"Customers whose last order was 1-30 days ago"},"from_31_to_60":{"type":"integer","description":"Customers whose last order was 31-60 days ago"},"from_61_to_90":{"type":"integer","description":"Customers whose last order was 61-90 days ago"},"under_90":{"type":"integer","description":"Customers whose last order was more than 90 days ago"},"total":{"type":"integer","description":"Total customers in this cycle range"}}}},"customer_orders":{"type":"object","description":"Paginated customer list","properties":{"page_number":{"type":"integer","description":"Current page"},"page_size":{"type":"integer","description":"Number of customers per page"},"total_entries":{"type":"integer","description":"Total number of customers"},"total_pages":{"type":"integer","nullable":true,"description":"Total number of pages"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Shop customer ID"},"name":{"type":"string","description":"Customer name"},"phone_number":{"type":"array","items":{"type":"string"},"description":"Customer phone numbers"},"currency":{"type":"string","nullable":true,"description":"Customer currency"},"order_count":{"type":"integer","description":"Number of orders"},"order_success_count":{"type":"integer","description":"Number of successful orders"},"order_return_count":{"type":"integer","description":"Number of returned orders"},"order_success_amount":{"type":"number","description":"Amount spent on successful orders"},"customer":{"type":"object","nullable":true,"description":"Linked global customer information","properties":{"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Customer name"},"fb_id":{"type":"string","nullable":true,"description":"Facebook ID"},"psid":{"type":"string","nullable":true,"description":"Page-scoped ID"},"global_id":{"type":"string","nullable":true,"description":"Global customer ID"}}}}}}}}}}}},"examples":{"default":{"value":{"success":true,"data":{"customer":{"new_customer":2,"old_customer":6},"customer_purchased":{"new_customer":"1006000","old_customer":"5870098"},"customer_gender":{"male":0,"female":0,"unknown":8},"customer_age":{"under_18":0,"revenue_under_18":null,"from_18_to_24":0,"revenue_from_18_to_24":null,"from_25_to_34":0,"revenue_from_25_to_34":null,"from_35_to_44":0,"revenue_from_35_to_44":null,"from_45_to_54":0,"revenue_from_45_to_54":null,"over_55":0,"revenue_over_55":null,"havent_birthday":8,"revenue_total":6824089},"customer_level":[{"id":"2d058084-4219-4ef3-bf4c-e7b77889224c","count":2,"total_amount":"4070000"},{"id":"6c7f0d31-4f5a-43b1-a0d6-b30081e48f5a","count":1,"total_amount":"1050000"},{"id":null,"count":5,"total_amount":"1756098"}],"customer_order_count":[{"order_success_quantity":0,"customer_count":8,"amount":"0"}],"new_customer":{"old_customer":6,"analytic_new_customer":{"count":2,"count_1":2,"count_2":0,"count_tags":0}},"customer_analytic":[{"range":0,"from_1_to_30":0,"from_31_to_60":7,"from_61_to_90":0,"under_90":121,"total":128},{"range":1,"from_1_to_30":0,"from_31_to_60":2,"from_61_to_90":0,"under_90":7,"total":9},{"range":31,"from_1_to_30":0,"from_31_to_60":2,"from_61_to_90":0,"under_90":3,"total":5},{"range":61,"from_1_to_30":0,"from_31_to_60":0,"from_61_to_90":0,"under_90":1,"total":1},{"range":91,"from_1_to_30":0,"from_31_to_60":0,"from_61_to_90":0,"under_90":3,"total":3}],"customer_orders":{"success":true,"page_number":1,"page_size":30,"total_entries":8,"total_pages":null,"data":[{"id":"330fdf15-7301-4d9c-86e6-f6ea21ed37bf","name":"khách colombia","currency":null,"phone_number":["0982342873"],"customer":{"id":"af55aee2-3846-43d7-8f46-13d768462731","name":"khách colombia","global_id":null,"fb_id":null,"psid":null},"order_count":1,"order_return_count":0,"order_success_amount":0,"order_success_count":0},{"id":"941e822e-fc98-4852-bdea-3a8f806cf362","name":"Hoang Anhbcde","currency":"VND","phone_number":["0999999999"],"customer":{"id":"db647f48-b20d-4fcf-95b4-eb277a2087b9","name":"Hoang Anh","global_id":null,"fb_id":null,"psid":null},"order_count":7,"order_return_count":0,"order_success_amount":0,"order_success_count":0}]}}}}}}}}}}},"/shops/{SHOP_ID}/users":{"get":{"summary":"Employee list","x-summary-i18n":{"vie":"Danh sách nhân viên"},"description":"Get list of employees","tags":["Employee"],"x-tags-i18n":{"vie":["Nhân viên"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"List of employees","items":{"type":"object","properties":{"department":{"type":"object","description":"Department information","properties":{"id":{"type":"integer","description":"Department ID"},"name":{"type":"string","description":"Department name"}}},"shop_id":{"type":"integer","description":"Shop ID"},"user_id":{"type":"string","description":"User ID"},"user":{"type":"object","description":"User information","properties":{"email":{"type":"string","description":"User email"},"fb_id":{"type":"string","description":"Facebook ID"},"id":{"type":"string","description":"User ID"},"name":{"type":"string","description":"User name"},"phone_number":{"type":"string","description":"Phone number"}}},"sale_group":{"type":"object","description":"Sale group information","properties":{"id":{"type":"integer","description":"Sale group ID"},"name":{"type":"string","description":"Sale group name"}}}}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"data":[{"department":{"id":933,"name":"Sales"},"shop_id":7,"user_id":"8fbe2a6f-b0b2-4227-a698-19d18c43f7c8","user":{"email":"2042723249341651@facebook.com","fb_id":"2042723249341651","id":"8fbe2a6f-b0b2-4227-a698-19d18c43f7c8","name":"Hoang Anh","phone_number":null},"sale_group":{"id":30,"name":"Ca sáng"}}]}}}}}}}}},"/shops/{SHOP_ID}":{"get":{"summary":"Get shop","x-summary-i18n":{"vie":"Chi tiết cửa hàng"},"description":"Get one shop the caller belongs to, in the same shape as an item of the shop list. With a shop API key, the key's account needs the shop configuration permission.","tags":["Shop"],"x-tags-i18n":{"vie":["Cửa hàng"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"shop":{"$ref":"#/components/schemas/Shop"},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"value":{"success":true,"shop":{"id":20,"name":"Shop thời trang","avatar_url":"https://statics.pancake.vn/user-content-dev2.pancake.vn/2022/7/6/8678250807b2285e2752ac2cbbf43925f19a677c.jpeg","currency":"VND","preferred_shop":null,"link_post_marketer":[],"pages":[{"id":"104438181227821","name":"Quần áo","platform":"facebook","settings":{"auto_create_order":true},"shop_id":20}]}}}}}}}}},"put":{"summary":"Webhook configuration","x-summary-i18n":{"vie":"Cấu hình Webhook"},"description":"Configure webhook settings. Go to **Setting -> Advance -> Third-party connection -> Webhook/API** to configure:\n- Webhook URL (Required)\n- Email error message\n- Request Headers\n- Webhook types: `orders`, `customers`, `products`, `variations_warehouses`, or `auto_call`\n\n## Webhook Response Types\n\nWhen webhook is enabled, the system sends POST requests to the configured URL. Response schema:\n\n- **`orders`**: See [WebhookOrderResponse](#model/WebhookOrderResponse) schema\n- **`customers`**: See [WebhookCustomerResponse](#model/WebhookCustomerResponse) schema\n- **`products`**: See [WebhookProductResponse](#model/WebhookProductResponse) schema\n- **`variations_warehouses`**: See [WebhookInventoryResponse](#model/WebhookInventoryResponse) schema\n- **`auto_call`**: See [WebhookAutoCallResponse](#model/WebhookAutoCallResponse) schema\n","tags":["Webhook"],"x-tags-i18n":{"vie":["Webhook"]},"parameters":[{"name":"SHOP_ID","in":"path","required":true,"schema":{"type":"integer","example":4},"description":"Shop ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shop"],"properties":{"shop":{"type":"object","properties":{"webhook_enable":{"type":"boolean","description":"Enable/Disable Webhook"},"webhook_url":{"type":"string","format":"uri","description":"Link URL"},"webhook_email":{"type":"string","format":"email","description":"Error message email"},"webhook_types":{"type":"array","description":"Webhook data","items":{"type":"string"}},"webhook_partner":{"type":"string","description":"Partner"},"webhook_headers":{"type":"object","description":"Webhook headers","additionalProperties":{"type":"string"}}}}},"example":{"shop":{"webhook_enable":true,"webhook_url":"https://test.com","webhook_email":"1234@gmail.com","webhook_types":["orders","customers","variations_warehouses"],"webhook_partner":"","webhook_headers":{"X-API-KEY":"elqsF9ERiFWGacWQO9Gg5XC4kXojot"}}}}}},"description":"Request body containing information to update"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"shop":{"type":"object","description":"Shop information","properties":{"webhook_enable":{"type":"boolean","description":"Enable/Disable Webhook"},"webhook_url":{"type":"string","format":"uri","description":"Link URL"},"webhook_email":{"type":"string","format":"email","description":"Error message email"},"webhook_types":{"type":"array","description":"Webhook data","items":{"type":"string"}},"webhook_partner":{"type":"string","description":"Partner"},"webhook_headers":{"type":"object","description":"Webhook headers"},"additionalProperties":{"type":"string"}}},"success":{"type":"boolean","description":"Success status"}}},"examples":{"default":{"$ref":"#/components/examples/SuccessResponse"}}}}}}}}},"components":{"examples":{"OrderBasic":{"value":{"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"}}},"SuccessResponse":{"value":{"success":true}},"SuccessEmptyDataResponse":{"value":{"success":true,"data":[]}}},"parameters":{"InventoryAnalyticsWarehouseIds":{"name":"warehouse_ids[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"},"example":["b4cb5897-6e56-4581-96cc-2f12677c7bd8"]},"description":"Filter histories by warehouse ID(s). Restricts the inventory movements considered to the listed warehouses."},"InventoryAnalyticsVariationIds":{"name":"variation_ids[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"},"example":["d9005a9f-257b-4ce7-af6e-bad339598ea6"]},"description":"Filter by variation IDs. When `is_exclude_variation=true`, this list becomes an exclusion list."},"InventoryAnalyticsIsExcludeVariation":{"name":"is_exclude_variation","in":"query","required":false,"schema":{"type":"boolean","default":false,"example":false},"description":"When true, treat `variation_ids[]` as an exclusion list instead of an inclusion list."},"InventoryAnalyticsProductIds":{"name":"product_ids[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"},"example":["dee8f2c3-2ecc-4d9b-a9ff-603b5bde7e3d"]},"description":"Filter by product IDs. When `is_exclude_product=true`, this list becomes an exclusion list."},"InventoryAnalyticsIsExcludeProduct":{"name":"is_exclude_product","in":"query","required":false,"schema":{"type":"boolean","default":false,"example":false},"description":"When true, treat `product_ids[]` as an exclusion list instead of an inclusion list."},"InventoryAnalyticsCategoryIds":{"name":"category_ids[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer"},"example":[567]},"description":"Filter by category IDs. A single integer value is also accepted (`category_ids=567`)."},"InventoryAnalyticsBrandIds":{"name":"brand_ids[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"example":["7a2f5e0a-1111-2222-3333-444455556666"]},"description":"Filter by brand IDs (UUID). Special value `no_value` matches products without a brand.\n"},"InventoryAnalyticsProductTags":{"name":"product_tags[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"example":["12"]},"description":"Filter by product tag IDs (integers serialized as strings). Special value `no_value` matches products without any tag.\nCombine with `filter_exclude_tag=true` to negate the filter.\n"},"InventoryAnalyticsFilterExcludeTag":{"name":"filter_exclude_tag","in":"query","required":false,"schema":{"type":"boolean","default":false,"example":false},"description":"When true, treat `product_tags[]` as an exclusion list. Products with any of the listed tags are excluded."},"InventoryAnalyticsSupplierProductIds":{"name":"supplier_product_ids[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"example":["123"]},"description":"Filter by supplier IDs (integers serialized as strings). Special value `no_value` matches products without a supplier.\nBy default the product must contain ALL listed supplier IDs; set `is_filter_supplier_by_or=true` to match ANY.\n"},"InventoryAnalyticsIsFilterSupplierByOr":{"name":"is_filter_supplier_by_or","in":"query","required":false,"schema":{"type":"boolean","default":false,"example":false},"description":"When true, OR-combine the `supplier_product_ids[]` filter (match any) instead of AND (match all)."},"InventoryAnalyticsManipulationWarehouseIds":{"name":"manipulation_warehouse_ids[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"},"example":["b4cb5897-6e56-4581-96cc-2f12677c7bd8"]},"description":"Filter by manipulation warehouses configured on the product. By default the product must contain ALL listed warehouses;\nset `is_filter_manipulation_warehouse_by_or=true` to match ANY. Products without any manipulation warehouse are always included.\n"},"InventoryAnalyticsIsFilterManipulationWarehouseByOr":{"name":"is_filter_manipulation_warehouse_by_or","in":"query","required":false,"schema":{"type":"boolean","default":false,"example":false},"description":"When true, OR-combine the `manipulation_warehouse_ids[]` filter (match any) instead of AND (match all)."},"InventoryAnalyticsDataSort":{"name":"data_sort","in":"query","required":false,"schema":{"type":"string","example":"{\"sort_by\":\"product_name\",\"asc_desc\":\"desc\"}"},"description":"JSON-encoded sort spec `{\"sort_by\": <field>, \"asc_desc\": \"asc\"|\"desc\"}`. Supported `sort_by` values:\n`product_id`, `product_name`, `variation`, `purchase_import`, `purchase_export`, `return_import`,\n`transfer_import`, `transfer_export`, `sell_export`, `stocktaking_import`, `stocktaking_export`,\n`other_import`, `other_export`, `total_import_value`, `total_export_value`, `early_actual`,\n`late_actual`, `early_actual_value`, `late_actual_value`.\n"},"AdsSelectFields":{"name":"select_fields","in":"query","required":false,"schema":{"type":"string","example":"lead,website_lead,lead_conversion_value,cost_per_lead,omni_purchase,cost_per_omni_purchase"},"description":"Comma-separated list of additional `insights` fields to include in the response. When specified, only the listed fields are returned inside `insights` (in addition to the always-present base metrics).\n\n**Performance**\n- `ad_performance_session` — Overall performance\n- `spend` — Amount spent\n- `reach` — Instant Experience reach\n- `impressions` — Impressions\n- `clicks` — Clicks (all)\n- `frequency` — Frequency\n- `cpp` — CPP\n- `cpm` — CPM\n- `cpc` — CPC\n- `ctr` — CTR\n- `cost_per_1000_accounts_center_reach` — Cost per 1000 accounts center reach\n- `cost_per_result` — Cost per result\n- `avg_purchase_conversion_value` — Average purchase conversion value\n- `indicator_result` — Result\n- `result_roas` — Result ROAS\n\n**Engagement**\n- `ad_engagement_session` — Engagement\n- `link_click` — Link clicks\n- `like` — Facebook likes\n- `comment` — Post comments\n- `post_engagement` — Post engagements\n- `post_reaction` — Post reactions\n- `post` — Post shares\n- `onsite_conversion_post_save` — Post saves\n- `photo_view` — Photo views\n- `video_view` — Video plays (≥3s)\n- `inline_link_click_ctr` — CTR (link click-through rate)\n- `outbound_click` — Outbound clicks\n- `onsite_conversion_messaging_conversation_started_7d` — Messaging conversations started\n- `onsite_conversion_messaging_first_reply` — New messaging contacts\n- `onsite_conversion_messaging_block` — Messaging blocks\n- `video_thruplay_watched_actions` — ThruPlays\n- `video_play_actions` — Video plays\n- `video_p25_watched_actions` — Video plays at 25%\n- `video_p50_watched_actions` — Video plays at 50%\n- `video_p75_watched_actions` — Video plays at 75%\n- `video_p95_watched_actions` — Video plays at 95%\n- `video_p100_watched_actions` — Video plays at 100%\n- `estimated_ad_recallers` — Estimated ad recall lift (people)\n- `cost_per_outbound_click` — Cost per outbound click\n- `cost_per_thruplay` — Cost per ThruPlay\n- `outbound_clicks_ctr` — Outbound CTR\n- `cost_per_post_engagement` — Cost per post engagement\n- `estimated_ad_recall_rate` — Estimated ad recall lift rate\n- `cost_per_estimated_ad_recallers` — Cost per estimated ad recall lift\n- `cost_per_messaging_conversation_started` — Cost per messaging conversation started\n\n**Conversion**\n\n*Leads*\n- `lead` — Leads\n- `website_lead` — Website leads\n- `offline_lead` — Offline leads\n- `meta_lead` — Meta leads\n- `lead_conversion_value` — Lead conversion value\n- `website_lead_conversion_value` — Website lead conversion value\n- `offline_lead_conversion_value` — Offline lead conversion value\n- `meta_lead_conversion_value` — Meta lead conversion value\n- `cost_per_lead` — Cost per lead\n\n*Purchases*\n- `omni_purchase` — Purchases\n- `inapp_omni_purchase` — In-app purchases\n- `website_omni_purchase` — Website purchases\n- `offline_omni_purchase` — Offline purchases\n- `meta_omni_purchase` — Meta purchases\n- `omni_purchase_conversion_value` — Purchase conversion value\n- `inapp_omni_purchase_conversion_value` — In-app purchase conversion value\n- `website_omni_purchase_conversion_value` — Website purchase conversion value\n- `offline_omni_purchase_conversion_value` — Offline purchase conversion value\n- `meta_omni_purchase_conversion_value` — Meta purchase conversion value\n- `cost_per_omni_purchase` — Cost per purchase\n\n*Checkout initiated*\n- `omni_initiated_checkout` — Checkout initiated\n- `inapp_omni_initiated_checkout` — In-app checkout initiated\n- `website_omni_initiated_checkout` — Website checkout initiated\n- `offline_omni_initiated_checkout` — Offline checkout initiated\n- `meta_omni_initiated_checkout` — Meta checkout initiated\n- `omni_initiated_checkout_conversion_value` — Checkout initiation conversion value\n- `inapp_omni_initiated_checkout_conversion_value` — In-app checkout initiation conversion value\n- `website_omni_initiated_checkout_conversion_value` — Website checkout initiation conversion value\n- `offline_omni_initiated_checkout_conversion_value` — Offline checkout initiation conversion value\n- `meta_omni_initiated_checkout_conversion_value` — Meta checkout initiation conversion value\n- `cost_per_omni_initiated_checkout` — Cost per checkout initiated\n\n*Registrations completed*\n- `omni_complete_registration` — Registrations completed\n- `inapp_omni_complete_registration` — In-app registrations completed\n- `website_omni_complete_registration` — Website registrations completed\n- `offline_omni_complete_registration` — Offline registrations completed\n- `omni_complete_registration_conversion_value` — Registration completion conversion value\n- `inapp_omni_complete_registration_conversion_value` — In-app registration completion conversion value\n- `website_omni_complete_registration_conversion_value` — Website registration completion conversion value\n- `offline_omni_complete_registration_conversion_value` — Offline registration completion conversion value\n- `cost_per_omni_complete_registration` — Cost per registration completed\n\n*Content views*\n- `omni_view_content` — Content views\n- `inapp_omni_view_content` — In-app content views\n- `website_omni_view_content` — Website content views\n- `offline_omni_view_content` — Offline content views\n- `meta_omni_view_content` — Meta content views\n- `omni_view_content_conversion_value` — Content view conversion value\n- `inapp_omni_view_content_conversion_value` — In-app content view conversion value\n- `website_omni_view_content_conversion_value` — Website content view conversion value\n- `offline_omni_view_content_conversion_value` — Offline content view conversion value\n- `meta_omni_view_content_conversion_value` — Meta content view conversion value\n- `cost_per_omni_view_content` — Cost per content view\n\n*Searches*\n- `omni_search` — Searches\n- `inapp_omni_search` — In-app searches\n- `website_omni_search` — Website searches\n- `offline_omni_search` — Offline searches\n- `omni_search_conversion_value` — Search conversion value\n- `inapp_omni_search_conversion_value` — In-app search conversion value\n- `website_omni_search_conversion_value` — Website search conversion value\n- `offline_omni_search_conversion_value` — Offline search conversion value\n- `cost_per_omni_search` — Cost per search\n\n*Add to cart*\n- `omni_add_to_cart` — Add to cart\n- `inapp_omni_add_to_cart` — In-app add to cart\n- `website_omni_add_to_cart` — Website add to cart\n- `offline_omni_add_to_cart` — Offline add to cart\n- `meta_omni_add_to_cart` — Meta add to cart\n- `omni_add_to_cart_conversion_value` — Add-to-cart conversion value\n- `inapp_omni_add_to_cart_conversion_value` — In-app add-to-cart conversion value\n- `website_omni_add_to_cart_conversion_value` — Website add-to-cart conversion value\n- `offline_omni_add_to_cart_conversion_value` — Offline add-to-cart conversion value\n- `meta_omni_add_to_cart_conversion_value` — Meta add-to-cart conversion value\n- `cost_per_omni_add_to_cart` — Cost per add to cart\n\n*Add to wishlist*\n- `omni_add_to_wishlist` — Add to wishlist\n- `inapp_omni_add_to_wishlist` — In-app add to wishlist\n- `website_omni_add_to_wishlist` — Website add to wishlist\n- `offline_omni_add_to_wishlist` — Offline add to wishlist\n- `meta_omni_add_to_wishlist` — Meta add to wishlist\n- `omni_add_to_wishlist_conversion_value` — Add-to-wishlist conversion value\n- `inapp_omni_add_to_wishlist_conversion_value` — In-app add-to-wishlist conversion value\n- `website_omni_add_to_wishlist_conversion_value` — Website add-to-wishlist conversion value\n- `offline_omni_add_to_wishlist_conversion_value` — Offline add-to-wishlist conversion value\n- `meta_omni_add_to_wishlist_conversion_value` — Meta add-to-wishlist conversion value\n- `cost_per_omni_add_to_wishlist` — Cost per add to wishlist\n\n*Product customizations*\n- `customize_product_total` — Product customizations\n- `inapp_customize_product_total` — In-app product customizations\n- `website_customize_product_total` — Website product customizations\n- `offline_customize_product_total` — Offline product customizations\n- `customize_product_total_conversion_value` — Product customization conversion value\n- `inapp_customize_product_total_conversion_value` — In-app product customization conversion value\n- `website_customize_product_total_conversion_value` — Website product customization conversion value\n- `offline_customize_product_total_conversion_value` — Offline product customization conversion value\n- `cost_per_customize_product_total` — Cost per product customization\n\n*Trials started*\n- `start_trial_total` — Trials started\n- `inapp_start_trial_total` — In-app trials started\n- `website_start_trial_total` — Website trials started\n- `offline_start_trial_total` — Offline trials started\n- `start_trial_total_conversion_value` — Trial start conversion value\n- `inapp_start_trial_total_conversion_value` — In-app trial start conversion value\n- `website_start_trial_total_conversion_value` — Website trial start conversion value\n- `offline_start_trial_total_conversion_value` — Offline trial start conversion value\n- `cost_per_start_trial_total` — Cost per trial started\n\n*Subscriptions*\n- `subscribe_total` — Subscriptions\n- `inapp_subscribe_total` — In-app subscriptions\n- `website_subscribe_total` — Website subscriptions\n- `offline_subscribe_total` — Offline subscriptions\n- `subscribe_total_conversion_value` — Subscription conversion value\n- `inapp_subscribe_total_conversion_value` — In-app subscription conversion value\n- `website_subscribe_total_conversion_value` — Website subscription conversion value\n- `offline_subscribe_total_conversion_value` — Offline subscription conversion value\n- `cost_per_subscribe_total` — Cost per subscription\n\n*Applications submitted*\n- `submit_application_total` — Applications submitted\n- `inapp_submit_application_total` — In-app applications submitted\n- `website_submit_application_total` — Website applications submitted\n- `offline_submit_application_total` — Offline applications submitted\n- `meta_submit_application_total` — Meta applications submitted\n- `submit_application_total_conversion_value` — Application submission conversion value\n- `inapp_submit_application_total_conversion_value` — In-app application submission conversion value\n- `website_submit_application_total_conversion_value` — Website application submission conversion value\n- `offline_submit_application_total_conversion_value` — Offline application submission conversion value\n- `meta_submit_application_total_conversion_value` — Meta application submission conversion value\n- `cost_per_submit_application_total` — Cost per application submitted\n\n*Contacts*\n- `contact_total` — Contacts\n- `inapp_contact_total` — In-app contacts\n- `website_contact_total` — Website contacts\n- `offline_contact_total` — Offline contacts\n- `contact_total_conversion_value` — Contact conversion value\n- `inapp_contact_total_conversion_value` — In-app contact conversion value\n- `website_contact_total_conversion_value` — Website contact conversion value\n- `offline_contact_total_conversion_value` — Offline contact conversion value\n- `cost_per_contact_total` — Cost per contact\n\n*Landing page views*\n- `landing_page_view` — Landing page views\n- `inapp_landing_page_view` — In-app landing page views\n- `website_landing_page_view` — Website landing page views\n- `cost_per_landing_page_view` — Cost per landing page view\n\n*Orders*\n- `order_created` — Orders created\n- `order_shipped` — Orders shipped\n\n*Purchase ROAS*\n- `purchase_roas` — Purchase ROAS\n- `inapp_purchase_roas` — In-app purchase ROAS\n- `website_purchase_roas` — Website purchase ROAS\n"},"AdsStartTime":{"name":"start_time","in":"query","required":false,"schema":{"type":"integer","format":"int64","example":1784221200},"description":"Start of the statistics period, as a Unix timestamp (seconds). The `insights` metrics are aggregated from this time."},"AdsEndTime":{"name":"end_time","in":"query","required":false,"schema":{"type":"integer","format":"int64","example":1784912399},"description":"End of the statistics period, as a Unix timestamp (seconds). The `insights` metrics are aggregated up to this time."}},"schemas":{"ErrorResponse":{"type":"object","description":"Business or request error response","required":["success"],"properties":{"success":{"type":"boolean","enum":[false],"description":"Success status"},"message":{"type":"string","description":"Human-readable error message"},"error":{"type":"string","description":"Stable machine-readable error name, when provided"},"error_code":{"type":"integer","description":"Machine-readable error code, when provided"},"message_code":{"type":"integer","description":"POS business message code, when provided"},"permission":{"type":"string","description":"Required permission, when access is denied"}}},"OrderMessage":{"type":"object","description":"A rendered message from the conversation associated with an order. Properties can be omitted when `fields[]` is specified.","properties":{"id":{"type":"string","description":"Message identifier"},"type":{"type":["string","null"],"description":"Platform-specific message type, such as `INBOX` or `COMMENT`"},"message":{"type":"string","description":"Rendered message content, which may contain HTML"},"original_message":{"type":["string","null"],"description":"Original message text before rendering"},"message_tags":{"type":"array","description":"Extensible metadata for entities detected in the message","items":{"type":"object","additionalProperties":true}},"from":{"type":"object","additionalProperties":true,"description":"Extensible sender information supplied by the messaging platform"},"seen":{"type":"boolean","description":"Whether the message has been seen"},"can_like":{"type":"boolean","description":"Whether the page can like the message"},"user_likes":{"type":"boolean","description":"Whether the page has liked the message"},"like_count":{"type":["integer","null"],"description":"Number of likes"},"can_comment":{"type":"boolean","description":"Whether the page can comment on the message"},"comment_count":{"type":["integer","null"],"description":"Number of replies"},"can_remove":{"type":"boolean","description":"Whether the message can be removed"},"is_removed":{"type":"boolean","description":"Whether the message was removed"},"is_hidden":{"type":"boolean","description":"Whether the message is hidden"},"can_hide":{"type":"boolean","description":"Whether the message can be hidden"},"can_reply_privately":{"type":"boolean","description":"Whether the message supports a private reply"},"private_reply_conversation":{"type":["object","null"],"additionalProperties":true,"description":"Conversation metadata created by a private reply"},"attachments":{"type":"array","description":"Extensible platform-specific message attachments","items":{"type":"object","additionalProperties":true,"properties":{"type":{"type":"string","description":"Extensible platform-specific attachment type"},"payload":{"type":["object","null"],"additionalProperties":true,"description":"Extensible structured attachment payload"}}}},"has_phone":{"type":"boolean","description":"Whether a phone number was detected in the message"},"phone_info":{"type":"array","description":"Extensible metadata for phone numbers detected in the message","items":{"type":"object","additionalProperties":true}},"is_parent":{"type":"boolean","description":"Whether the message is a top-level comment"},"inserted_at":{"type":"string","example":"2026-06-25T02:00:38.675576","description":"ISO 8601 timestamp emitted at runtime without a timezone suffix"},"page_id":{"type":"string","description":"Page identifier"},"show_info":{"type":"boolean","description":"Whether sender information should be displayed for this message"},"parent_id":{"type":["string","null"],"description":"Parent message identifier for a reply"},"is_parent_hidden":{"type":"boolean","description":"Whether the parent message is hidden"},"edit_history":{"type":["array","null"],"description":"Extensible message edit history","items":{"type":"object","additionalProperties":true}},"removed_by":{"type":["object","null"],"additionalProperties":true,"description":"Information about the actor who removed the message"},"rich_message":{"type":["object","null"],"additionalProperties":true,"description":"Extensible rich-message metadata"},"conversation_id":{"type":"string","description":"Conversation identifier"},"is_livestream_order":{"type":["boolean","null"],"description":"Whether the message was recognized as a livestream order"}}},"Order":{"type":"object","description":"Order information","properties":{"id":{"type":"integer","description":"Order ID"},"system_id":{"type":"integer","description":"System ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Order creation time"},"updated_at":{"type":"string","format":"date-time","description":"Order update time"},"status":{"type":"integer","description":"Order status","enum":[0,17,11,12,13,20,1,8,9,2,3,16,4,15,5,6,7],"x-enum-descriptions":["New","Waiting for confirmation","Restocking","Wait for printing","Printed","Purchased","Confirmed","Packaging","Waiting for pick up","Shipped","Received","Collected money","Returning","Partial return","Returned","Canceled","Deleted recently"]},"status_name":{"type":"string","description":"Order status name"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"bill_email":{"type":"string","description":"Customer email"},"conversation_id":{"type":"string","description":"Conversation ID"},"page_id":{"type":"string","description":"Facebook page ID"},"post_id":{"type":"string","description":"Post ID"},"ad_id":{"type":"string","description":"Ad ID"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"partner_fee":{"type":"integer","description":"Fee from shipping partner"},"fee_marketplace":{"type":"integer","description":"Fees from e-commerce platforms"},"customer_pay_fee":{"type":"boolean","description":"Customer pay shipping fee"},"is_free_shipping":{"type":"boolean","description":"Free shipping"},"is_livestream":{"type":"boolean","description":"Is livestream order"},"is_live_shopping":{"type":"boolean","description":"Is live shopping order"},"is_smc":{"type":"boolean","description":"Shopping on Messenger"},"received_at_shop":{"type":"boolean","description":"true: Sales at counter, false: Sell online"},"total_discount":{"type":"integer","description":"Discount total"},"note":{"type":"string","description":"Internal note"},"note_print":{"type":"string","description":"Note for printing"},"returned_reason":{"type":"integer","description":"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_name":{"type":"string","description":"Return reason name"},"sub_status":{"type":"integer","description":"Reason for delivery delay"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"warehouse_info":{"type":"object","description":"Warehouse information","properties":{"name":{"type":"string","description":"Warehouse name"},"phone_number":{"type":"string","description":"Warehouse phone number"},"full_address":{"type":"string","description":"Warehouse full address"},"address":{"type":"string","description":"Warehouse address"},"province_id":{"type":"string","description":"Province ID"},"district_id":{"type":"string","description":"District ID"},"commune_id":{"type":"string","description":"Commune ID"},"affiliate_id":{"type":"string","description":"Affiliate ID"},"ffm_id":{"type":"string","description":"FFM ID"},"has_snappy_service":{"type":"boolean","description":"Has Snappy service"},"custom_id":{"type":"string","description":"Custom ID"}}},"creator_id":{"type":"string","description":"Creator ID"},"creator":{"type":"object","description":"Order creator","properties":{"id":{"type":"string","description":"Creator ID"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"name":{"type":"string","description":"Creator name"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"items":{"type":"array","description":"Product list","items":{"type":"object","required":["variation_id","quantity"],"properties":{"product_id":{"type":"string","description":"Product ID"},"quantity":{"type":"integer","description":"Quantity"},"returned_count":{"type":"integer","description":"Returned count"},"assigning_seller_id":{"type":"string","description":"Assigning seller ID"},"quantity_by_combo_products":{"type":"array","description":"Quantity by combo products","items":{"type":"object"}},"discount_each_product":{"type":"integer","description":"Discount for each product"},"is_bonus_product":{"type":"boolean","description":"Is bonus product"},"is_discount_percent":{"type":"boolean","description":"Is discount by percent"},"is_wholesale":{"type":"boolean","description":"Is wholesale"},"is_composite":{"type":"boolean","description":"Is composite product"},"one_time_product":{"type":"boolean","description":"One time product"},"note":{"type":"string","description":"Product note"},"note_product":{"type":"string","description":"Product note"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"measure_group_id":{"type":"integer","description":"Measure group ID"},"variation_info":{"type":"object","description":"Variation information. Optional when creating/updating an order (the backend defaults it to an empty object if omitted). Its inner fields are not individually required, but sending `retail_price` is recommended so the line price is correct.","properties":{"id":{"type":"string","description":"Variation ID"},"name":{"type":"string","description":"Product name"},"product_id":{"type":"string","description":"Product ID"},"retail_price":{"type":"integer","description":"Retail price. Not strictly required, but recommended when creating/updating an order so the line price is correct."},"detail":{"type":"string","description":"Variation detail"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"},"keyValue":{"type":"string","description":"Key value"}}}},"barcode":{"type":"string","description":"Barcode"},"brand_id":{"type":"string","description":"Brand ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"display_id":{"type":"string","description":"Display ID"},"product_display_id":{"type":"string","description":"Product display ID"},"last_imported_price":{"type":"integer","description":"Last imported price"},"is_upsale_product":{"type":"boolean","description":"Upsale product"},"weight":{"type":"integer","description":"Weight"},"measure_info":{"type":"object","description":"Measure information","properties":{"measure_id":{"type":"integer","description":"Measure ID"},"exchange_value":{"type":"integer","description":"Exchange value"}}},"avg_price":{"type":"integer","description":"Average import price"}}},"components":{"type":"array","description":"Product components","items":{"type":"object","properties":{"component_id":{"type":"string","description":"Component ID"},"quantity":{"type":"integer","description":"Quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information"}}}}}}},"partner":{"type":"object","description":"Partner information\nWhen updating an order that already has shipping info, only the fields you send are written; omitted fields keep their current values. Send `null` to clear `partner_id`, `extend_code` or `shop_partner_id`.\n","properties":{"partner_id":{"type":"integer","description":"Partner ID"},"cod":{"type":"integer","description":"Reconciliation COD"},"extend_code":{"type":"string","description":"Shipping order ID on partner system"},"total_fee":{"type":"integer","description":"Total fee"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"delivery_name":{"type":"string","description":"Shipper name"},"delivery_tel":{"type":"string","description":"Delivery phone"},"picked_up_at":{"type":"string","format":"date-time","description":"Picked up at"},"sort_code":{"type":"string","description":"Sort code"},"paid_at":{"type":"string","format":"date-time","description":"Paid at"},"system_created":{"type":"boolean","description":"System created"},"extend_update":{"type":"array","description":"Update from courier","items":{"type":"object","properties":{"key":{"type":"string","description":"Update key"},"status":{"type":"string","description":"Status"},"tracking_id":{"type":"string","description":"Partner extend code"},"note":{"type":"string","description":"Courier notes"},"update_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"partner_status":{"type":"string","nullable":true,"description":"Partner shipping status","enum":["waiting","request_received","processing_picked_up","picking_up","delay_pickup","picked_up","waiting_on_the_way","on_the_way","contact_delivery_company","out_for_delivery","delay_delivery","inform_recipient","undeliverable","waiting_for_return","delivered","delivered_cod","returning","returned","returned_cod","canceled"],"x-enum-descriptions":["Waiting for processing","Carrier received the request","Processing pickup","Picking up","Delayed pickup","Picked up","Waiting for transit","In transit","Contact the carrier","Out for delivery","Delayed delivery","Notify the recipient","Undeliverable","Waiting for return","Delivered","Delivered, COD reconciled","Returning","Returned","Returned, COD reconciled","Canceled"]},"partner_name":{"type":"string","nullable":true,"description":"Partner name"},"first_delivery_at":{"type":"string","format":"date-time","nullable":true,"description":"First delivery time"},"first_undeliverable_at":{"type":"string","format":"date-time","nullable":true,"description":"First failed delivery time"},"count_of_delivery":{"type":"integer","nullable":true,"minimum":0,"maximum":32767,"description":"Number of delivery attempts. Courier updates add 1 each time the shipment moves to `out_for_delivery` or `delay_delivery`.\nCan be set when creating or updating an order (integer 0-32767); omitted or invalid values keep the current value, and later courier updates keep counting from the value you set.\n","example":2},"order_number_vtp":{"type":"string","nullable":true,"description":"Viettel Post tracking number"},"printed_form":{"type":"object","nullable":true,"description":"Printed form"}}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"payment_purchase_histories":{"type":"array","description":"Payment histories","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount of money"},"type":{"type":"string","description":"Payment type"},"inserted_at":{"type":"string","format":"date-time","description":"Transaction time"},"result_code":{"type":"string","description":"Result code"},"ipn_reply":{"type":"boolean","description":"IPN reply"},"voucher_amount":{"type":"integer","description":"Voucher amount"},"tags":{"type":"array","description":"Tags","items":{"type":"string"}}}}},"tags":{"type":"array","description":"Tags list","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"}}}},"marketer":{"type":"object","description":"Marketer information","properties":{"id":{"type":"string","description":"Marketer ID"},"name":{"type":"string","description":"Marketer name"},"email":{"type":"string","description":"Marketer email"},"phone_number":{"type":"string","description":"Marketer phone number"},"fb_id":{"type":"string","description":"Marketer Facebook ID"},"avatar_url":{"type":"string","description":"Marketer avatar URL"}}},"pke_mkter":{"type":"string","description":"Marketer ID"},"activated_combo_products":{"type":"object","description":"Activated combo products information","properties":{"combo_product_id":{"type":"integer","description":"Combo product ID"},"quantity_combo_activated":{"type":"integer","description":"Quantity combo activated"},"combo_product_info":{"type":"object","description":"Combo product information"}}},"activated_promotion_advances":{"type":"array","description":"Activated promotion advances information","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"promotion_advance_id":{"type":"string","description":"Promotion advance ID"},"promotion_advance_info":{"type":"object","description":"Promotion advance information"}}}},"invoice_info_list":{"type":"array","description":"Invoice information list","items":{"type":"object","properties":{"error":{"type":"string","description":"Error message if any"},"invoice_detail":{"type":"object","description":"Invoice detail information. The fields to send depend on `invoice_type`:\n- `company`: use `company_name`, `company_tax_id`, `company_address`, `company_email` (and optionally `company_address_breakdown`).\n- `personal`: use `name`, `phone_number`, `identity_code`, `tax_id`, `email`.\n","properties":{"name":{"type":"string","description":"Full name of the individual requesting the invoice (`invoice_type` = `personal`)","example":"Hoang Anh"},"phone_number":{"type":"string","description":"Phone number of the individual (`invoice_type` = `personal`)","example":"0934283743"},"identity_code":{"type":"string","description":"Citizen identity card / ID number of the individual (`invoice_type` = `personal`)","example":"029374382740"},"tax_id":{"type":"string","description":"Personal tax ID of the individual, if any (`invoice_type` = `personal`)","example":""},"email":{"type":"string","description":"Email of the individual to receive the e-invoice (`invoice_type` = `personal`)","example":""},"company_address":{"type":"string","description":"Company address (`invoice_type` = `company`)"},"company_address_breakdown":{"type":"object","description":"Company address breakdown","properties":{"company_additional_info":{"type":"string","description":"Company additional information"},"company_barangay":{"type":"string","description":"Company barangay"},"company_city":{"type":"string","description":"Company city"},"company_detailed_address":{"type":"string","description":"Company detailed address"},"company_district":{"type":"string","description":"Company district"},"company_full_address":{"type":"string","description":"Company full address"},"company_postcode":{"type":"string","description":"Company postcode"},"company_province":{"type":"string","description":"Company province"},"company_region":{"type":"string","description":"Company region"},"company_state":{"type":"string","description":"Company state"},"company_town":{"type":"string","description":"Company town"}}},"company_email":{"type":"string","description":"Company email (`invoice_type` = `company`)"},"company_name":{"type":"string","description":"Company name (`invoice_type` = `company`)"},"company_tax_id":{"type":"string","description":"Company tax ID (`invoice_type` = `company`)"}}},"invoice_type":{"type":"string","enum":["company","personal"],"description":"Invoice type: `company` for an organization, `personal` for an individual.\nDetermines which `invoice_detail` fields are used.\n","example":"personal"},"is_requested":{"type":"boolean","description":"Customer requests an e-invoice for this order. Set `true` together with `invoice_type` and `invoice_detail` to request invoice issuance.","example":true},"order_sn":{"type":"string","description":"Order code on the marketplace"}}}},"reports_by_phone":{"type":"object","description":"Reports by phone number","properties":{"order_fail":{"type":"integer","description":"Number of failed orders"},"order_success":{"type":"integer","description":"Number of successful orders"},"warning":{"type":"integer","description":"Number of warnings orders"}},"example":{"+639175706297":{"order_fail":29,"order_success":20,"warning":0}}},"tracking_link":{"type":"string","description":"Link confirm order"},"payment_link":{"type":"string","description":"Payment link"},"ads_source":{"type":"string","description":"Advertising source"},"bank_payments":{"type":"object","description":"Payment method"},"transfer_proofs":{"type":"array","description":"Bank transfer payment proofs, including verification time, amount and receipt images","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transfer proof ID"},"order_id":{"type":"integer","description":"Order ID"},"shop_id":{"type":"integer","description":"Shop ID"},"payment_id":{"type":"string","description":"Bank payment method ID (matches a key in `bank_payments`)"},"amount":{"type":"integer","description":"Transferred amount"},"images":{"type":"array","description":"Transfer receipt images","items":{"type":"string"}},"note":{"type":"string","nullable":true,"description":"Note"},"is_income":{"type":"boolean","description":"Money received (true) or paid out (false)"},"is_verify":{"type":"boolean","description":"Whether the transfer has been verified"},"verify_at":{"type":"string","format":"date-time","nullable":true,"description":"Verification time"},"verifier":{"type":"object","nullable":true,"description":"Verifier information","properties":{"id":{"type":"string","description":"Verifier ID"},"name":{"type":"string","description":"Verifier name"},"fb_id":{"type":"string","description":"Facebook ID of verifier"},"avatar_url":{"type":"string","description":"Verifier avatar URL"}}},"creator":{"type":"object","nullable":true,"description":"Creator information","properties":{"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"last_editor":{"type":"object","nullable":true,"description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Editor name"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"avatar_url":{"type":"string","description":"Editor avatar URL"}}},"order_info":{"type":"object","nullable":true,"description":"Additional order information"},"inserted_at":{"type":"string","format":"date-time","description":"Transfer proof creation time"},"updated_at":{"type":"string","format":"date-time","description":"Transfer proof update time"}}}},"shopify_order_id":{"type":"string","description":"Shopify order ID"},"shopify_abandon_checkout_id":{"type":"integer","description":"Shopify abandon checkout ID"},"is_abandoned_order":{"type":"boolean","description":"Abandoned-cart flag for creating or updating an order. Send it directly in the request body, not inside `third_party` or `third_party_infomation`.\nAn 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.\nOnly boolean `true` or string `\"true\"` is normalized to `true`; all other submitted values become `false`.\n","example":true},"cod":{"type":"integer","description":"Cash on delivery"},"cash":{"type":"integer","description":"Cash payment"},"account":{"type":"integer","description":"Order source ID"},"account_name":{"type":"string","description":"Order source name"},"advanced_platform_fee":{"type":"object","description":"Fees from e-commerce platforms","properties":{"ads_top_up":{"type":"integer","description":"Ads wallet top-up"},"affiliate_commission":{"type":"integer","description":"Affiliate commission"},"diff_shipping_fee":{"type":"integer","description":"Difference shipping fee"},"marketplace_voucher":{"type":"integer","description":"Marketplace voucher"},"payment_fee":{"type":"integer","description":"Payment fee"},"platform_commission":{"type":"integer","description":"Platform commission"},"seller_transaction_fee":{"type":"integer","description":"Seller transaction fee"},"service_fee":{"type":"integer","description":"Service fee"},"sfp_service_fee":{"type":"integer","description":"SFP service fee"}}},"printing_count":{"type":"integer","description":"Printing count"},"money_to_collect":{"type":"integer","description":"Money to collect"},"marketplace_id":{"type":"string","description":"Marketplace ID","enum":["-2","-3","-4","-9","-16","-17","-20","-25","-27","-28"],"x-enum-descriptions":{"-2":"Tiki","-3":"Shopee","-4":"Lazada","-9":"TikTok","-16":"WooCommerce","-17":"Shopify","-20":"Line Shopping","-25":"Tokopedia","-27":"Mercado Libre","-28":"Tiendanube"}},"total_price":{"type":"integer","description":"Total price"},"shop_customer_address_id":{"type":"string","description":"Customer address ID"},"customer":{"type":"object","description":"Customer information","properties":{"fb_id":{"type":"string","description":"Customer Facebook ID"},"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Customer name"},"page_id":{"type":"string","description":"Page ID"}}},"total_quantity":{"type":"integer","description":"Total quantity"},"time_assign_marketer":{"type":"string","format":"date-time","description":"Time assign marketer"},"p_utm_source":{"type":"string","description":"UTM Source"},"p_utm_medium":{"type":"string","description":"UTM Medium"},"p_utm_campaign":{"type":"string","description":"UTM Campaign"},"p_utm_term":{"type":"string","description":"UTM Term"},"p_utm_content":{"type":"string","description":"UTM Content"},"p_utm_id":{"type":"string","description":"UTM ID"},"utm_affiliate":{"type":"string","description":"Affiliate"},"link":{"type":"string","description":"Link"},"status_history":{"type":"array","description":"Status update history","items":{"type":"object","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"editor":{"type":"object","description":"Editor information"},"editor_fb":{"type":"string","description":"Editor Facebook ID"},"editor_id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Name"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Status"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"duplicated_phone":{"type":"boolean","description":"Duplicated phone"},"order_currency":{"type":"string","description":"Order currency"},"charged_by_vnpay":{"type":"integer","description":"Charged by VNPay"},"charged_by_qrpay":{"type":"integer","description":"Charged by QRPay"},"custom_id":{"type":"string","description":"Custom ID"},"last_editor":{"type":"object","description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"name":{"type":"string","description":"Editor name"},"email":{"type":"string","description":"Editor email"},"avatar_url":{"type":"string","description":"Editor avatar URL"},"phone_number":{"type":"string","description":"Editor phone number"}}},"last_editor_id":{"type":"string","description":"Last editor ID"},"charged_by_momo":{"type":"integer","description":"Charged by MoMo"},"prepaid_by_point":{"type":"object","description":"Prepaid by point","properties":{"money":{"type":"integer","description":"Money amount","example":15000},"point":{"type":"integer","description":"Point amount","example":15}},"example":{"money":15000,"point":15}},"bank_transfer_images":{"type":"array","description":"Bank transfer images","items":{"type":"string","format":"uri"}},"transfer_money":{"type":"integer","description":"Transfer money"},"lock_order_by_user":{"type":"string","description":"Lock order by user ID"},"assigning_care":{"type":"object","description":"Assigning care information","properties":{"id":{"type":"string","description":"Care ID"},"fb_id":{"type":"string","description":"Facebook ID of care"},"name":{"type":"string","description":"Care name"},"email":{"type":"string","description":"Care email"},"avatar_url":{"type":"string","description":"Care avatar URL"},"phone_number":{"type":"string","description":"Care phone number"}}},"assigning_care_id":{"type":"string","description":"Assigning care ID"},"time_assign_care":{"type":"string","format":"date-time","description":"Time assign care"},"assigning_seller":{"type":"object","description":"Assigning seller information","properties":{"id":{"type":"string","description":"Seller ID"},"fb_id":{"type":"string","description":"Facebook ID of seller"},"name":{"type":"string","description":"Seller name"},"email":{"type":"string","description":"Seller email"},"avatar_url":{"type":"string","description":"Seller avatar URL"},"phone_number":{"type":"string","description":"Seller phone number"}}},"einvoices":{"type":"array","items":{"$ref":"#/components/schemas/EInvoice"}},"charged_by_card":{"type":"integer","description":"Charged by card"},"estimate_delivery_date":{"type":"string","format":"date-time","description":"Estimate delivery date"},"order_sources":{"type":"string","description":"Order sources ID"},"charged_by_fundiin":{"type":"integer","description":"Charged by Fundiin"},"surcharge":{"type":"integer","description":"Surcharge"},"is_linked_partner":{"type":"boolean","description":"Is linked partner"},"call_laters":{"type":"array","description":"Call laters","items":{"type":"object"}},"last_update_status_at":{"type":"string","format":"date-time","description":"Last update status at"},"discount_by_customer_level":{"type":"integer","description":"Discount by customer level"},"viewing":{"type":"array","description":"Viewing","items":{"type":"object"}},"additional_info":{"type":"object","description":"Additional info","properties":{"service_partner":{"type":"string","description":"Service partner","enum":["instant"],"x-enum-descriptions":["Instant"]},"delivery_deadline":{"type":"string","format":"date-time","description":"Delivery deadline (ISO8601, no timezone).","example":"2026-06-03T10:00:00"},"ship_by_date":{"type":"integer","nullable":true,"readOnly":true,"description":"Marketplace ship-by deadline (Unix timestamp, seconds) for Shopee/TikTok orders — the order must be handed over to the carrier before this time, otherwise the marketplace may cancel it automatically. Shopee `ship_by_date`, TikTok `collection_due_time`. `0` = the marketplace has not returned it yet; `null` for non-marketplace orders.","example":1793000000}}},"order_returned_ids":{"type":"string","description":"Order returned IDs"},"cost_surcharge":{"type":"integer","description":"Cost surcharge"},"time_send_partner":{"type":"string","format":"date-time","description":"Time send partner"},"charged_by_kredivo":{"type":"integer","description":"Charged by Kredivo"},"discount":{"type":"integer","description":"Discount"},"histories":{"type":"array","description":"Histories","items":{"type":"object"}},"duplicated_customer":{"type":"boolean","description":"Duplicated customer"},"customer_referral_code":{"type":"object","description":"Customer referral code","properties":{"active":{"type":"string","description":"Active status","example":"true"},"customer_id":{"type":"string","format":"uuid","description":"Customer ID","example":"09bb9399-45f3-4897-a53a-85dde2f886fe"},"discount":{"type":"string","description":"Discount value","example":"10"},"format":{"type":"string","description":"Referral code format","example":"{PHONE_NUMBER}"},"free_products_priced_between_approx":{"type":"object","description":"Free products priced between approximately","properties":{"active":{"type":"string","description":"Active status","example":"true"},"operator":{"type":"string","description":"Comparison operator","example":"GreaterOrEqual"},"price":{"type":"string","description":"Price threshold","example":"150000"}}},"is_percent":{"type":"string","description":"Discount is percentage","example":"true"},"only_customers_with_level_will_have_referral_code":{"type":"string","description":"Only customers with level will have referral code","example":"true"},"referral_code":{"type":"string","description":"Referral code","example":"982843759"},"reward_points_for_old_customers":{"type":"object","description":"Reward points for customers","properties":{"active":{"type":"string","description":"Active status","example":"true"},"money":{"type":"string","description":"Money reward","example":"10000"},"point":{"type":"string","description":"Point reward","example":"1"}}},"shop_customer_id":{"type":"string","format":"uuid","description":"Shop customer ID","example":"f8160a4c-dfa7-4ee8-b540-d245755ea1f1"}},"example":{"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"}},"tax":{"type":"integer","description":"Tax"},"is_from_ecommerce":{"type":"boolean","description":"Is from e-commerce"},"note_image":{"type":"array","description":"Note images","items":{"type":"string","format":"uri"}},"shopify_draft_order_id":{"type":"string","description":"Shopify draft order ID"},"display_id":{"type":"integer","description":"Display ID"},"shop_partner_id":{"type":"integer","description":"Shop partner ID"},"is_locked":{"type":"boolean","description":"Order lock"},"merge_order":{"type":"boolean","description":"Allows merging orders"}}},"OrderInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Order ID"},"system_id":{"type":"integer","description":"System ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Order creation time"},"updated_at":{"type":"string","format":"date-time","description":"Order update time"},"status":{"type":"integer","description":"Order status","enum":[0,17,11,12,13,20,1,8,9,2,3,16,4,15,5,6,7],"x-enum-descriptions":["New","Waiting for confirmation","Restocking","Wait for printing","Printed","Purchased","Confirmed","Packaging","Waiting for pick up","Shipped","Received","Collected money","Returning","Partial return","Returned","Canceled","Deleted recently"]},"status_name":{"type":"string","description":"Order status name"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"bill_email":{"type":"string","description":"Customer email"},"conversation_id":{"type":"string","description":"Conversation ID"},"page_id":{"type":"string","description":"Facebook page ID"},"post_id":{"type":"string","description":"Post ID"},"ad_id":{"type":"string","description":"Ad ID"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"partner_fee":{"type":"integer","description":"Fee from shipping partner"},"fee_marketplace":{"type":"integer","description":"Fees from e-commerce platforms"},"customer_pay_fee":{"type":"boolean","description":"Customer pay shipping fee"},"is_free_shipping":{"type":"boolean","description":"Free shipping"},"is_livestream":{"type":"boolean","description":"Is livestream order"},"is_live_shopping":{"type":"boolean","description":"Is live shopping order"},"is_smc":{"type":"boolean","description":"Shopping on Messenger"},"received_at_shop":{"type":"boolean","description":"true: Sales at counter, false: Sell online"},"total_discount":{"type":"integer","description":"Discount total"},"note":{"type":"string","description":"Internal note"},"note_print":{"type":"string","description":"Note for printing"},"returned_reason":{"type":"integer","description":"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_name":{"type":"string","description":"Return reason name"},"sub_status":{"type":"integer","description":"Reason for delivery delay"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"warehouse_info":{"type":"object","description":"Warehouse information","properties":{"name":{"type":"string","description":"Warehouse name"},"phone_number":{"type":"string","description":"Warehouse phone number"},"full_address":{"type":"string","description":"Warehouse full address"},"address":{"type":"string","description":"Warehouse address"},"province_id":{"type":"string","description":"Province ID"},"district_id":{"type":"string","description":"District ID"},"commune_id":{"type":"string","description":"Commune ID"},"affiliate_id":{"type":"string","description":"Affiliate ID"},"ffm_id":{"type":"string","description":"FFM ID"},"has_snappy_service":{"type":"boolean","description":"Has Snappy service"},"custom_id":{"type":"string","description":"Custom ID"}}},"creator_id":{"type":"string","description":"Creator ID"},"creator":{"type":"object","description":"Order creator","properties":{"id":{"type":"string","description":"Creator ID"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"name":{"type":"string","description":"Creator name"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"items":{"type":"array","description":"Product list. When creating or updating an order, each entry must include `variation_id` and `quantity`. `variation_info` is optional — if omitted, the backend treats it as an empty object; send it (with `retail_price`) when you need the line price to be explicit.","items":{"type":"object","required":["variation_id","quantity"],"properties":{"product_id":{"type":"string","description":"Product ID"},"quantity":{"type":"integer","description":"Quantity"},"returned_count":{"type":"integer","description":"Returned count"},"assigning_seller_id":{"type":"string","description":"Assigning seller ID"},"quantity_by_combo_products":{"type":"array","description":"Quantity by combo products","items":{"type":"object"}},"discount_each_product":{"type":"integer","description":"Discount for each product"},"is_bonus_product":{"type":"boolean","description":"Is bonus product"},"is_discount_percent":{"type":"boolean","description":"Is discount by percent"},"is_wholesale":{"type":"boolean","description":"Is wholesale"},"is_composite":{"type":"boolean","description":"Is composite product"},"one_time_product":{"type":"boolean","description":"One time product"},"note":{"type":"string","description":"Product note"},"note_product":{"type":"string","description":"Product note"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"measure_group_id":{"type":"integer","description":"Measure group ID"},"variation_info":{"type":"object","description":"Variation information. Optional when creating/updating an order (the backend defaults it to an empty object if omitted). Its inner fields are not individually required, but sending `retail_price` is recommended so the line price is correct.","properties":{"id":{"type":"string","description":"Variation ID"},"name":{"type":"string","description":"Product name"},"product_id":{"type":"string","description":"Product ID"},"retail_price":{"type":"integer","description":"Retail price. Not strictly required, but recommended when creating/updating an order so the line price is correct."},"detail":{"type":"string","description":"Variation detail"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"},"keyValue":{"type":"string","description":"Key value"}}}},"barcode":{"type":"string","description":"Barcode"},"brand_id":{"type":"string","description":"Brand ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"display_id":{"type":"string","description":"Display ID"},"product_display_id":{"type":"string","description":"Product display ID"},"last_imported_price":{"type":"integer","description":"Last imported price"},"is_upsale_product":{"type":"boolean","description":"Upsale product"},"weight":{"type":"integer","description":"Weight"},"measure_info":{"type":"object","description":"Measure information","properties":{"measure_id":{"type":"integer","description":"Measure ID"},"exchange_value":{"type":"integer","description":"Exchange value"}}},"avg_price":{"type":"integer","description":"Average import price"}}},"components":{"type":"array","description":"Product components","items":{"type":"object","properties":{"component_id":{"type":"string","description":"Component ID"},"quantity":{"type":"integer","description":"Quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information"}}}},"id":{"type":"integer","description":"Item ID"},"variation_id":{"type":"string","description":"Variation ID"}}}},"partner":{"type":"object","description":"Partner information\nWhen updating an order that already has shipping info, only the fields you send are written; omitted fields keep their current values. Send `null` to clear `partner_id`, `extend_code` or `shop_partner_id`.\n","properties":{"partner_id":{"type":"integer","description":"Partner ID"},"cod":{"type":"integer","description":"Reconciliation COD"},"extend_code":{"type":"string","description":"Shipping order ID on partner system"},"total_fee":{"type":"integer","description":"Total fee"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"delivery_name":{"type":"string","description":"Shipper name"},"delivery_tel":{"type":"string","description":"Delivery phone"},"picked_up_at":{"type":"string","format":"date-time","description":"Picked up at"},"sort_code":{"type":"string","description":"Sort code"},"paid_at":{"type":"string","format":"date-time","description":"Paid at"},"system_created":{"type":"boolean","description":"System created"},"extend_update":{"type":"array","description":"Update from courier","items":{"type":"object","properties":{"key":{"type":"string","description":"Update key"},"status":{"type":"string","description":"Status"},"tracking_id":{"type":"string","description":"Partner extend code"},"note":{"type":"string","description":"Courier notes"},"update_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"partner_status":{"type":"string","nullable":true,"description":"Partner shipping status","enum":["waiting","request_received","processing_picked_up","picking_up","delay_pickup","picked_up","waiting_on_the_way","on_the_way","contact_delivery_company","out_for_delivery","delay_delivery","inform_recipient","undeliverable","waiting_for_return","delivered","delivered_cod","returning","returned","returned_cod","canceled"],"x-enum-descriptions":["Waiting for processing","Carrier received the request","Processing pickup","Picking up","Delayed pickup","Picked up","Waiting for transit","In transit","Contact the carrier","Out for delivery","Delayed delivery","Notify the recipient","Undeliverable","Waiting for return","Delivered","Delivered, COD reconciled","Returning","Returned","Returned, COD reconciled","Canceled"]},"partner_name":{"type":"string","nullable":true,"description":"Partner name"},"first_delivery_at":{"type":"string","format":"date-time","nullable":true,"description":"First delivery time"},"first_undeliverable_at":{"type":"string","format":"date-time","nullable":true,"description":"First failed delivery time"},"count_of_delivery":{"type":"integer","nullable":true,"minimum":0,"maximum":32767,"description":"Number of delivery attempts. Courier updates add 1 each time the shipment moves to `out_for_delivery` or `delay_delivery`.\nCan be set when creating or updating an order (integer 0-32767); omitted or invalid values keep the current value, and later courier updates keep counting from the value you set.\n","example":2},"order_number_vtp":{"type":"string","nullable":true,"description":"Viettel Post tracking number"},"printed_form":{"type":"object","nullable":true,"description":"Printed form"}}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"payment_purchase_histories":{"type":"array","description":"Payment histories","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount of money"},"type":{"type":"string","description":"Payment type"},"inserted_at":{"type":"string","format":"date-time","description":"Transaction time"},"result_code":{"type":"string","description":"Result code"},"ipn_reply":{"type":"boolean","description":"IPN reply"},"voucher_amount":{"type":"integer","description":"Voucher amount"},"tags":{"type":"array","description":"Tags","items":{"type":"string"}}}}},"tags":{"type":"array","description":"Tags list","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"}}}},"marketer":{"type":"object","description":"Marketer information","properties":{"id":{"type":"string","description":"Marketer ID"},"name":{"type":"string","description":"Marketer name"},"email":{"type":"string","description":"Marketer email"},"phone_number":{"type":"string","description":"Marketer phone number"},"fb_id":{"type":"string","description":"Marketer Facebook ID"},"avatar_url":{"type":"string","description":"Marketer avatar URL"}}},"pke_mkter":{"type":"string","description":"Marketer ID"},"activated_combo_products":{"type":"object","description":"Activated combo products information","properties":{"combo_product_id":{"type":"integer","description":"Combo product ID"},"quantity_combo_activated":{"type":"integer","description":"Quantity combo activated"},"combo_product_info":{"type":"object","description":"Combo product information"}}},"activated_promotion_advances":{"type":"array","description":"Activated promotion advances information","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"promotion_advance_id":{"type":"string","description":"Promotion advance ID"},"promotion_advance_info":{"type":"object","description":"Promotion advance information"}}}},"invoice_info_list":{"type":"array","description":"Invoice information list","items":{"type":"object","properties":{"error":{"type":"string","description":"Error message if any"},"invoice_detail":{"type":"object","description":"Invoice detail information. The fields to send depend on `invoice_type`:\n- `company`: use `company_name`, `company_tax_id`, `company_address`, `company_email` (and optionally `company_address_breakdown`).\n- `personal`: use `name`, `phone_number`, `identity_code`, `tax_id`, `email`.\n","properties":{"name":{"type":"string","description":"Full name of the individual requesting the invoice (`invoice_type` = `personal`)","example":"Hoang Anh"},"phone_number":{"type":"string","description":"Phone number of the individual (`invoice_type` = `personal`)","example":"0934283743"},"identity_code":{"type":"string","description":"Citizen identity card / ID number of the individual (`invoice_type` = `personal`)","example":"029374382740"},"tax_id":{"type":"string","description":"Personal tax ID of the individual, if any (`invoice_type` = `personal`)","example":""},"email":{"type":"string","description":"Email of the individual to receive the e-invoice (`invoice_type` = `personal`)","example":""},"company_address":{"type":"string","description":"Company address (`invoice_type` = `company`)"},"company_address_breakdown":{"type":"object","description":"Company address breakdown","properties":{"company_additional_info":{"type":"string","description":"Company additional information"},"company_barangay":{"type":"string","description":"Company barangay"},"company_city":{"type":"string","description":"Company city"},"company_detailed_address":{"type":"string","description":"Company detailed address"},"company_district":{"type":"string","description":"Company district"},"company_full_address":{"type":"string","description":"Company full address"},"company_postcode":{"type":"string","description":"Company postcode"},"company_province":{"type":"string","description":"Company province"},"company_region":{"type":"string","description":"Company region"},"company_state":{"type":"string","description":"Company state"},"company_town":{"type":"string","description":"Company town"}}},"company_email":{"type":"string","description":"Company email (`invoice_type` = `company`)"},"company_name":{"type":"string","description":"Company name (`invoice_type` = `company`)"},"company_tax_id":{"type":"string","description":"Company tax ID (`invoice_type` = `company`)"}}},"invoice_type":{"type":"string","enum":["company","personal"],"description":"Invoice type: `company` for an organization, `personal` for an individual.\nDetermines which `invoice_detail` fields are used.\n","example":"personal"},"is_requested":{"type":"boolean","description":"Customer requests an e-invoice for this order. Set `true` together with `invoice_type` and `invoice_detail` to request invoice issuance.","example":true},"order_sn":{"type":"string","description":"Order code on the marketplace"}}}},"reports_by_phone":{"type":"object","description":"Reports by phone number","properties":{"order_fail":{"type":"integer","description":"Number of failed orders"},"order_success":{"type":"integer","description":"Number of successful orders"},"warning":{"type":"integer","description":"Number of warnings orders"}},"example":{"+639175706297":{"order_fail":29,"order_success":20,"warning":0}}},"tracking_link":{"type":"string","description":"Link confirm order"},"payment_link":{"type":"string","description":"Payment link"},"ads_source":{"type":"string","description":"Advertising source"},"bank_payments":{"type":"object","description":"Payment method"},"transfer_proofs":{"type":"array","description":"Bank transfer payment proofs, including verification time, amount and receipt images","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transfer proof ID"},"order_id":{"type":"integer","description":"Order ID"},"shop_id":{"type":"integer","description":"Shop ID"},"payment_id":{"type":"string","description":"Bank payment method ID (matches a key in `bank_payments`)"},"amount":{"type":"integer","description":"Transferred amount"},"images":{"type":"array","description":"Transfer receipt images","items":{"type":"string"}},"note":{"type":"string","nullable":true,"description":"Note"},"is_income":{"type":"boolean","description":"Money received (true) or paid out (false)"},"is_verify":{"type":"boolean","description":"Whether the transfer has been verified"},"verify_at":{"type":"string","format":"date-time","nullable":true,"description":"Verification time"},"verifier":{"type":"object","nullable":true,"description":"Verifier information","properties":{"id":{"type":"string","description":"Verifier ID"},"name":{"type":"string","description":"Verifier name"},"fb_id":{"type":"string","description":"Facebook ID of verifier"},"avatar_url":{"type":"string","description":"Verifier avatar URL"}}},"creator":{"type":"object","nullable":true,"description":"Creator information","properties":{"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"last_editor":{"type":"object","nullable":true,"description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Editor name"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"avatar_url":{"type":"string","description":"Editor avatar URL"}}},"order_info":{"type":"object","nullable":true,"description":"Additional order information"},"inserted_at":{"type":"string","format":"date-time","description":"Transfer proof creation time"},"updated_at":{"type":"string","format":"date-time","description":"Transfer proof update time"}}}},"shopify_order_id":{"type":"string","description":"Shopify order ID"},"shopify_abandon_checkout_id":{"type":"integer","description":"Shopify abandon checkout ID"},"is_abandoned_order":{"type":"boolean","description":"Abandoned-cart flag for creating or updating an order. Send it directly in the request body, not inside `third_party` or `third_party_infomation`.\nAn 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.\nOnly boolean `true` or string `\"true\"` is normalized to `true`; all other submitted values become `false`.\n","example":true},"cod":{"type":"integer","description":"Cash on delivery"},"cash":{"type":"integer","description":"Cash payment"},"account":{"type":"integer","description":"Order source ID"},"account_name":{"type":"string","description":"Order source name"},"advanced_platform_fee":{"type":"object","description":"Fees from e-commerce platforms","properties":{"ads_top_up":{"type":"integer","description":"Ads wallet top-up"},"affiliate_commission":{"type":"integer","description":"Affiliate commission"},"diff_shipping_fee":{"type":"integer","description":"Difference shipping fee"},"marketplace_voucher":{"type":"integer","description":"Marketplace voucher"},"payment_fee":{"type":"integer","description":"Payment fee"},"platform_commission":{"type":"integer","description":"Platform commission"},"seller_transaction_fee":{"type":"integer","description":"Seller transaction fee"},"service_fee":{"type":"integer","description":"Service fee"},"sfp_service_fee":{"type":"integer","description":"SFP service fee"}}},"printing_count":{"type":"integer","description":"Printing count"},"money_to_collect":{"type":"integer","description":"Money to collect"},"marketplace_id":{"type":"string","description":"Marketplace ID","enum":["-2","-3","-4","-9","-16","-17","-20","-25","-27","-28"],"x-enum-descriptions":{"-2":"Tiki","-3":"Shopee","-4":"Lazada","-9":"TikTok","-16":"WooCommerce","-17":"Shopify","-20":"Line Shopping","-25":"Tokopedia","-27":"Mercado Libre","-28":"Tiendanube"}},"total_price":{"type":"integer","description":"Total price"},"shop_customer_address_id":{"type":"string","description":"Customer address ID"},"customer":{"type":"object","description":"Customer information","properties":{"fb_id":{"type":"string","description":"Customer Facebook ID"},"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Customer name"},"page_id":{"type":"string","description":"Page ID"}}},"total_quantity":{"type":"integer","description":"Total quantity"},"time_assign_marketer":{"type":"string","format":"date-time","description":"Time assign marketer"},"p_utm_source":{"type":"string","description":"UTM Source"},"p_utm_medium":{"type":"string","description":"UTM Medium"},"p_utm_campaign":{"type":"string","description":"UTM Campaign"},"p_utm_term":{"type":"string","description":"UTM Term"},"p_utm_content":{"type":"string","description":"UTM Content"},"p_utm_id":{"type":"string","description":"UTM ID"},"utm_affiliate":{"type":"string","description":"Affiliate"},"link":{"type":"string","description":"Link"},"status_history":{"type":"array","description":"Status update history","items":{"type":"object","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"editor":{"type":"object","description":"Editor information"},"editor_fb":{"type":"string","description":"Editor Facebook ID"},"editor_id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Name"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Status"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"duplicated_phone":{"type":"boolean","description":"Duplicated phone"},"order_currency":{"type":"string","description":"Order currency"},"charged_by_vnpay":{"type":"integer","description":"Charged by VNPay"},"charged_by_qrpay":{"type":"integer","description":"Charged by QRPay"},"custom_id":{"type":"string","description":"Custom ID"},"last_editor":{"type":"object","description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"name":{"type":"string","description":"Editor name"},"email":{"type":"string","description":"Editor email"},"avatar_url":{"type":"string","description":"Editor avatar URL"},"phone_number":{"type":"string","description":"Editor phone number"}}},"last_editor_id":{"type":"string","description":"Last editor ID"},"charged_by_momo":{"type":"integer","description":"Charged by MoMo"},"prepaid_by_point":{"type":"object","description":"Prepaid by point","properties":{"money":{"type":"integer","description":"Money amount","example":15000},"point":{"type":"integer","description":"Point amount","example":15}},"example":{"money":15000,"point":15}},"bank_transfer_images":{"type":"array","description":"Bank transfer images","items":{"type":"string","format":"uri"}},"transfer_money":{"type":"integer","description":"Transfer money"},"lock_order_by_user":{"type":"string","description":"Lock order by user ID"},"assigning_care":{"type":"object","description":"Assigning care information","properties":{"id":{"type":"string","description":"Care ID"},"fb_id":{"type":"string","description":"Facebook ID of care"},"name":{"type":"string","description":"Care name"},"email":{"type":"string","description":"Care email"},"avatar_url":{"type":"string","description":"Care avatar URL"},"phone_number":{"type":"string","description":"Care phone number"}}},"assigning_care_id":{"type":"string","description":"Assigning care ID"},"time_assign_care":{"type":"string","format":"date-time","description":"Time assign care"},"assigning_seller":{"type":"object","description":"Assigning seller information","properties":{"id":{"type":"string","description":"Seller ID"},"fb_id":{"type":"string","description":"Facebook ID of seller"},"name":{"type":"string","description":"Seller name"},"email":{"type":"string","description":"Seller email"},"avatar_url":{"type":"string","description":"Seller avatar URL"},"phone_number":{"type":"string","description":"Seller phone number"}}},"einvoices":{"type":"array","items":{"$ref":"#/components/schemas/EInvoice"}},"charged_by_card":{"type":"integer","description":"Charged by card"},"estimate_delivery_date":{"type":"string","format":"date-time","description":"Estimate delivery date"},"order_sources":{"type":"string","description":"Order sources ID"},"charged_by_fundiin":{"type":"integer","description":"Charged by Fundiin"},"surcharge":{"type":"integer","description":"Surcharge"},"is_linked_partner":{"type":"boolean","description":"Is linked partner"},"call_laters":{"type":"array","description":"Call laters","items":{"type":"object"}},"last_update_status_at":{"type":"string","format":"date-time","description":"Last update status at"},"discount_by_customer_level":{"type":"integer","description":"Discount by customer level"},"viewing":{"type":"array","description":"Viewing","items":{"type":"object"}},"additional_info":{"type":"object","description":"Additional info","properties":{"service_partner":{"type":"string","description":"Service partner","enum":["instant"],"x-enum-descriptions":["Instant"]},"delivery_deadline":{"type":"string","format":"date-time","description":"Delivery deadline (ISO8601, no timezone).","example":"2026-06-03T10:00:00"},"ship_by_date":{"type":"integer","nullable":true,"readOnly":true,"description":"Marketplace ship-by deadline (Unix timestamp, seconds) for Shopee/TikTok orders — the order must be handed over to the carrier before this time, otherwise the marketplace may cancel it automatically. Shopee `ship_by_date`, TikTok `collection_due_time`. `0` = the marketplace has not returned it yet; `null` for non-marketplace orders.","example":1793000000}}},"order_returned_ids":{"type":"string","description":"Order returned IDs"},"cost_surcharge":{"type":"integer","description":"Cost surcharge"},"time_send_partner":{"type":"string","format":"date-time","description":"Time send partner"},"charged_by_kredivo":{"type":"integer","description":"Charged by Kredivo"},"discount":{"type":"integer","description":"Discount"},"histories":{"type":"array","description":"Histories","items":{"type":"object"}},"duplicated_customer":{"type":"boolean","description":"Duplicated customer"},"customer_referral_code":{"type":"object","description":"Customer referral code","properties":{"active":{"type":"string","description":"Active status","example":"true"},"customer_id":{"type":"string","format":"uuid","description":"Customer ID","example":"09bb9399-45f3-4897-a53a-85dde2f886fe"},"discount":{"type":"string","description":"Discount value","example":"10"},"format":{"type":"string","description":"Referral code format","example":"{PHONE_NUMBER}"},"free_products_priced_between_approx":{"type":"object","description":"Free products priced between approximately","properties":{"active":{"type":"string","description":"Active status","example":"true"},"operator":{"type":"string","description":"Comparison operator","example":"GreaterOrEqual"},"price":{"type":"string","description":"Price threshold","example":"150000"}}},"is_percent":{"type":"string","description":"Discount is percentage","example":"true"},"only_customers_with_level_will_have_referral_code":{"type":"string","description":"Only customers with level will have referral code","example":"true"},"referral_code":{"type":"string","description":"Referral code","example":"982843759"},"reward_points_for_old_customers":{"type":"object","description":"Reward points for customers","properties":{"active":{"type":"string","description":"Active status","example":"true"},"money":{"type":"string","description":"Money reward","example":"10000"},"point":{"type":"string","description":"Point reward","example":"1"}}},"shop_customer_id":{"type":"string","format":"uuid","description":"Shop customer ID","example":"f8160a4c-dfa7-4ee8-b540-d245755ea1f1"}},"example":{"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"}},"tax":{"type":"integer","description":"Tax"},"is_from_ecommerce":{"type":"boolean","description":"Is from e-commerce"},"note_image":{"type":"array","description":"Note images","items":{"type":"string","format":"uri"}},"shopify_draft_order_id":{"type":"string","description":"Shopify draft order ID"},"display_id":{"type":"integer","description":"Display ID"},"shop_partner_id":{"type":"integer","description":"Shop partner ID"},"is_locked":{"type":"boolean","description":"Order lock"},"merge_order":{"type":"boolean","description":"Allows merging orders"}}},"EInvoice":{"type":"object","description":"E-invoice information","properties":{"actual_shipping_fee":{"type":"integer","description":"Shipping fee"},"adjust_amount":{"type":"integer","nullable":true,"description":"Percentage reduction on revenue"},"adjustment_criteria":{"type":"integer","nullable":true,"description":"Adjustment criteria","enum":[1,2,3,4],"x-enum-descriptions":["Quantity adjustment","Price adjustment","Tax rate adjustment","Tax amount adjustment"]},"adjustment_type":{"type":"integer","nullable":true,"description":"Adjustment type","enum":[1,2,3],"x-enum-descriptions":["Increase adjustment","Decrease adjustment","Information"]},"allocation_discounts":{"type":"array","description":"Allocation discounts","items":{"type":"object"}},"allocation_type":{"type":"integer","description":"Allocation type","enum":[1,2],"x-enum-descriptions":["By unit price","custom"]},"bank_account_number":{"type":"string","nullable":true,"description":"Bank account number"},"bank_name":{"type":"string","nullable":true,"description":"Bank name"},"budget_unit_code":{"type":"string","nullable":true,"description":"Budget unit code"},"buyer_not_get_invoice":{"type":"boolean","description":"Buyer not get invoice"},"creator":{"type":"object","nullable":true,"description":"Creator information","properties":{"avatar_url":{"type":"string","nullable":true,"description":"Avatar URL"},"fb_id":{"type":"string","nullable":true,"description":"Facebook ID"},"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"}}},"discount":{"type":"integer","description":"General discount amount"},"display_id":{"type":"integer","description":"Display ID"},"einvoice_account_id":{"type":"integer","nullable":true,"description":"E-invoice account ID"},"email":{"type":"string","description":"Email address"},"full_name":{"type":"string","description":"Buyer's name"},"id":{"type":"integer","description":"Invoice ID"},"identity_code":{"type":"string","nullable":true,"description":"Buyer's identity code"},"included_tax":{"type":"integer","description":"Included tax"},"invoice_no":{"type":"string","description":"Invoice number"},"invoice_series":{"type":"string","description":"Invoice series"},"invoice_type":{"type":"integer","nullable":true,"description":"Invoice type"},"is_adjust_amount":{"type":"boolean","description":"Is adjust amount"},"is_included_tax":{"type":"boolean","description":"Is included tax"},"items":{"type":"array","description":"Invoice items","items":{"type":"object","properties":{"adjust_amount":{"type":"integer","nullable":true,"description":"Adjust amount"},"discount":{"type":"integer","description":"Discount amount"},"id":{"type":"integer","description":"Item ID"},"is_calculation_tax":{"type":"boolean","description":"Is calculation tax"},"is_component":{"type":"boolean","description":"Is component"},"is_surcharge":{"type":"boolean","nullable":true,"description":"Is surcharge"},"measure":{"type":"string","nullable":true,"description":"Measure"},"note":{"type":"string","nullable":true,"description":"Note"},"order_id":{"type":"integer","description":"Order ID"},"order_item_id":{"type":"integer","description":"Order item ID"},"quantity":{"type":"integer","description":"Quantity"},"retail_price":{"type":"integer","description":"Retail price"},"tax":{"type":"integer","description":"Tax rate"},"type":{"type":"integer","description":"Item type"},"variation":{"type":"object","nullable":true,"description":"Variation information","properties":{"custom_id":{"type":"string","nullable":true,"description":"Custom ID"},"display_id":{"type":"integer","description":"Display ID"},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"keyValue":{"type":"string","description":"Key value"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"}}}},"product":{"type":"object","nullable":true,"description":"Product information","properties":{"custom_id":{"type":"string","nullable":true,"description":"Product custom ID"},"display_id":{"type":"integer","description":"Product display ID"},"name":{"type":"string","description":"Product name"}}},"product_id":{"type":"string","nullable":true,"description":"Product ID"}}},"variation_id":{"type":"string","nullable":true,"description":"Variation ID"},"variation_info":{"type":"object","nullable":true,"description":"Variation information details","properties":{"detail":{"type":"string","nullable":true,"description":"Variation detail"},"diff_discount":{"type":"integer","nullable":true,"description":"Different discount"},"discount":{"type":"integer","nullable":true,"description":"Discount amount"},"item_total_amount_with_tax":{"type":"integer","nullable":true,"description":"Item total amount with tax"},"item_total_amount_without_tax":{"type":"integer","nullable":true,"description":"Item total amount without tax"},"measure_info":{"type":"string","nullable":true,"description":"Measure information"},"name":{"type":"string","nullable":true,"description":"Product name"},"product_id":{"type":"string","nullable":true,"description":"Product ID"},"product_tags":{"type":"array","description":"Product tags","items":{"type":"string"}},"tax_amount":{"type":"integer","nullable":true,"description":"Tax amount"},"tax_rate":{"type":"integer","nullable":true,"description":"Tax rate"},"unit_price":{"type":"integer","nullable":true,"description":"Unit price"}}}}}},"key_search":{"type":"string","nullable":true,"description":"Key search"},"last_editor_id":{"type":"string","nullable":true,"description":"Last editor ID"},"note":{"type":"string","nullable":true,"description":"Note"},"order_id":{"type":"integer","description":"Order ID"},"order_info":{"type":"object","nullable":true,"description":"Order information","properties":{"account":{"type":"string","nullable":true,"description":"Account"},"account_source":{"type":"string","nullable":true,"description":"Account source"},"cod":{"type":"integer","description":"COD amount"},"custom_id":{"type":"string","nullable":true,"description":"Custom ID"},"display_id":{"type":"integer","description":"Display ID"},"order_currency":{"type":"string","description":"Order currency"},"order_sources":{"type":"string","nullable":true,"description":"Order sources"},"page":{"type":"object","nullable":true,"description":"Page information","properties":{"id":{"type":"string","description":"Page ID"},"name":{"type":"string","nullable":true,"description":"Page name"},"username":{"type":"string","nullable":true,"description":"Username"}}},"page_id":{"type":"string","nullable":true,"description":"Page ID"},"partner":{"type":"object","nullable":true,"description":"Partner information","properties":{"extend_code":{"type":"string","nullable":true,"description":"Extend code"},"partner_id":{"type":"integer","description":"Partner ID"}}},"shop_customer_id":{"type":"string","nullable":true,"description":"Shop customer ID"},"warehouse_id":{"type":"string","nullable":true,"description":"Warehouse ID"}}},"original_einvoice":{"type":"object","nullable":true,"description":"Original e-invoice ID"},"payment_method":{"type":"string","description":"Payment method"},"phone_number":{"type":"string","description":"Phone number"},"purchaser_tax_code":{"type":"string","nullable":true,"description":"Purchaser tax code"},"purchaser_unit":{"type":"string","nullable":true,"description":"Purchaser unit"},"release_date":{"type":"string","format":"date-time","nullable":true,"description":"Release date"},"release_type":{"type":"integer","nullable":true,"description":"Release type"},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"shop_id":{"type":"integer","description":"Shop ID"},"signature_type":{"type":"integer","description":"Signature type"},"status":{"type":"integer","description":"Status","enum":[0,1,2,3,4,5,6,7],"x-enum-descriptions":["Not released","Pending release","Released","Canceled","Replacement invoice","Replaced invoice","Adjustment invoice","Adjusted"]},"tax":{"type":"integer","description":"Tax rate"},"template_code":{"type":"string","nullable":true,"description":"Template code"},"total_amount":{"type":"integer","description":"Total amount"},"verification_code":{"type":"string","nullable":true,"description":"Tax Authority Code"},"voucher_book":{"type":"object","nullable":true,"description":"Voucher book"}}},"ShippingAddress":{"type":"object","nullable":true,"description":"Shipping address","properties":{"address":{"type":"string","nullable":true,"description":"Street address. When creating an order via API, if `address` is provided but `province_id` is left empty, the system automatically parses this free-text address to fill in `province_id`, `district_id` and `commune_id`. Auto-fill is skipped when the parsed location is in Thailand (country code 66) or when no commune can be resolved from the text."},"commnue_name":{"type":"string","nullable":true,"description":"Commune name"},"commune_id":{"type":"string","nullable":true,"description":"Commune ID"},"country_code":{"type":"string","nullable":true,"description":"Country code"},"district_id":{"type":"string","nullable":true,"description":"District ID"},"district_name":{"type":"string","nullable":true,"description":"District name"},"full_address":{"type":"string","nullable":true,"description":"Full address"},"full_name":{"type":"string","nullable":true,"description":"Full name"},"new_full_address":{"type":"string","nullable":true,"description":"New full address"},"new_province_id":{"type":"string","nullable":true,"description":"New province ID"},"phone_number":{"type":"string","nullable":true,"description":"Phone number"},"post_code":{"type":"string","nullable":true,"description":"Post code"},"province_id":{"type":"string","nullable":true,"description":"Province ID"},"province_name":{"type":"string","nullable":true,"description":"Province name"},"render_type":{"type":"string","nullable":true,"description":"Render type"}}},"ReturnOrder":{"type":"object","description":"Return order information","properties":{"id":{"type":"integer","description":"Return order ID"},"display_id":{"type":"integer","description":"Display ID"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"creator_id":{"type":"string","description":"Creator ID"},"custom_id":{"type":"string","description":"Custom ID"},"discount":{"type":"integer","description":"Discount total"},"discount_from_order_to_returned":{"type":"integer","description":"Discount from order to returned"},"inserted_at":{"type":"string","format":"date-time","description":"Created at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"order_id":{"type":"integer","description":"Order ID"},"order_id_to_returned":{"type":"integer","description":"Order ID to returned"},"order":{"type":"object","properties":{"id":{"type":"integer","description":"Order ID"},"system_id":{"type":"integer","description":"System ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Order creation time"},"updated_at":{"type":"string","format":"date-time","description":"Order update time"},"status":{"type":"integer","description":"Order status","enum":[0,17,11,12,13,20,1,8,9,2,3,16,4,15,5,6,7],"x-enum-descriptions":["New","Waiting for confirmation","Restocking","Wait for printing","Printed","Purchased","Confirmed","Packaging","Waiting for pick up","Shipped","Received","Collected money","Returning","Partial return","Returned","Canceled","Deleted recently"]},"status_name":{"type":"string","description":"Order status name"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"bill_email":{"type":"string","description":"Customer email"},"conversation_id":{"type":"string","description":"Conversation ID"},"page_id":{"type":"string","description":"Facebook page ID"},"post_id":{"type":"string","description":"Post ID"},"ad_id":{"type":"string","description":"Ad ID"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"partner_fee":{"type":"integer","description":"Fee from shipping partner"},"fee_marketplace":{"type":"integer","description":"Fees from e-commerce platforms"},"customer_pay_fee":{"type":"boolean","description":"Customer pay shipping fee"},"is_free_shipping":{"type":"boolean","description":"Free shipping"},"is_livestream":{"type":"boolean","description":"Is livestream order"},"is_live_shopping":{"type":"boolean","description":"Is live shopping order"},"is_smc":{"type":"boolean","description":"Shopping on Messenger"},"received_at_shop":{"type":"boolean","description":"true: Sales at counter, false: Sell online"},"total_discount":{"type":"integer","description":"Discount total"},"note":{"type":"string","description":"Internal note"},"note_print":{"type":"string","description":"Note for printing"},"returned_reason":{"type":"integer","description":"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_name":{"type":"string","description":"Return reason name"},"sub_status":{"type":"integer","description":"Reason for delivery delay"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"warehouse_info":{"type":"object","description":"Warehouse information","properties":{"name":{"type":"string","description":"Warehouse name"},"phone_number":{"type":"string","description":"Warehouse phone number"},"full_address":{"type":"string","description":"Warehouse full address"},"address":{"type":"string","description":"Warehouse address"},"province_id":{"type":"string","description":"Province ID"},"district_id":{"type":"string","description":"District ID"},"commune_id":{"type":"string","description":"Commune ID"},"affiliate_id":{"type":"string","description":"Affiliate ID"},"ffm_id":{"type":"string","description":"FFM ID"},"has_snappy_service":{"type":"boolean","description":"Has Snappy service"},"custom_id":{"type":"string","description":"Custom ID"}}},"creator_id":{"type":"string","description":"Creator ID"},"creator":{"type":"object","description":"Order creator","properties":{"id":{"type":"string","description":"Creator ID"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"name":{"type":"string","description":"Creator name"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"items":{"type":"array","description":"Product list. When creating or updating an order, each entry must include `variation_id` and `quantity`. `variation_info` is optional — if omitted, the backend treats it as an empty object; send it (with `retail_price`) when you need the line price to be explicit.","items":{"type":"object","required":["variation_id","quantity"],"properties":{"product_id":{"type":"string","description":"Product ID"},"quantity":{"type":"integer","description":"Quantity"},"returned_count":{"type":"integer","description":"Returned count"},"assigning_seller_id":{"type":"string","description":"Assigning seller ID"},"quantity_by_combo_products":{"type":"array","description":"Quantity by combo products","items":{"type":"object"}},"discount_each_product":{"type":"integer","description":"Discount for each product"},"is_bonus_product":{"type":"boolean","description":"Is bonus product"},"is_discount_percent":{"type":"boolean","description":"Is discount by percent"},"is_wholesale":{"type":"boolean","description":"Is wholesale"},"is_composite":{"type":"boolean","description":"Is composite product"},"one_time_product":{"type":"boolean","description":"One time product"},"note":{"type":"string","description":"Product note"},"note_product":{"type":"string","description":"Product note"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"measure_group_id":{"type":"integer","description":"Measure group ID"},"variation_info":{"type":"object","description":"Variation information. Optional when creating/updating an order (the backend defaults it to an empty object if omitted). Its inner fields are not individually required, but sending `retail_price` is recommended so the line price is correct.","properties":{"id":{"type":"string","description":"Variation ID"},"name":{"type":"string","description":"Product name"},"product_id":{"type":"string","description":"Product ID"},"retail_price":{"type":"integer","description":"Retail price. Not strictly required, but recommended when creating/updating an order so the line price is correct."},"detail":{"type":"string","description":"Variation detail"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"},"keyValue":{"type":"string","description":"Key value"}}}},"barcode":{"type":"string","description":"Barcode"},"brand_id":{"type":"string","description":"Brand ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"display_id":{"type":"string","description":"Display ID"},"product_display_id":{"type":"string","description":"Product display ID"},"last_imported_price":{"type":"integer","description":"Last imported price"},"is_upsale_product":{"type":"boolean","description":"Upsale product"},"weight":{"type":"integer","description":"Weight"},"measure_info":{"type":"object","description":"Measure information","properties":{"measure_id":{"type":"integer","description":"Measure ID"},"exchange_value":{"type":"integer","description":"Exchange value"}}},"avg_price":{"type":"integer","description":"Average import price"}}},"components":{"type":"array","description":"Product components","items":{"type":"object","properties":{"component_id":{"type":"string","description":"Component ID"},"quantity":{"type":"integer","description":"Quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information"}}}},"id":{"type":"integer","description":"Item ID"},"variation_id":{"type":"string","description":"Variation ID"}}}},"partner":{"type":"object","description":"Partner information\nWhen updating an order that already has shipping info, only the fields you send are written; omitted fields keep their current values. Send `null` to clear `partner_id`, `extend_code` or `shop_partner_id`.\n","properties":{"partner_id":{"type":"integer","description":"Partner ID"},"cod":{"type":"integer","description":"Reconciliation COD"},"extend_code":{"type":"string","description":"Shipping order ID on partner system"},"total_fee":{"type":"integer","description":"Total fee"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"delivery_name":{"type":"string","description":"Shipper name"},"delivery_tel":{"type":"string","description":"Delivery phone"},"picked_up_at":{"type":"string","format":"date-time","description":"Picked up at"},"sort_code":{"type":"string","description":"Sort code"},"paid_at":{"type":"string","format":"date-time","description":"Paid at"},"system_created":{"type":"boolean","description":"System created"},"extend_update":{"type":"array","description":"Update from courier","items":{"type":"object","properties":{"key":{"type":"string","description":"Update key"},"status":{"type":"string","description":"Status"},"tracking_id":{"type":"string","description":"Partner extend code"},"note":{"type":"string","description":"Courier notes"},"update_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"partner_status":{"type":"string","nullable":true,"description":"Partner shipping status","enum":["waiting","request_received","processing_picked_up","picking_up","delay_pickup","picked_up","waiting_on_the_way","on_the_way","contact_delivery_company","out_for_delivery","delay_delivery","inform_recipient","undeliverable","waiting_for_return","delivered","delivered_cod","returning","returned","returned_cod","canceled"],"x-enum-descriptions":["Waiting for processing","Carrier received the request","Processing pickup","Picking up","Delayed pickup","Picked up","Waiting for transit","In transit","Contact the carrier","Out for delivery","Delayed delivery","Notify the recipient","Undeliverable","Waiting for return","Delivered","Delivered, COD reconciled","Returning","Returned","Returned, COD reconciled","Canceled"]},"partner_name":{"type":"string","nullable":true,"description":"Partner name"},"first_delivery_at":{"type":"string","format":"date-time","nullable":true,"description":"First delivery time"},"first_undeliverable_at":{"type":"string","format":"date-time","nullable":true,"description":"First failed delivery time"},"count_of_delivery":{"type":"integer","nullable":true,"minimum":0,"maximum":32767,"description":"Number of delivery attempts. Courier updates add 1 each time the shipment moves to `out_for_delivery` or `delay_delivery`.\nCan be set when creating or updating an order (integer 0-32767); omitted or invalid values keep the current value, and later courier updates keep counting from the value you set.\n","example":2},"order_number_vtp":{"type":"string","nullable":true,"description":"Viettel Post tracking number"},"printed_form":{"type":"object","nullable":true,"description":"Printed form"}}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"payment_purchase_histories":{"type":"array","description":"Payment histories","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount of money"},"type":{"type":"string","description":"Payment type"},"inserted_at":{"type":"string","format":"date-time","description":"Transaction time"},"result_code":{"type":"string","description":"Result code"},"ipn_reply":{"type":"boolean","description":"IPN reply"},"voucher_amount":{"type":"integer","description":"Voucher amount"},"tags":{"type":"array","description":"Tags","items":{"type":"string"}}}}},"tags":{"type":"array","description":"Tags list","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"}}}},"marketer":{"type":"object","description":"Marketer information","properties":{"id":{"type":"string","description":"Marketer ID"},"name":{"type":"string","description":"Marketer name"},"email":{"type":"string","description":"Marketer email"},"phone_number":{"type":"string","description":"Marketer phone number"},"fb_id":{"type":"string","description":"Marketer Facebook ID"},"avatar_url":{"type":"string","description":"Marketer avatar URL"}}},"pke_mkter":{"type":"string","description":"Marketer ID"},"activated_combo_products":{"type":"object","description":"Activated combo products information","properties":{"combo_product_id":{"type":"integer","description":"Combo product ID"},"quantity_combo_activated":{"type":"integer","description":"Quantity combo activated"},"combo_product_info":{"type":"object","description":"Combo product information"}}},"activated_promotion_advances":{"type":"array","description":"Activated promotion advances information","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"promotion_advance_id":{"type":"string","description":"Promotion advance ID"},"promotion_advance_info":{"type":"object","description":"Promotion advance information"}}}},"invoice_info_list":{"type":"array","description":"Invoice information list","items":{"type":"object","properties":{"error":{"type":"string","description":"Error message if any"},"invoice_detail":{"type":"object","description":"Invoice detail information. The fields to send depend on `invoice_type`:\n- `company`: use `company_name`, `company_tax_id`, `company_address`, `company_email` (and optionally `company_address_breakdown`).\n- `personal`: use `name`, `phone_number`, `identity_code`, `tax_id`, `email`.\n","properties":{"name":{"type":"string","description":"Full name of the individual requesting the invoice (`invoice_type` = `personal`)","example":"Hoang Anh"},"phone_number":{"type":"string","description":"Phone number of the individual (`invoice_type` = `personal`)","example":"0934283743"},"identity_code":{"type":"string","description":"Citizen identity card / ID number of the individual (`invoice_type` = `personal`)","example":"029374382740"},"tax_id":{"type":"string","description":"Personal tax ID of the individual, if any (`invoice_type` = `personal`)","example":""},"email":{"type":"string","description":"Email of the individual to receive the e-invoice (`invoice_type` = `personal`)","example":""},"company_address":{"type":"string","description":"Company address (`invoice_type` = `company`)"},"company_address_breakdown":{"type":"object","description":"Company address breakdown","properties":{"company_additional_info":{"type":"string","description":"Company additional information"},"company_barangay":{"type":"string","description":"Company barangay"},"company_city":{"type":"string","description":"Company city"},"company_detailed_address":{"type":"string","description":"Company detailed address"},"company_district":{"type":"string","description":"Company district"},"company_full_address":{"type":"string","description":"Company full address"},"company_postcode":{"type":"string","description":"Company postcode"},"company_province":{"type":"string","description":"Company province"},"company_region":{"type":"string","description":"Company region"},"company_state":{"type":"string","description":"Company state"},"company_town":{"type":"string","description":"Company town"}}},"company_email":{"type":"string","description":"Company email (`invoice_type` = `company`)"},"company_name":{"type":"string","description":"Company name (`invoice_type` = `company`)"},"company_tax_id":{"type":"string","description":"Company tax ID (`invoice_type` = `company`)"}}},"invoice_type":{"type":"string","enum":["company","personal"],"description":"Invoice type: `company` for an organization, `personal` for an individual.\nDetermines which `invoice_detail` fields are used.\n","example":"personal"},"is_requested":{"type":"boolean","description":"Customer requests an e-invoice for this order. Set `true` together with `invoice_type` and `invoice_detail` to request invoice issuance.","example":true},"order_sn":{"type":"string","description":"Order code on the marketplace"}}}},"reports_by_phone":{"type":"object","description":"Reports by phone number","properties":{"order_fail":{"type":"integer","description":"Number of failed orders"},"order_success":{"type":"integer","description":"Number of successful orders"},"warning":{"type":"integer","description":"Number of warnings orders"}},"example":{"+639175706297":{"order_fail":29,"order_success":20,"warning":0}}},"tracking_link":{"type":"string","description":"Link confirm order"},"payment_link":{"type":"string","description":"Payment link"},"ads_source":{"type":"string","description":"Advertising source"},"bank_payments":{"type":"object","description":"Payment method"},"transfer_proofs":{"type":"array","description":"Bank transfer payment proofs, including verification time, amount and receipt images","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transfer proof ID"},"order_id":{"type":"integer","description":"Order ID"},"shop_id":{"type":"integer","description":"Shop ID"},"payment_id":{"type":"string","description":"Bank payment method ID (matches a key in `bank_payments`)"},"amount":{"type":"integer","description":"Transferred amount"},"images":{"type":"array","description":"Transfer receipt images","items":{"type":"string"}},"note":{"type":"string","nullable":true,"description":"Note"},"is_income":{"type":"boolean","description":"Money received (true) or paid out (false)"},"is_verify":{"type":"boolean","description":"Whether the transfer has been verified"},"verify_at":{"type":"string","format":"date-time","nullable":true,"description":"Verification time"},"verifier":{"type":"object","nullable":true,"description":"Verifier information","properties":{"id":{"type":"string","description":"Verifier ID"},"name":{"type":"string","description":"Verifier name"},"fb_id":{"type":"string","description":"Facebook ID of verifier"},"avatar_url":{"type":"string","description":"Verifier avatar URL"}}},"creator":{"type":"object","nullable":true,"description":"Creator information","properties":{"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"last_editor":{"type":"object","nullable":true,"description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Editor name"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"avatar_url":{"type":"string","description":"Editor avatar URL"}}},"order_info":{"type":"object","nullable":true,"description":"Additional order information"},"inserted_at":{"type":"string","format":"date-time","description":"Transfer proof creation time"},"updated_at":{"type":"string","format":"date-time","description":"Transfer proof update time"}}}},"shopify_order_id":{"type":"string","description":"Shopify order ID"},"shopify_abandon_checkout_id":{"type":"integer","description":"Shopify abandon checkout ID"},"is_abandoned_order":{"type":"boolean","description":"Abandoned-cart flag for creating or updating an order. Send it directly in the request body, not inside `third_party` or `third_party_infomation`.\nAn 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.\nOnly boolean `true` or string `\"true\"` is normalized to `true`; all other submitted values become `false`.\n","example":true},"cod":{"type":"integer","description":"Cash on delivery"},"cash":{"type":"integer","description":"Cash payment"},"account":{"type":"integer","description":"Order source ID"},"account_name":{"type":"string","description":"Order source name"},"advanced_platform_fee":{"type":"object","description":"Fees from e-commerce platforms","properties":{"ads_top_up":{"type":"integer","description":"Ads wallet top-up"},"affiliate_commission":{"type":"integer","description":"Affiliate commission"},"diff_shipping_fee":{"type":"integer","description":"Difference shipping fee"},"marketplace_voucher":{"type":"integer","description":"Marketplace voucher"},"payment_fee":{"type":"integer","description":"Payment fee"},"platform_commission":{"type":"integer","description":"Platform commission"},"seller_transaction_fee":{"type":"integer","description":"Seller transaction fee"},"service_fee":{"type":"integer","description":"Service fee"},"sfp_service_fee":{"type":"integer","description":"SFP service fee"}}},"printing_count":{"type":"integer","description":"Printing count"},"money_to_collect":{"type":"integer","description":"Money to collect"},"marketplace_id":{"type":"string","description":"Marketplace ID","enum":["-2","-3","-4","-9","-16","-17","-20","-25","-27","-28"],"x-enum-descriptions":{"-2":"Tiki","-3":"Shopee","-4":"Lazada","-9":"TikTok","-16":"WooCommerce","-17":"Shopify","-20":"Line Shopping","-25":"Tokopedia","-27":"Mercado Libre","-28":"Tiendanube"}},"total_price":{"type":"integer","description":"Total price"},"shop_customer_address_id":{"type":"string","description":"Customer address ID"},"customer":{"type":"object","description":"Customer information","properties":{"fb_id":{"type":"string","description":"Customer Facebook ID"},"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Customer name"},"page_id":{"type":"string","description":"Page ID"}}},"total_quantity":{"type":"integer","description":"Total quantity"},"time_assign_marketer":{"type":"string","format":"date-time","description":"Time assign marketer"},"p_utm_source":{"type":"string","description":"UTM Source"},"p_utm_medium":{"type":"string","description":"UTM Medium"},"p_utm_campaign":{"type":"string","description":"UTM Campaign"},"p_utm_term":{"type":"string","description":"UTM Term"},"p_utm_content":{"type":"string","description":"UTM Content"},"p_utm_id":{"type":"string","description":"UTM ID"},"utm_affiliate":{"type":"string","description":"Affiliate"},"link":{"type":"string","description":"Link"},"status_history":{"type":"array","description":"Status update history","items":{"type":"object","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"editor":{"type":"object","description":"Editor information"},"editor_fb":{"type":"string","description":"Editor Facebook ID"},"editor_id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Name"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Status"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"duplicated_phone":{"type":"boolean","description":"Duplicated phone"},"order_currency":{"type":"string","description":"Order currency"},"charged_by_vnpay":{"type":"integer","description":"Charged by VNPay"},"charged_by_qrpay":{"type":"integer","description":"Charged by QRPay"},"custom_id":{"type":"string","description":"Custom ID"},"last_editor":{"type":"object","description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"name":{"type":"string","description":"Editor name"},"email":{"type":"string","description":"Editor email"},"avatar_url":{"type":"string","description":"Editor avatar URL"},"phone_number":{"type":"string","description":"Editor phone number"}}},"last_editor_id":{"type":"string","description":"Last editor ID"},"charged_by_momo":{"type":"integer","description":"Charged by MoMo"},"prepaid_by_point":{"type":"object","description":"Prepaid by point","properties":{"money":{"type":"integer","description":"Money amount","example":15000},"point":{"type":"integer","description":"Point amount","example":15}},"example":{"money":15000,"point":15}},"bank_transfer_images":{"type":"array","description":"Bank transfer images","items":{"type":"string","format":"uri"}},"transfer_money":{"type":"integer","description":"Transfer money"},"lock_order_by_user":{"type":"string","description":"Lock order by user ID"},"assigning_care":{"type":"object","description":"Assigning care information","properties":{"id":{"type":"string","description":"Care ID"},"fb_id":{"type":"string","description":"Facebook ID of care"},"name":{"type":"string","description":"Care name"},"email":{"type":"string","description":"Care email"},"avatar_url":{"type":"string","description":"Care avatar URL"},"phone_number":{"type":"string","description":"Care phone number"}}},"assigning_care_id":{"type":"string","description":"Assigning care ID"},"time_assign_care":{"type":"string","format":"date-time","description":"Time assign care"},"assigning_seller":{"type":"object","description":"Assigning seller information","properties":{"id":{"type":"string","description":"Seller ID"},"fb_id":{"type":"string","description":"Facebook ID of seller"},"name":{"type":"string","description":"Seller name"},"email":{"type":"string","description":"Seller email"},"avatar_url":{"type":"string","description":"Seller avatar URL"},"phone_number":{"type":"string","description":"Seller phone number"}}},"einvoices":{"type":"array","items":{"$ref":"#/components/schemas/EInvoice"}},"charged_by_card":{"type":"integer","description":"Charged by card"},"estimate_delivery_date":{"type":"string","format":"date-time","description":"Estimate delivery date"},"order_sources":{"type":"string","description":"Order sources ID"},"charged_by_fundiin":{"type":"integer","description":"Charged by Fundiin"},"surcharge":{"type":"integer","description":"Surcharge"},"is_linked_partner":{"type":"boolean","description":"Is linked partner"},"call_laters":{"type":"array","description":"Call laters","items":{"type":"object"}},"last_update_status_at":{"type":"string","format":"date-time","description":"Last update status at"},"discount_by_customer_level":{"type":"integer","description":"Discount by customer level"},"viewing":{"type":"array","description":"Viewing","items":{"type":"object"}},"additional_info":{"type":"object","description":"Additional info","properties":{"service_partner":{"type":"string","description":"Service partner","enum":["instant"],"x-enum-descriptions":["Instant"]},"delivery_deadline":{"type":"string","format":"date-time","description":"Delivery deadline (ISO8601, no timezone).","example":"2026-06-03T10:00:00"},"ship_by_date":{"type":"integer","nullable":true,"readOnly":true,"description":"Marketplace ship-by deadline (Unix timestamp, seconds) for Shopee/TikTok orders — the order must be handed over to the carrier before this time, otherwise the marketplace may cancel it automatically. Shopee `ship_by_date`, TikTok `collection_due_time`. `0` = the marketplace has not returned it yet; `null` for non-marketplace orders.","example":1793000000}}},"order_returned_ids":{"type":"string","description":"Order returned IDs"},"cost_surcharge":{"type":"integer","description":"Cost surcharge"},"time_send_partner":{"type":"string","format":"date-time","description":"Time send partner"},"charged_by_kredivo":{"type":"integer","description":"Charged by Kredivo"},"discount":{"type":"integer","description":"Discount"},"histories":{"type":"array","description":"Histories","items":{"type":"object"}},"duplicated_customer":{"type":"boolean","description":"Duplicated customer"},"customer_referral_code":{"type":"object","description":"Customer referral code","properties":{"active":{"type":"string","description":"Active status","example":"true"},"customer_id":{"type":"string","format":"uuid","description":"Customer ID","example":"09bb9399-45f3-4897-a53a-85dde2f886fe"},"discount":{"type":"string","description":"Discount value","example":"10"},"format":{"type":"string","description":"Referral code format","example":"{PHONE_NUMBER}"},"free_products_priced_between_approx":{"type":"object","description":"Free products priced between approximately","properties":{"active":{"type":"string","description":"Active status","example":"true"},"operator":{"type":"string","description":"Comparison operator","example":"GreaterOrEqual"},"price":{"type":"string","description":"Price threshold","example":"150000"}}},"is_percent":{"type":"string","description":"Discount is percentage","example":"true"},"only_customers_with_level_will_have_referral_code":{"type":"string","description":"Only customers with level will have referral code","example":"true"},"referral_code":{"type":"string","description":"Referral code","example":"982843759"},"reward_points_for_old_customers":{"type":"object","description":"Reward points for customers","properties":{"active":{"type":"string","description":"Active status","example":"true"},"money":{"type":"string","description":"Money reward","example":"10000"},"point":{"type":"string","description":"Point reward","example":"1"}}},"shop_customer_id":{"type":"string","format":"uuid","description":"Shop customer ID","example":"f8160a4c-dfa7-4ee8-b540-d245755ea1f1"}},"example":{"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"}},"tax":{"type":"integer","description":"Tax"},"is_from_ecommerce":{"type":"boolean","description":"Is from e-commerce"},"note_image":{"type":"array","description":"Note images","items":{"type":"string","format":"uri"}},"shopify_draft_order_id":{"type":"string","description":"Shopify draft order ID"},"display_id":{"type":"integer","description":"Display ID"},"shop_partner_id":{"type":"integer","description":"Shop partner ID"},"is_locked":{"type":"boolean","description":"Order lock"},"merge_order":{"type":"boolean","description":"Allows merging orders"}}},"order_to_returned":{"type":"object","properties":{"id":{"type":"integer","description":"Order ID"},"system_id":{"type":"integer","description":"System ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Order creation time"},"updated_at":{"type":"string","format":"date-time","description":"Order update time"},"status":{"type":"integer","description":"Order status","enum":[0,17,11,12,13,20,1,8,9,2,3,16,4,15,5,6,7],"x-enum-descriptions":["New","Waiting for confirmation","Restocking","Wait for printing","Printed","Purchased","Confirmed","Packaging","Waiting for pick up","Shipped","Received","Collected money","Returning","Partial return","Returned","Canceled","Deleted recently"]},"status_name":{"type":"string","description":"Order status name"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"bill_email":{"type":"string","description":"Customer email"},"conversation_id":{"type":"string","description":"Conversation ID"},"page_id":{"type":"string","description":"Facebook page ID"},"post_id":{"type":"string","description":"Post ID"},"ad_id":{"type":"string","description":"Ad ID"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"partner_fee":{"type":"integer","description":"Fee from shipping partner"},"fee_marketplace":{"type":"integer","description":"Fees from e-commerce platforms"},"customer_pay_fee":{"type":"boolean","description":"Customer pay shipping fee"},"is_free_shipping":{"type":"boolean","description":"Free shipping"},"is_livestream":{"type":"boolean","description":"Is livestream order"},"is_live_shopping":{"type":"boolean","description":"Is live shopping order"},"is_smc":{"type":"boolean","description":"Shopping on Messenger"},"received_at_shop":{"type":"boolean","description":"true: Sales at counter, false: Sell online"},"total_discount":{"type":"integer","description":"Discount total"},"note":{"type":"string","description":"Internal note"},"note_print":{"type":"string","description":"Note for printing"},"returned_reason":{"type":"integer","description":"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_name":{"type":"string","description":"Return reason name"},"sub_status":{"type":"integer","description":"Reason for delivery delay"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"warehouse_info":{"type":"object","description":"Warehouse information","properties":{"name":{"type":"string","description":"Warehouse name"},"phone_number":{"type":"string","description":"Warehouse phone number"},"full_address":{"type":"string","description":"Warehouse full address"},"address":{"type":"string","description":"Warehouse address"},"province_id":{"type":"string","description":"Province ID"},"district_id":{"type":"string","description":"District ID"},"commune_id":{"type":"string","description":"Commune ID"},"affiliate_id":{"type":"string","description":"Affiliate ID"},"ffm_id":{"type":"string","description":"FFM ID"},"has_snappy_service":{"type":"boolean","description":"Has Snappy service"},"custom_id":{"type":"string","description":"Custom ID"}}},"creator_id":{"type":"string","description":"Creator ID"},"creator":{"type":"object","description":"Order creator","properties":{"id":{"type":"string","description":"Creator ID"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"name":{"type":"string","description":"Creator name"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"items":{"type":"array","description":"Product list. When creating or updating an order, each entry must include `variation_id` and `quantity`. `variation_info` is optional — if omitted, the backend treats it as an empty object; send it (with `retail_price`) when you need the line price to be explicit.","items":{"type":"object","required":["variation_id","quantity"],"properties":{"product_id":{"type":"string","description":"Product ID"},"quantity":{"type":"integer","description":"Quantity"},"returned_count":{"type":"integer","description":"Returned count"},"assigning_seller_id":{"type":"string","description":"Assigning seller ID"},"quantity_by_combo_products":{"type":"array","description":"Quantity by combo products","items":{"type":"object"}},"discount_each_product":{"type":"integer","description":"Discount for each product"},"is_bonus_product":{"type":"boolean","description":"Is bonus product"},"is_discount_percent":{"type":"boolean","description":"Is discount by percent"},"is_wholesale":{"type":"boolean","description":"Is wholesale"},"is_composite":{"type":"boolean","description":"Is composite product"},"one_time_product":{"type":"boolean","description":"One time product"},"note":{"type":"string","description":"Product note"},"note_product":{"type":"string","description":"Product note"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"measure_group_id":{"type":"integer","description":"Measure group ID"},"variation_info":{"type":"object","description":"Variation information. Optional when creating/updating an order (the backend defaults it to an empty object if omitted). Its inner fields are not individually required, but sending `retail_price` is recommended so the line price is correct.","properties":{"id":{"type":"string","description":"Variation ID"},"name":{"type":"string","description":"Product name"},"product_id":{"type":"string","description":"Product ID"},"retail_price":{"type":"integer","description":"Retail price. Not strictly required, but recommended when creating/updating an order so the line price is correct."},"detail":{"type":"string","description":"Variation detail"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"},"keyValue":{"type":"string","description":"Key value"}}}},"barcode":{"type":"string","description":"Barcode"},"brand_id":{"type":"string","description":"Brand ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"display_id":{"type":"string","description":"Display ID"},"product_display_id":{"type":"string","description":"Product display ID"},"last_imported_price":{"type":"integer","description":"Last imported price"},"is_upsale_product":{"type":"boolean","description":"Upsale product"},"weight":{"type":"integer","description":"Weight"},"measure_info":{"type":"object","description":"Measure information","properties":{"measure_id":{"type":"integer","description":"Measure ID"},"exchange_value":{"type":"integer","description":"Exchange value"}}},"avg_price":{"type":"integer","description":"Average import price"}}},"components":{"type":"array","description":"Product components","items":{"type":"object","properties":{"component_id":{"type":"string","description":"Component ID"},"quantity":{"type":"integer","description":"Quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information"}}}},"id":{"type":"integer","description":"Item ID"},"variation_id":{"type":"string","description":"Variation ID"}}}},"partner":{"type":"object","description":"Partner information\nWhen updating an order that already has shipping info, only the fields you send are written; omitted fields keep their current values. Send `null` to clear `partner_id`, `extend_code` or `shop_partner_id`.\n","properties":{"partner_id":{"type":"integer","description":"Partner ID"},"cod":{"type":"integer","description":"Reconciliation COD"},"extend_code":{"type":"string","description":"Shipping order ID on partner system"},"total_fee":{"type":"integer","description":"Total fee"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"delivery_name":{"type":"string","description":"Shipper name"},"delivery_tel":{"type":"string","description":"Delivery phone"},"picked_up_at":{"type":"string","format":"date-time","description":"Picked up at"},"sort_code":{"type":"string","description":"Sort code"},"paid_at":{"type":"string","format":"date-time","description":"Paid at"},"system_created":{"type":"boolean","description":"System created"},"extend_update":{"type":"array","description":"Update from courier","items":{"type":"object","properties":{"key":{"type":"string","description":"Update key"},"status":{"type":"string","description":"Status"},"tracking_id":{"type":"string","description":"Partner extend code"},"note":{"type":"string","description":"Courier notes"},"update_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"partner_status":{"type":"string","nullable":true,"description":"Partner shipping status","enum":["waiting","request_received","processing_picked_up","picking_up","delay_pickup","picked_up","waiting_on_the_way","on_the_way","contact_delivery_company","out_for_delivery","delay_delivery","inform_recipient","undeliverable","waiting_for_return","delivered","delivered_cod","returning","returned","returned_cod","canceled"],"x-enum-descriptions":["Waiting for processing","Carrier received the request","Processing pickup","Picking up","Delayed pickup","Picked up","Waiting for transit","In transit","Contact the carrier","Out for delivery","Delayed delivery","Notify the recipient","Undeliverable","Waiting for return","Delivered","Delivered, COD reconciled","Returning","Returned","Returned, COD reconciled","Canceled"]},"partner_name":{"type":"string","nullable":true,"description":"Partner name"},"first_delivery_at":{"type":"string","format":"date-time","nullable":true,"description":"First delivery time"},"first_undeliverable_at":{"type":"string","format":"date-time","nullable":true,"description":"First failed delivery time"},"count_of_delivery":{"type":"integer","nullable":true,"minimum":0,"maximum":32767,"description":"Number of delivery attempts. Courier updates add 1 each time the shipment moves to `out_for_delivery` or `delay_delivery`.\nCan be set when creating or updating an order (integer 0-32767); omitted or invalid values keep the current value, and later courier updates keep counting from the value you set.\n","example":2},"order_number_vtp":{"type":"string","nullable":true,"description":"Viettel Post tracking number"},"printed_form":{"type":"object","nullable":true,"description":"Printed form"}}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"payment_purchase_histories":{"type":"array","description":"Payment histories","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount of money"},"type":{"type":"string","description":"Payment type"},"inserted_at":{"type":"string","format":"date-time","description":"Transaction time"},"result_code":{"type":"string","description":"Result code"},"ipn_reply":{"type":"boolean","description":"IPN reply"},"voucher_amount":{"type":"integer","description":"Voucher amount"},"tags":{"type":"array","description":"Tags","items":{"type":"string"}}}}},"tags":{"type":"array","description":"Tags list","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"}}}},"marketer":{"type":"object","description":"Marketer information","properties":{"id":{"type":"string","description":"Marketer ID"},"name":{"type":"string","description":"Marketer name"},"email":{"type":"string","description":"Marketer email"},"phone_number":{"type":"string","description":"Marketer phone number"},"fb_id":{"type":"string","description":"Marketer Facebook ID"},"avatar_url":{"type":"string","description":"Marketer avatar URL"}}},"pke_mkter":{"type":"string","description":"Marketer ID"},"activated_combo_products":{"type":"object","description":"Activated combo products information","properties":{"combo_product_id":{"type":"integer","description":"Combo product ID"},"quantity_combo_activated":{"type":"integer","description":"Quantity combo activated"},"combo_product_info":{"type":"object","description":"Combo product information"}}},"activated_promotion_advances":{"type":"array","description":"Activated promotion advances information","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"promotion_advance_id":{"type":"string","description":"Promotion advance ID"},"promotion_advance_info":{"type":"object","description":"Promotion advance information"}}}},"invoice_info_list":{"type":"array","description":"Invoice information list","items":{"type":"object","properties":{"error":{"type":"string","description":"Error message if any"},"invoice_detail":{"type":"object","description":"Invoice detail information. The fields to send depend on `invoice_type`:\n- `company`: use `company_name`, `company_tax_id`, `company_address`, `company_email` (and optionally `company_address_breakdown`).\n- `personal`: use `name`, `phone_number`, `identity_code`, `tax_id`, `email`.\n","properties":{"name":{"type":"string","description":"Full name of the individual requesting the invoice (`invoice_type` = `personal`)","example":"Hoang Anh"},"phone_number":{"type":"string","description":"Phone number of the individual (`invoice_type` = `personal`)","example":"0934283743"},"identity_code":{"type":"string","description":"Citizen identity card / ID number of the individual (`invoice_type` = `personal`)","example":"029374382740"},"tax_id":{"type":"string","description":"Personal tax ID of the individual, if any (`invoice_type` = `personal`)","example":""},"email":{"type":"string","description":"Email of the individual to receive the e-invoice (`invoice_type` = `personal`)","example":""},"company_address":{"type":"string","description":"Company address (`invoice_type` = `company`)"},"company_address_breakdown":{"type":"object","description":"Company address breakdown","properties":{"company_additional_info":{"type":"string","description":"Company additional information"},"company_barangay":{"type":"string","description":"Company barangay"},"company_city":{"type":"string","description":"Company city"},"company_detailed_address":{"type":"string","description":"Company detailed address"},"company_district":{"type":"string","description":"Company district"},"company_full_address":{"type":"string","description":"Company full address"},"company_postcode":{"type":"string","description":"Company postcode"},"company_province":{"type":"string","description":"Company province"},"company_region":{"type":"string","description":"Company region"},"company_state":{"type":"string","description":"Company state"},"company_town":{"type":"string","description":"Company town"}}},"company_email":{"type":"string","description":"Company email (`invoice_type` = `company`)"},"company_name":{"type":"string","description":"Company name (`invoice_type` = `company`)"},"company_tax_id":{"type":"string","description":"Company tax ID (`invoice_type` = `company`)"}}},"invoice_type":{"type":"string","enum":["company","personal"],"description":"Invoice type: `company` for an organization, `personal` for an individual.\nDetermines which `invoice_detail` fields are used.\n","example":"personal"},"is_requested":{"type":"boolean","description":"Customer requests an e-invoice for this order. Set `true` together with `invoice_type` and `invoice_detail` to request invoice issuance.","example":true},"order_sn":{"type":"string","description":"Order code on the marketplace"}}}},"reports_by_phone":{"type":"object","description":"Reports by phone number","properties":{"order_fail":{"type":"integer","description":"Number of failed orders"},"order_success":{"type":"integer","description":"Number of successful orders"},"warning":{"type":"integer","description":"Number of warnings orders"}},"example":{"+639175706297":{"order_fail":29,"order_success":20,"warning":0}}},"tracking_link":{"type":"string","description":"Link confirm order"},"payment_link":{"type":"string","description":"Payment link"},"ads_source":{"type":"string","description":"Advertising source"},"bank_payments":{"type":"object","description":"Payment method"},"transfer_proofs":{"type":"array","description":"Bank transfer payment proofs, including verification time, amount and receipt images","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transfer proof ID"},"order_id":{"type":"integer","description":"Order ID"},"shop_id":{"type":"integer","description":"Shop ID"},"payment_id":{"type":"string","description":"Bank payment method ID (matches a key in `bank_payments`)"},"amount":{"type":"integer","description":"Transferred amount"},"images":{"type":"array","description":"Transfer receipt images","items":{"type":"string"}},"note":{"type":"string","nullable":true,"description":"Note"},"is_income":{"type":"boolean","description":"Money received (true) or paid out (false)"},"is_verify":{"type":"boolean","description":"Whether the transfer has been verified"},"verify_at":{"type":"string","format":"date-time","nullable":true,"description":"Verification time"},"verifier":{"type":"object","nullable":true,"description":"Verifier information","properties":{"id":{"type":"string","description":"Verifier ID"},"name":{"type":"string","description":"Verifier name"},"fb_id":{"type":"string","description":"Facebook ID of verifier"},"avatar_url":{"type":"string","description":"Verifier avatar URL"}}},"creator":{"type":"object","nullable":true,"description":"Creator information","properties":{"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"last_editor":{"type":"object","nullable":true,"description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Editor name"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"avatar_url":{"type":"string","description":"Editor avatar URL"}}},"order_info":{"type":"object","nullable":true,"description":"Additional order information"},"inserted_at":{"type":"string","format":"date-time","description":"Transfer proof creation time"},"updated_at":{"type":"string","format":"date-time","description":"Transfer proof update time"}}}},"shopify_order_id":{"type":"string","description":"Shopify order ID"},"shopify_abandon_checkout_id":{"type":"integer","description":"Shopify abandon checkout ID"},"is_abandoned_order":{"type":"boolean","description":"Abandoned-cart flag for creating or updating an order. Send it directly in the request body, not inside `third_party` or `third_party_infomation`.\nAn 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.\nOnly boolean `true` or string `\"true\"` is normalized to `true`; all other submitted values become `false`.\n","example":true},"cod":{"type":"integer","description":"Cash on delivery"},"cash":{"type":"integer","description":"Cash payment"},"account":{"type":"integer","description":"Order source ID"},"account_name":{"type":"string","description":"Order source name"},"advanced_platform_fee":{"type":"object","description":"Fees from e-commerce platforms","properties":{"ads_top_up":{"type":"integer","description":"Ads wallet top-up"},"affiliate_commission":{"type":"integer","description":"Affiliate commission"},"diff_shipping_fee":{"type":"integer","description":"Difference shipping fee"},"marketplace_voucher":{"type":"integer","description":"Marketplace voucher"},"payment_fee":{"type":"integer","description":"Payment fee"},"platform_commission":{"type":"integer","description":"Platform commission"},"seller_transaction_fee":{"type":"integer","description":"Seller transaction fee"},"service_fee":{"type":"integer","description":"Service fee"},"sfp_service_fee":{"type":"integer","description":"SFP service fee"}}},"printing_count":{"type":"integer","description":"Printing count"},"money_to_collect":{"type":"integer","description":"Money to collect"},"marketplace_id":{"type":"string","description":"Marketplace ID","enum":["-2","-3","-4","-9","-16","-17","-20","-25","-27","-28"],"x-enum-descriptions":{"-2":"Tiki","-3":"Shopee","-4":"Lazada","-9":"TikTok","-16":"WooCommerce","-17":"Shopify","-20":"Line Shopping","-25":"Tokopedia","-27":"Mercado Libre","-28":"Tiendanube"}},"total_price":{"type":"integer","description":"Total price"},"shop_customer_address_id":{"type":"string","description":"Customer address ID"},"customer":{"type":"object","description":"Customer information","properties":{"fb_id":{"type":"string","description":"Customer Facebook ID"},"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Customer name"},"page_id":{"type":"string","description":"Page ID"}}},"total_quantity":{"type":"integer","description":"Total quantity"},"time_assign_marketer":{"type":"string","format":"date-time","description":"Time assign marketer"},"p_utm_source":{"type":"string","description":"UTM Source"},"p_utm_medium":{"type":"string","description":"UTM Medium"},"p_utm_campaign":{"type":"string","description":"UTM Campaign"},"p_utm_term":{"type":"string","description":"UTM Term"},"p_utm_content":{"type":"string","description":"UTM Content"},"p_utm_id":{"type":"string","description":"UTM ID"},"utm_affiliate":{"type":"string","description":"Affiliate"},"link":{"type":"string","description":"Link"},"status_history":{"type":"array","description":"Status update history","items":{"type":"object","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"editor":{"type":"object","description":"Editor information"},"editor_fb":{"type":"string","description":"Editor Facebook ID"},"editor_id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Name"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Status"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"duplicated_phone":{"type":"boolean","description":"Duplicated phone"},"order_currency":{"type":"string","description":"Order currency"},"charged_by_vnpay":{"type":"integer","description":"Charged by VNPay"},"charged_by_qrpay":{"type":"integer","description":"Charged by QRPay"},"custom_id":{"type":"string","description":"Custom ID"},"last_editor":{"type":"object","description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"name":{"type":"string","description":"Editor name"},"email":{"type":"string","description":"Editor email"},"avatar_url":{"type":"string","description":"Editor avatar URL"},"phone_number":{"type":"string","description":"Editor phone number"}}},"last_editor_id":{"type":"string","description":"Last editor ID"},"charged_by_momo":{"type":"integer","description":"Charged by MoMo"},"prepaid_by_point":{"type":"object","description":"Prepaid by point","properties":{"money":{"type":"integer","description":"Money amount","example":15000},"point":{"type":"integer","description":"Point amount","example":15}},"example":{"money":15000,"point":15}},"bank_transfer_images":{"type":"array","description":"Bank transfer images","items":{"type":"string","format":"uri"}},"transfer_money":{"type":"integer","description":"Transfer money"},"lock_order_by_user":{"type":"string","description":"Lock order by user ID"},"assigning_care":{"type":"object","description":"Assigning care information","properties":{"id":{"type":"string","description":"Care ID"},"fb_id":{"type":"string","description":"Facebook ID of care"},"name":{"type":"string","description":"Care name"},"email":{"type":"string","description":"Care email"},"avatar_url":{"type":"string","description":"Care avatar URL"},"phone_number":{"type":"string","description":"Care phone number"}}},"assigning_care_id":{"type":"string","description":"Assigning care ID"},"time_assign_care":{"type":"string","format":"date-time","description":"Time assign care"},"assigning_seller":{"type":"object","description":"Assigning seller information","properties":{"id":{"type":"string","description":"Seller ID"},"fb_id":{"type":"string","description":"Facebook ID of seller"},"name":{"type":"string","description":"Seller name"},"email":{"type":"string","description":"Seller email"},"avatar_url":{"type":"string","description":"Seller avatar URL"},"phone_number":{"type":"string","description":"Seller phone number"}}},"einvoices":{"type":"array","items":{"$ref":"#/components/schemas/EInvoice"}},"charged_by_card":{"type":"integer","description":"Charged by card"},"estimate_delivery_date":{"type":"string","format":"date-time","description":"Estimate delivery date"},"order_sources":{"type":"string","description":"Order sources ID"},"charged_by_fundiin":{"type":"integer","description":"Charged by Fundiin"},"surcharge":{"type":"integer","description":"Surcharge"},"is_linked_partner":{"type":"boolean","description":"Is linked partner"},"call_laters":{"type":"array","description":"Call laters","items":{"type":"object"}},"last_update_status_at":{"type":"string","format":"date-time","description":"Last update status at"},"discount_by_customer_level":{"type":"integer","description":"Discount by customer level"},"viewing":{"type":"array","description":"Viewing","items":{"type":"object"}},"additional_info":{"type":"object","description":"Additional info","properties":{"service_partner":{"type":"string","description":"Service partner","enum":["instant"],"x-enum-descriptions":["Instant"]},"delivery_deadline":{"type":"string","format":"date-time","description":"Delivery deadline (ISO8601, no timezone).","example":"2026-06-03T10:00:00"},"ship_by_date":{"type":"integer","nullable":true,"readOnly":true,"description":"Marketplace ship-by deadline (Unix timestamp, seconds) for Shopee/TikTok orders — the order must be handed over to the carrier before this time, otherwise the marketplace may cancel it automatically. Shopee `ship_by_date`, TikTok `collection_due_time`. `0` = the marketplace has not returned it yet; `null` for non-marketplace orders.","example":1793000000}}},"order_returned_ids":{"type":"string","description":"Order returned IDs"},"cost_surcharge":{"type":"integer","description":"Cost surcharge"},"time_send_partner":{"type":"string","format":"date-time","description":"Time send partner"},"charged_by_kredivo":{"type":"integer","description":"Charged by Kredivo"},"discount":{"type":"integer","description":"Discount"},"histories":{"type":"array","description":"Histories","items":{"type":"object"}},"duplicated_customer":{"type":"boolean","description":"Duplicated customer"},"customer_referral_code":{"type":"object","description":"Customer referral code","properties":{"active":{"type":"string","description":"Active status","example":"true"},"customer_id":{"type":"string","format":"uuid","description":"Customer ID","example":"09bb9399-45f3-4897-a53a-85dde2f886fe"},"discount":{"type":"string","description":"Discount value","example":"10"},"format":{"type":"string","description":"Referral code format","example":"{PHONE_NUMBER}"},"free_products_priced_between_approx":{"type":"object","description":"Free products priced between approximately","properties":{"active":{"type":"string","description":"Active status","example":"true"},"operator":{"type":"string","description":"Comparison operator","example":"GreaterOrEqual"},"price":{"type":"string","description":"Price threshold","example":"150000"}}},"is_percent":{"type":"string","description":"Discount is percentage","example":"true"},"only_customers_with_level_will_have_referral_code":{"type":"string","description":"Only customers with level will have referral code","example":"true"},"referral_code":{"type":"string","description":"Referral code","example":"982843759"},"reward_points_for_old_customers":{"type":"object","description":"Reward points for customers","properties":{"active":{"type":"string","description":"Active status","example":"true"},"money":{"type":"string","description":"Money reward","example":"10000"},"point":{"type":"string","description":"Point reward","example":"1"}}},"shop_customer_id":{"type":"string","format":"uuid","description":"Shop customer ID","example":"f8160a4c-dfa7-4ee8-b540-d245755ea1f1"}},"example":{"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"}},"tax":{"type":"integer","description":"Tax"},"is_from_ecommerce":{"type":"boolean","description":"Is from e-commerce"},"note_image":{"type":"array","description":"Note images","items":{"type":"string","format":"uri"}},"shopify_draft_order_id":{"type":"string","description":"Shopify draft order ID"},"display_id":{"type":"integer","description":"Display ID"},"shop_partner_id":{"type":"integer","description":"Shop partner ID"},"is_locked":{"type":"boolean","description":"Order lock"},"merge_order":{"type":"boolean","description":"Allows merging orders"}}},"returned_items":{"type":"array","description":"List of returned items","items":{"type":"object","properties":{"id":{"type":"integer","description":"Returned item ID"},"product_id":{"type":"string","description":"Product ID"},"variation_id":{"type":"string","description":"Variation ID"},"returned_quantity":{"type":"integer","description":"Returned quantity"},"discount_each_product":{"type":"integer","description":"Discount for each product"},"is_discount_percent":{"type":"boolean","description":"Is discount by percent"},"variation_info":{"type":"object","description":"Variation information"}}}},"returned_fee":{"type":"integer","description":"Returned fee"},"shop_customer_id":{"type":"string","description":"Customer ID"},"shop_id":{"type":"integer","description":"Shop ID"},"status":{"type":"integer","description":"Return order status","enum":[0,1,2,4],"x-enum-descriptions":["New","Completed","Shipped","Canceled"]},"status_histories":{"type":"array","description":"Status history","items":{"type":"object","properties":{"id":{"type":"string","description":"History ID"},"editor_id":{"type":"string","description":"Editor ID"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Status"},"inserted_at":{"type":"string","format":"date-time","description":"Created at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"tags":{"type":"array","description":"Tags list","items":{"type":"integer"}},"warehouse_id":{"type":"string","description":"Warehouse ID"}}},"Shop":{"type":"object","description":"Shop information","properties":{"avatar_url":{"type":"string","description":"Avatar image link"},"name":{"type":"string","description":"Shop name"},"currency":{"type":"string","description":"Shop currency code, for example `VND`"},"id":{"type":"integer","description":"Shop ID"},"preferred_shop":{"type":["integer","null"],"description":"User-specific preferred shop rank. Lower values have higher priority"},"pages":{"type":"array","description":"Pages information in shop","items":{"type":"object","properties":{"id":{"type":"string","description":"Page ID"},"name":{"type":"string","description":"Page name"},"platform":{"type":"string","description":"Platform (e.g., facebook)"},"settings":{"type":"object","description":"Page settings","properties":{"auto_create_order":{"type":"boolean","description":"Auto create order"}}},"shop_id":{"type":"integer","description":"Shop ID"}}}},"link_post_marketer":{"type":"array","description":"Information of link post / source / AD account with marketer","items":{"type":"object","properties":{"ad_account_id":{"type":"string","description":"AD account ID"},"id":{"type":"string","description":"Link ID"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"marketer":{"type":"string","description":"Marketer ID"},"multiple_post":{"type":"array","description":"Post ID","items":{"type":"string"}},"multiple_source":{"type":"array","description":"Source information","items":{"type":"object","properties":{"account":{"type":"string","description":"Order source account ID"},"key":{"type":"string","description":"Key"},"page_id":{"type":"string","description":"Facebook page ID"}}}},"shop_id":{"type":"integer","description":"Shop ID"},"type":{"type":"string","description":"Type of link (post: \"Post\", source: \"Source\", ad_account_id: \"AD account\")"}}}}}},"Warehouse":{"type":"object","description":"Warehouse information","properties":{"id":{"type":"string","description":"Warehouse ID"},"name":{"type":"string","description":"Warehouse name"},"address":{"type":"string","description":"Warehouse address"},"full_address":{"type":"string","description":"Warehouse full address"},"phone_number":{"type":"string","description":"Warehouse phone number"},"province_id":{"type":"string","description":"Province ID. For a Viet Nam warehouse using the new (2-level, post-merger) address, this is the new province ID (e.g. `84_VN102`)"},"district_id":{"type":"string","nullable":true,"description":"District ID. Always `null` for a Viet Nam warehouse using the new address (no district level)"},"commune_id":{"type":"string","nullable":true,"description":"Commune ID. For a Viet Nam warehouse using the new address, this is the new commune ID (e.g. `84_VN10236`)"},"country_code":{"type":"string","description":"Country code"},"shop_id":{"type":"integer","description":"Shop ID"},"allow_create_order":{"type":"boolean","description":"Allow create order"},"custom_id":{"type":"string","description":"Custom ID"},"affiliate_shop_id":{"type":"integer","description":"Affiliate shop ID"},"affiliate_warehouse":{"type":"string","description":"Affiliate warehouse name"}}},"VariationWarehouse":{"type":"object","description":"Per-warehouse stock detail for a variation.","properties":{"id":{"type":"string","description":"Variation-warehouse record ID"},"variation_id":{"type":"string","description":"Variation ID"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"shop_id":{"type":"integer","description":"Shop ID"},"remain_quantity":{"type":"integer","description":"Sellable quantity. May include incoming/waiting stock depending on shop settings."},"available_quantity":{"type":"integer","description":"remain_quantity clamped to be non-negative (max(0, remain_quantity))."},"actual_remain_quantity":{"type":"integer","description":"Quantity physically on hand in the warehouse."},"total_quantity":{"type":"integer","description":"Total quantity recorded at this warehouse."},"waitting_quantity":{"type":"integer","description":"Quantity tied up in orders that are awaiting stock (orders placed but waiting for goods to arrive). (Field name keeps the legacy `waitt-` spelling.)"},"pending_quantity":{"type":"integer","description":"Quantity reserved by pending purchase orders."},"transfer_quantity":{"type":"integer","description":"Quantity currently being transferred out."},"pending_transfer_quantity":{"type":"integer","description":"Quantity pending transfer (not yet shipped between warehouses)."},"pending_export_quantity":{"type":"integer","description":"Quantity pending export."},"shipping_quantity":{"type":"integer","description":"Quantity tied up in orders being shipped."},"returning_quantity":{"type":"integer","description":"Quantity in the process of being returned to this warehouse."},"defect_quantity":{"type":"integer","description":"Damaged/defective quantity."},"total_quantity_transfer":{"type":"integer","description":"Total quantity across transfer operations."},"shelf_quantity":{"type":"integer","description":"Quantity placed on the shelf."},"quantity_in_batch":{"type":"integer","description":"Quantity in the batch/lot."},"batch_position":{"type":"string","nullable":true,"description":"Batch/lot location label."},"shelf_position":{"type":"string","nullable":true,"description":"Shelf location label."},"selling_status":{"type":"string","enum":["none","bad","normal","star"],"x-enum-descriptions":["Testing","Sell slow","Normal","Sell fast"],"description":"Selling-speed status of the variation at this warehouse."},"selling_avg":{"type":"number","description":"Average quantity sold per period — combine with remain_quantity to estimate days of stock left (for \"running low\" detection)."},"avg_price":{"type":"number","description":"Average cost price of the stock at this warehouse."},"nearly_out":{"type":"boolean","description":"True when stock has reached the configured warning threshold (nearly out of stock)."},"not_permission_view_quantity":{"type":"boolean","nullable":true,"description":"True when the current user lacks permission to view quantities for this warehouse (quantity fields are then hidden/zeroed)."}}},"VariationSize":{"type":"object","description":"Variation size (dimensions)","properties":{"length":{"type":"integer","description":"Length"},"width":{"type":"integer","description":"Width"},"height":{"type":"integer","description":"Height"}}},"RetailPriceByCurrency":{"type":"object","description":"Retail price of the variation in one currency","required":["currency","retailPriceByCurrency"],"properties":{"currency":{"type":"string","description":"Currency code (ISO 4217)","example":"USD"},"retailPriceByCurrency":{"type":["number","string"],"description":"Retail price in this currency. Requests accept a number; responses return it as a string.","example":100}}},"Variation":{"type":"object","description":"Product variation information","properties":{"id":{"type":"string","description":"Variation ID"},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"}}}},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"last_imported_price":{"type":"integer","description":"Imported price"},"retail_price":{"type":"integer","description":"Variation retail price"},"price_at_counter":{"type":"integer","description":"Counter price"},"retail_price_by_currency":{"type":"array","description":"Retail prices by currency (for shops using multiple currencies). If sent, the list is saved as is, so include every currency you want to keep. If omitted while `retail_price` is sent and the shop uses multiple currencies, the price of the shop's default currency is synced from `retail_price`.","items":{"$ref":"#/components/schemas/RetailPriceByCurrency"}},"weight":{"type":"integer","description":"Variation weight"},"size":{"$ref":"#/components/schemas/VariationSize"},"barcode":{"type":"string","description":"Variation barcode"},"custom_id":{"type":"string","description":"Variation custom ID"},"is_hidden":{"type":"boolean","description":"Store cake status variation"},"variations_warehouses":{"type":"array","description":"Warehouse info","items":{"$ref":"#/components/schemas/VariationWarehouse"}},"wholesale_price2":{"type":"array","description":"Wholesale prices by product quantity","items":{"type":"object","properties":{"levelProduct":{"type":"string","description":"Product quantity to apply the wholesale price"},"wholesalePrices":{"type":"string","description":"Wholesale price"}}}},"is_removed":{"type":"boolean","description":"Is removed"},"keyword":{"type":"string","description":"Keyword"}}},"Product":{"type":"object","description":"Product information","required":["name","weight"],"properties":{"measure_group_id":{"type":"integer","description":"Measure group ID","example":58},"name":{"type":"string","description":"Product name"},"type":{"type":"string","enum":["product","accessory","service","LOT"],"description":"Product type. `product`: Product (default). `accessory`: Accessory, comes with orders, has no retail price (retail price is reset to 0) and is not counted in sold quantity reports. `service`: Service, inventory is not managed. `LOT`: Product with expiry date, inventory is managed by lot and a lot must be chosen when importing or exporting stock (requires the shop to enable lot management).","example":"product"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"note":{"type":"string","description":"Internal note"},"note_product":{"type":"string","description":"Product note"},"product_attributes":{"type":"array","description":"Product attributes","items":{"type":"object","properties":{"name":{"type":"string","description":"Attribute name"},"values":{"type":"array","description":"Attribute values","items":{"type":"string"}}}}},"tags":{"type":"array","description":"Product tags","items":{"type":"integer"}},"weight":{"type":"integer","description":"Product weight"},"custom_id":{"type":"string","description":"Product custom ID"},"is_published":{"type":"boolean","description":"Store cake status"},"variations":{"type":"array","description":"Product variations","items":{"$ref":"#/components/schemas/Variation"}},"bonus_products":{"type":"array","description":"Bonus products","items":{"type":"object","required":["quantity","variation_id","price_original","variation_info"],"properties":{"quantity":{"type":"integer","description":"Bonus product quantity"},"variation_id":{"type":"string","description":"Variation ID of the bonus product"},"price_original":{"type":"integer","description":"Original price of the bonus product"},"images":{"type":"array","description":"Bonus product images","items":{"type":"string","format":"uri"}},"variation_info":{"type":"object","description":"Variation information of the bonus product","required":["id","name","product_id"],"properties":{"id":{"type":"string","description":"Variation info ID"},"measure_group_id":{"type":"string","description":"Measure group ID"},"measure_info":{"type":"object","description":"Measure unit information (present when measure_group_id exists)","properties":{"exchange_value":{"type":"integer","description":"Exchange value"},"measure_id":{"type":"integer","description":"Measure ID"}}},"name":{"type":"string","description":"Variation name"},"product_id":{"type":"string","description":"Product ID"},"weight":{"type":"integer","description":"Weight"}}}}}},"materials":{"type":"array","description":"Material IDs","items":{"type":"integer"}},"keyword":{"type":"string","description":"Keyword"},"brand_id":{"type":"string","format":"uuid","description":"Brand ID"}}},"Customer":{"type":"object","description":"Customer information","properties":{"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Full name"},"gender":{"type":"string","description":"Gender"},"emails":{"type":"array","description":"Email addresses","items":{"type":"string"}},"phone_numbers":{"type":"array","description":"Phone numbers","items":{"type":"string"}},"pages_customers":{"type":"array","description":"Customer's linked pages","items":{"type":"object","properties":{"id":{"type":"string","description":"Page ID"},"name":{"type":"string","description":"Page name"},"platform":{"type":"string","description":"Platform"}}}},"date_of_birth":{"type":"string","format":"date","description":"Date of birth"},"reward_point":{"type":"number","description":"Reward point"},"is_discount_by_level":{"type":"boolean","description":"Discount based on level"},"tags":{"type":"array","description":"Customer tags","items":{"type":"string"}},"is_block":{"type":"boolean","description":"Block customer"},"assigned_user_id":{"type":"string","description":"Assigned employee ID"},"level_id":{"type":"string","description":"Customer level ID"},"notes":{"type":"array","description":"Customer notes","items":{"type":"object","properties":{"id":{"type":"string","description":"Note ID"},"message":{"type":"string","description":"Note content"},"images":{"type":"array","description":"Note images","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"}}}}}}},"shop_customer_address":{"type":"array","description":"Customer addresses","items":{"type":"object","properties":{"id":{"type":"string","description":"Address ID (include to update, omit to create new)"},"country_code":{"type":"integer","description":"Country code"},"province_id":{"type":"string","description":"Province ID"},"district_id":{"type":"string","description":"District ID"},"commune_id":{"type":"string","description":"Commune ID"},"address":{"type":"string","description":"Address"},"full_address":{"type":"string","description":"Full address"},"full_name":{"type":"string","description":"Recipient name"},"phone_number":{"type":"string","description":"Phone number"}}}},"order_count":{"type":"integer","description":"Order count"},"purchased_amount":{"type":"integer","description":"Purchased amount"},"succeed_order_count":{"type":"integer","description":"Succeed order count"},"last_order_at":{"type":"string","format":"date-time","description":"Last order at"},"conversation_link":{"type":"string","format":"uri","description":"Conversation link"},"referral_code":{"type":"string","description":"Referral code"},"fb_id":{"type":"string","description":"Facebook ID"},"customer_id":{"type":"string","description":"Customer ID"}}},"eCommerceProduct":{"type":"object","description":"eCommerce platform product information","properties":{"id":{"type":"string","description":"Product ID on eCommerce platform","example":"46152996242"},"linked_product_custom_id":{"type":"string","description":"Linked product ID","example":"ANPR"},"linked_product_name":{"type":"string","description":"Linked product name","example":"Áo nam Pari đẹp thời trang"},"marketplace_id":{"type":"string","description":"Marketplace ID","example":"-3"},"marketplace_shop_name":{"type":"string","description":"Marketplace shop name","example":"Vũ Sơn shop"},"name":{"type":"string","description":"Product name on eCommerce platform","example":"Áo nam Pari đẹp thời trang"},"price":{"type":"integer","description":"Product price","example":0},"sku":{"type":"string","description":"Product SKU","example":"ANPR"},"variations":{"type":"array","description":"Product variations","items":{"type":"object","properties":{"id":{"type":"string","description":"Variation ID on eCommerce platform","example":"375286372857"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri","example":"https://content.pancake.vn/user-content-dev2.pancake.vn/2025/9/17/abad91b33fa9a051b86d415f6cf63aba00d360ac.jpg"}},"linked_product_custom_id":{"type":"string","description":"Linked product custom ID","example":"ANPR"},"linked_variation_custom_id":{"type":"string","description":"Linked variation ID","example":"TESTMATDOS"},"linked_variation_fields":{"type":"array","description":"Linked variation fields","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Field ID","example":"2b61c249-35dc-4b79-a3aa-a173c63a8061"},"keyValue":{"type":"string","description":"Field key value","example":"BLUE"},"name":{"type":"string","description":"Field name","example":"color"},"value":{"type":"string","description":"Field value","example":"blue"}}}},"linked_variation_price":{"type":"integer","description":"Linked variation price","example":150000},"name":{"type":"string","description":"Variation name","example":"blue L"},"price":{"type":"integer","description":"Variation price","example":165000},"quantity":{"type":"integer","description":"Variation quantity","example":1025},"sku":{"type":"string","description":"Variation SKU","example":"TESTMATDOS"}}}},"warehouse":{"type":"string","description":"Warehouse name","example":"Kho HN"}}},"Transaction":{"type":"object","description":"Transaction information","properties":{"id":{"type":"string","description":"Transaction ID"},"display_id":{"type":"string","description":"Transaction ID"},"name":{"type":"string","description":"Transaction name"},"note":{"type":"string","description":"Note"},"amount":{"type":"integer","description":"Amount of money"},"status":{"type":"integer","description":"Status","enum":[-1,0,1,2,3],"x-enum-descriptions":["All status","New","Effective","Canceled","Deleted"]},"is_locked":{"type":"boolean","description":"Locked"},"is_canceled":{"type":"boolean","description":"Is canceled"},"is_accounting":{"type":"boolean","description":"Financial accounting"},"payment_debts_to_suppliers":{"type":"boolean","description":"Paying off debts to suppliers"},"payments":{"type":"array","description":"Payment method","items":{"type":"string"}},"tag_ids":{"type":"array","description":"Transaction tags","items":{"type":"string"}},"supplier_products_id":{"type":"integer","description":"Supplier products ID"},"advertising_cost_id":{"type":"string","description":"Advertising cost ID"},"shop_id":{"type":"integer","description":"Shop ID"},"creator_id":{"type":"string","description":"Creator ID"},"creator":{"type":"object","description":"Creator information","properties":{"id":{"type":"string"},"name":{"type":"string"},"fb_id":{"type":"string"},"avatar_url":{"type":"string","format":"uri"}}},"images":{"type":"array","description":"Image links","items":{"type":"string","format":"uri"}},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"time_incurred":{"type":"string","format":"date-time","description":"Time incurred"},"table_name":{"type":"string","description":"Table name"},"orderId":{"type":"string","description":"Order ID"}}},"Debt":{"type":"object","description":"Debt information","properties":{"id":{"type":"string","description":"Debt ID"},"display_id":{"type":"integer","description":"Debt ID"},"name_debt":{"type":"string","description":"Debt name"},"description":{"type":"string","description":"Description"},"status":{"type":"integer","description":"Status","enum":[-1,0,1,2],"x-enum-descriptions":["All status","Not transacted / Partial payment","Traded","Canceled"]},"type":{"type":"integer","description":"Debt type (0: Debt must pay / 1: Debt must collect)"},"money_must_pay_or_collect":{"type":"integer","description":"Total amount to be paid / Total amount to be collected"},"money_payed_or_collected":{"type":"integer","description":"Paid amount / Collected amount"},"currency":{"type":"string","description":"Currency"},"shop_id":{"type":"integer","description":"Shop ID"},"shop_customer_id":{"type":"string","description":"Customer ID"},"shop_customer":{"type":"object","description":"Customer information","properties":{"id":{"type":"string"},"name":{"type":"string"},"phone_numbers":{"type":"array","items":{"type":"string"}},"customer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"fb_id":{"type":"string"},"global_id":{"type":"string"},"psid":{"type":"string"}}}}},"order_id":{"type":"integer","description":"Order ID"},"order":{"type":"object","description":"Order information","properties":{"id":{"type":"integer"},"display_id":{"type":"integer"},"custom_id":{"type":"string"},"total_price":{"type":"integer"},"cod":{"type":"integer"},"assigning_seller_id":{"type":"string"},"assigning_seller":{"type":"object"},"items":{"type":"array"}}},"purchase_id":{"type":"string","description":"Purchase ID"},"export_id":{"type":"string","description":"Export ID"},"supplier_products_id":{"type":"integer","description":"Supplier products ID"},"transaction_id":{"type":"string","description":"Transaction ID"},"partner_id":{"type":"string","description":"Partner ID"},"creator_id":{"type":"string","description":"Creator ID"},"last_editor_id":{"type":"string","description":"Last editor ID"},"user":{"type":"object","description":"Creator information","properties":{"id":{"type":"string"},"name":{"type":"string"},"fb_id":{"type":"string"},"phone_number":{"type":"string"}}},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"expired_at":{"type":"string","format":"date-time","description":"Expired at"},"is_locked":{"type":"boolean","description":"Debt locked"},"link":{"type":"string","format":"uri","description":"Link"}}},"Project":{"type":"object","description":"Project information","properties":{"id":{"type":"integer","description":"Project ID"},"image":{"type":"string","nullable":true,"format":"uri","description":"Project image URL"},"inserted_at":{"type":"string","format":"date-time","description":"Created timestamp"},"name":{"type":"string","description":"Project name"},"nodes":{"type":"array","description":"Child source orders of project","items":{"$ref":"#/components/schemas/ProjectNode"}},"shop_id":{"type":"integer","description":"Shop ID"},"updated_at":{"type":"string","format":"date-time","description":"Updated timestamp"}}},"ProjectNode":{"type":"object","description":"Project node information","properties":{"id":{"type":"integer","description":"Source order ID"},"image":{"type":"string","nullable":true,"format":"uri","description":"Source order image URL"},"inserted_at":{"type":"string","format":"date-time","description":"Created timestamp"},"name":{"type":"string","description":"Source order name"},"nodes":{"type":"array","description":"Child source orders","items":{"$ref":"#/components/schemas/ProjectNode"}},"parent_id":{"type":"integer","nullable":true,"description":"Parent source order ID"},"project_id":{"type":"integer","nullable":true,"description":"Project ID"},"shop_id":{"type":"integer","description":"Shop ID"},"updated_at":{"type":"string","format":"date-time","description":"Updated timestamp"},"custom_id":{"type":"string","nullable":true,"description":"Custom source order ID"},"link_source_id":{"type":"integer","nullable":true,"description":"Link source ID"}}},"Category":{"type":"object","properties":{"data":{"type":"object","description":"Product category information","properties":{"id":{"type":"integer","description":"Category ID"},"name":{"type":"string","description":"Category name"}}},"success":{"type":"boolean","description":"Success status"}}},"Brand":{"type":"object","description":"Product brand information","properties":{"id":{"type":"string","format":"uuid","description":"Brand ID"},"name":{"type":"string","description":"Brand name"},"description":{"type":"string","nullable":true,"description":"Brand description"},"display_id":{"type":"integer","description":"Display ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Created time"},"updated_at":{"type":"string","format":"date-time","description":"Updated time"}}},"Purchase":{"type":"object","description":"Purchase information","properties":{"id":{"type":"string","description":"Purchase ID"},"display_id":{"type":"integer","description":"Purchase ID"},"status":{"type":"integer","description":"Status","enum":[-2,-1,0,1,2],"x-enum-descriptions":["All status","New","Confirmed","Imported goods","Canceled"]},"time_import":{"type":"string","format":"date-time","description":"Time import"},"total_quantity":{"type":"integer","description":"Total quantity"},"total_remain_quantity":{"type":"integer","description":"Total remain quantity"},"total_price":{"type":"integer","description":"Total purchase price"},"total_remain_price":{"type":"integer","description":"Total remain price"},"note":{"type":"string","description":"Note"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"supplier_products_id":{"type":"integer","description":"Supplier products ID"},"supplier":{"type":"object","description":"Supplier information","properties":{"id":{"type":"integer"},"name":{"type":"string"},"custom_id":{"type":"string"}}},"discount":{"type":"integer","description":"Discount"},"transport_fee":{"type":"integer","description":"Shipping fee"},"prepaid_debt":{"type":"integer","description":"Prepaid debt"},"auto_create_debts":{"type":"boolean","description":"Auto create debts"},"not_create_transaction":{"type":"boolean","description":"Not create transaction"},"is_lock":{"type":"boolean","description":"Locked"},"created_type":{"type":"string","description":"Purchase type"},"tags":{"type":"array","description":"Tag IDs","items":{"type":"integer"}},"tag_info":{"type":"array","description":"Purchase tag information","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"items":{"type":"array","description":"Variation information","items":{"type":"object","properties":{"id":{"type":"string"},"imported_price":{"type":"integer","description":"Imported price"},"gross_price":{"type":"integer","description":"Gross price"},"discount":{"type":"integer","description":"Discount on product"},"quantity":{"type":"integer","description":"Import quantity"},"variation_id":{"type":"string","description":"Variation ID"},"product_name":{"type":"string","description":"Product name"},"note_purchase":{"type":"string","description":"Note"},"selling_status":{"type":"string","description":"Selling status"},"variation":{"type":"object","properties":{"id":{"type":"string"},"display_id":{"type":"string"},"barcode":{"type":"string"},"product_id":{"type":"string"},"retail_price":{"type":"integer"},"retail_price_after_discount":{"type":"integer"},"remain_quantity":{"type":"integer"},"weight":{"type":"integer"},"product":{"type":"object","properties":{"display_id":{"type":"string"},"name":{"type":"string"}}},"variations_warehouses":{"type":"array","items":{"$ref":"#/components/schemas/VariationWarehouse"}}}}}}},"images":{"type":"array","description":"Purchase images","items":{"type":"string","format":"uri"}},"bill_images":{"type":"array","description":"Invoice images","items":{"type":"string","format":"uri"}},"user_id":{"type":"string","description":"Creator ID"},"user":{"type":"object","description":"Creator information","properties":{"id":{"type":"string"},"name":{"type":"string"},"fb_id":{"type":"string"},"avatar_url":{"type":"string","format":"uri"}}},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"received_at":{"type":"string","format":"date-time","description":"Received at"},"separate_by_display_ids":{"type":"integer","description":"Purchase ID separated"}}},"Export":{"type":"object","description":"Export information","properties":{"id":{"type":"string","description":"Export ID"},"display_id":{"type":"integer","description":"Export ID"},"status":{"type":"integer","description":"Export status","enum":[0,1,2],"x-enum-descriptions":["New (type 0) / Defect export (type 1)","Completed (type 0) / Elimination export (type 1)","Canceled"]},"type":{"type":"integer","description":"Type of export","enum":[0,1],"x-enum-descriptions":["Normal export","Product defect export"]},"total":{"type":"integer","description":"Total quantity"},"total_price":{"type":"integer","description":"Total export price"},"note":{"type":"string","description":"Note"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"supplier_products_id":{"type":"integer","description":"Supplier products ID"},"tags":{"type":"array","description":"Tag IDs","items":{"type":"integer"}},"export_items":{"type":"array","description":"List of products","items":{"type":"object","properties":{"id":{"type":"string","description":"Export item ID"},"imported_price":{"type":"integer","description":"Export price"},"quantity":{"type":"integer","description":"Export quantity"},"variation_id":{"type":"string","description":"Variation ID"},"display_id":{"type":"integer","description":"Display ID"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"}}}},"images":{"type":"array","description":"Export images","items":{"type":"string","format":"uri"}},"user_id":{"type":"string","description":"Creator ID"},"user":{"type":"object","description":"Creator information","properties":{"id":{"type":"string"},"name":{"type":"string"},"fb_id":{"type":"string"},"avatar_url":{"type":"string","format":"uri"}}},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}},"WarehouseTransfer":{"type":"object","description":"Warehouse transfer information","properties":{"id":{"type":"string","description":"Transfer ID"},"display_id":{"type":"integer","description":"Transfer ID"},"status":{"type":"integer","description":"Status","enum":[0,1,2],"x-enum-descriptions":["Waiting for pick up","Shipping","Completed"]},"from_warehouse_id":{"type":"string","description":"From warehouse ID"},"from_warehouse_name":{"type":"string","description":"From warehouse name"},"to_warehouse_id":{"type":"string","description":"To warehouse ID"},"to_warehouse_name":{"type":"string","description":"To warehouse name"},"total_quantity":{"type":"integer","description":"Total quantity"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"note":{"type":"string","description":"Note"},"items":{"type":"array","description":"List of products","items":{"type":"object","properties":{"id":{"type":"string","description":"Transfer item ID"},"variation_id":{"type":"string","description":"Variation ID"},"quantity":{"type":"integer","description":"Transfer quantity"},"product_display_id":{"type":"string","description":"Product ID"},"product_name":{"type":"string","description":"Product name"},"variation_display_id":{"type":"string","description":"Variation ID"},"variation_fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"keyValue":{"type":"string"}}}}}}},"images":{"type":"array","description":"Transfer images","items":{"type":"string","format":"uri"}},"shop_id":{"type":"integer","description":"Shop ID"},"creator_id":{"type":"string","description":"Creator ID"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"updated_status_at":{"type":"string","format":"date-time","description":"Updated status at"}}},"Stocktaking":{"type":"object","description":"Stocktaking information","properties":{"id":{"type":"string","description":"Stocktaking ID"},"display_id":{"type":"integer","description":"Stocktaking ID"},"status":{"type":"integer","description":"Status","enum":[-2,-1,0,1,2],"x-enum-descriptions":["All status","Creating","Stocktaking","Stocktook","Canceled"]},"warehouse_id":{"type":"string","description":"Warehouse ID"},"stocktaking_by":{"type":"string","description":"Stocktaking by"},"stocktaking_by_value":{"type":"array","description":"Category ID / Supplier products ID / Brand ID","items":{"type":"string"}},"stocktaking_at":{"type":"string","format":"date-time","description":"Stocktaking at"},"progress":{"type":"integer","description":"Processing percentage"},"note":{"type":"string","description":"Note"},"items":{"type":"array","description":"List of products","items":{"type":"object","properties":{"id":{"type":"string","description":"Stocktaking item ID"},"variation_id":{"type":"string","description":"Variation ID"},"changed_quantity":{"type":"integer","description":"Changed quantity"},"current_quantity":{"type":"integer","description":"Current quantity"},"note":{"type":"string","description":"Note"},"variation":{"type":"object","description":"Variation information","properties":{"id":{"type":"string"},"display_id":{"type":"string"},"barcode":{"type":"string"},"product_id":{"type":"string"},"retail_price":{"type":"integer"},"last_imported_price":{"type":"integer"},"weight":{"type":"integer"},"fields":{"type":"array","items":{"type":"object"}},"images":{"type":"array","items":{"type":"string","format":"uri"}},"product":{"type":"object","properties":{"display_id":{"type":"string"},"name":{"type":"string"},"image":{"type":"string","format":"uri"},"note_product":{"type":"string"},"note":{"type":"string","description":"Internal note"}}}}},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"shop_id":{"type":"integer","description":"Shop ID"},"creator_id":{"type":"string","description":"Creator ID"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"updated_status_at":{"type":"string","format":"date-time","description":"Updated status at"}}},"LotProduct":{"type":"object","description":"Expiry-date lot of a product","properties":{"id":{"type":"string","description":"Lot ID"},"custom_id":{"type":"string","description":"Lot code"},"expire_date":{"type":"string","format":"date-time","description":"Expiry date (UTC)"},"manufacturing_date":{"type":"string","format":"date-time","description":"Manufacturing date (UTC)"},"inserted_at":{"type":"string","format":"date-time","description":"Created at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"product":{"$ref":"#/components/schemas/LotProductInfo"},"lot_variations":{"type":"array","description":"Variations of the product linked to this lot","items":{"type":"object","description":"Link between a lot and a variation","properties":{"id":{"type":"string","description":"Lot-variation ID"},"variation_id":{"type":"string","description":"Variation ID"},"inserted_at":{"type":"string","format":"date-time","description":"Created at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}}}},"LotProductInfo":{"type":"object","description":"Product of the lot (variations are not included)","properties":{"id":{"type":"string","description":"Product ID"},"name":{"type":"string","description":"Product name"},"type":{"type":"string","description":"Product type, always `LOT` for expiry-date products","example":"LOT"},"custom_id":{"type":"string","nullable":true,"description":"Product custom ID"},"display_id":{"type":"integer","description":"Product display ID"},"image":{"type":"string","nullable":true,"description":"Product image URL"},"is_published":{"type":"boolean","nullable":true,"description":"Store cake status"},"is_sell_negative":{"type":"boolean","nullable":true,"description":"Allow selling with negative stock"},"note":{"type":"string","nullable":true,"description":"Internal note"},"note_product":{"type":"string","description":"Product note (HTML)"},"measure_group_id":{"type":"integer","nullable":true,"description":"Measure group ID"},"brand_id":{"type":"string","nullable":true,"description":"Brand ID"},"creator_id":{"type":"string","nullable":true,"description":"Creator ID"},"inserted_at":{"type":"string","format":"date-time","description":"Created at"},"categories":{"type":"array","description":"Product categories","items":{"type":"object","properties":{"id":{"type":"integer","description":"Category ID"},"name":{"type":"string","description":"Category name"}}}},"tags":{"type":"array","description":"Product tags","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"note":{"type":"string","description":"Tag name"}}}},"materials":{"type":"array","description":"Material IDs","items":{"type":"integer"}},"supplier_product_ids":{"type":"array","description":"Supplier IDs","items":{"type":"integer"}},"manipulation_warehouses":{"type":"array","description":"Warehouse IDs the product is operated in","items":{"type":"string"}},"product_attributes":{"type":"array","description":"Product attributes","items":{"type":"object","properties":{"id":{"type":"string","description":"Attribute ID"},"name":{"type":"string","description":"Attribute name"},"values":{"type":"array","description":"Attribute values","items":{"type":"string"}},"keyword":{"type":"array","description":"Keyword of each attribute value","items":{"type":"object","properties":{"keyValue":{"type":"string","description":"Keyword"},"value":{"type":"string","description":"Attribute value"}}}}}}},"bonus_products":{"type":"array","description":"Bonus products","items":{"type":"object","properties":{"variation_id":{"type":"string","description":"Variation ID of the bonus product"},"quantity":{"type":["string","number"],"description":"Bonus quantity"},"price_original":{"type":["string","number"],"description":"Original price of the bonus product"},"variation_info":{"type":"object","description":"Variation information of the bonus product"}}}},"limit_quantity_to_warn":{"type":"integer","nullable":true,"description":"Low-stock warning threshold"},"limit_quantity_to_warn_by_warehouse":{"type":"object","nullable":true,"description":"Low-stock warning threshold per warehouse (key is warehouse ID)","additionalProperties":{"type":"integer"}},"warning_by_variation":{"type":"boolean","nullable":true,"description":"Low-stock warning is applied per variation"}}},"CallLater":{"type":"object","description":"Call later and remind information","properties":{"id":{"type":"string","description":"ID"},"display_id":{"type":"integer","description":"Call later and remind ID"},"called_at":{"type":"string","format":"date-time","description":"Called at / Process at"},"needs_call_at":{"type":"string","format":"date-time","description":"Need call at / Need process at"},"notice_created":{"type":"string","description":"Notice information"},"order_display_id":{"type":"string","description":"Order ID"},"order_id":{"type":"integer","description":"Order ID"},"status":{"type":"integer","description":"Status","enum":[-1,0,3,1,2,7],"x-enum-descriptions":["All status","No process","Calling / Processing","Processed","Not listening / Unsuccessful","Removed"]},"type":{"type":"string","description":"Notification type"},"need_notify_users":{"type":"array","description":"Process staff","items":{"type":"string"}},"creator":{"type":"object","description":"Creator information","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"fb_id":{"type":"string"},"avatar_url":{"type":"string","format":"uri"},"phone_number":{"type":"string"}}},"phone_number":{"type":"string","description":"Phone number"}}},"Voucher":{"type":"object","description":"Voucher information","properties":{"id":{"type":"string","description":"Voucher ID"},"display_id":{"type":"integer","description":"Voucher ID"},"name":{"type":"string","description":"Voucher name"},"type":{"type":"string","description":"Voucher type"},"start_time":{"type":"string","format":"date-time","description":"Voucher start time"},"end_time":{"type":"string","format":"date-time","description":"Voucher end time"},"promo_code_info":{"type":"object","description":"Voucher promo code information","properties":{"discount":{"type":"integer","description":"Discount value"},"is_percent":{"type":"boolean","description":"Is percent"},"max_discount_by_percent":{"type":"integer","description":"Maximum discount by percent"}}},"is_free_shipping":{"type":"boolean","description":"Is free shipping"},"is_activated":{"type":"boolean","description":"Is activated"},"is_used":{"type":"boolean","description":"Is used"},"customer_tags":{"type":"array","description":"Customer tags","items":{"type":"string"}},"shop_id":{"type":"integer","description":"Shop ID"},"creator_id":{"type":"string","description":"Creator ID"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}},"Promotion":{"type":"object","description":"Promotion information","properties":{"id":{"type":"string","description":"Promotion ID"},"display_id":{"type":"string","description":"Promotion display ID"},"name":{"type":"string","description":"Promotion name"},"type":{"type":"string","description":"Promotion type"},"start_time":{"type":"string","format":"date-time","description":"Start time"},"end_time":{"type":"string","format":"date-time","description":"End time"},"warehouse_ids":{"type":"array","description":"Warehouse IDs","items":{"type":"string"}},"customer_tags":{"type":"array","description":"Customer tags","items":{"type":"string"}},"order_sources":{"type":"array","description":"Order sources","items":{"type":"object"}},"group_name":{"type":"string","description":"Promotion group"},"is_activated":{"type":"boolean","description":"Is activated"},"is_variation":{"type":"boolean","description":"Is variation"},"is_used":{"type":"boolean","description":"Is used"},"is_free_shipping":{"type":"boolean","description":"Is free shipping"},"is_discount_in_birthday_customer":{"type":"boolean","description":"Is discount in birthday customer"},"coupon_info":{"type":"object","description":"Coupon information","properties":{"discount":{"type":"integer","description":"Discount"},"is_percent":{"type":"boolean","description":"Is percent"}}},"promo_code_info":{"type":"object","description":"Promotion code information","properties":{"discount":{"type":"integer","description":"Discount"},"is_percent":{"type":"boolean","description":"Is percent"},"max_discount_by_percent":{"type":"integer","description":"Maximum discount by percent"}}},"discount_by_quantity":{"type":"integer","description":"Discount by quantity"},"items":{"type":"array","description":"List of promotion items (products/variations the promotion applies to)","items":{"type":"object","properties":{"id":{"type":"string","description":"Promotion item ID"},"promotion_advance_id":{"type":"string","description":"Promotion ID"},"shop_id":{"type":"integer","description":"Shop ID"},"product_id":{"type":"string","nullable":true,"description":"Product ID (when promotion is applied by product)"},"variation_id":{"type":"string","nullable":true,"description":"Variation ID (when promotion is applied by variation)"},"category_id":{"type":"string","nullable":true,"description":"Category ID (when promotion is applied by category)"},"product":{"type":"object","nullable":true,"description":"Product information (when promotion is applied by product)"},"variation":{"type":"object","nullable":true,"description":"Variation information (when promotion is applied by variation)"},"level_info":{"type":"array","description":"Discount levels by quantity","items":{"type":"object","properties":{"discount":{"type":"number","description":"Discount value"},"is_percent":{"type":"boolean","description":"Is percent"},"from_quantity":{"type":"integer","description":"From quantity"},"to_quantity":{"type":"integer","description":"To quantity"}}}},"fixed_prices":{"type":"number","description":"Fixed price"},"coupon_item_info":{"type":"object","description":"Coupon information of the item","properties":{"discount":{"type":"number","description":"Discount"},"is_percent":{"type":"boolean","description":"Is percent"}}},"limited_quantity":{"type":"integer","description":"Limited quantity"},"limited_quantity_used":{"type":"integer","description":"Limited quantity used"},"attachment_product_info":{"type":"array","description":"Attached product information","items":{"type":"object","properties":{"product_id":{"type":"string","nullable":true,"description":"Attached product ID"},"variation_id":{"type":"string","nullable":true,"description":"Attached variation ID"},"quantity":{"type":"integer","description":"Attached product quantity"}}}},"discount_info_by_attachment_product":{"type":"object","nullable":true,"description":"Discount by attached product","properties":{"discount":{"type":"number","description":"Discount value"},"is_percent":{"type":"boolean","description":"Is percent"},"quantity":{"type":"integer","description":"Quantity to apply discount"}}},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"bonus_items":{"type":"array","description":"Bonus items","items":{"type":"object"}},"total_quantity_bonus":{"type":"integer","description":"Total quantity bonus"},"arr_level_promotion":{"type":"array","description":"Level promotion array","items":{"type":"object"}},"level_order_prices":{"type":"array","description":"Level order prices","items":{"type":"object"}},"priority_level":{"type":"integer","description":"Priority level"},"type_employee":{"type":"string","description":"Type employee"},"post_ids":{"type":"array","description":"Post IDs","items":{"type":"string"}},"shop_id":{"type":"integer","description":"Shop ID"},"creator_id":{"type":"string","description":"Creator ID"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}},"LivestreamManager":{"type":"object","description":"Livestream session information","properties":{"creator":{"type":"object","description":"Creator information","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"fb_id":{"type":"string","description":"Facebook ID"},"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"}}},"end_time":{"type":"string","description":"End time of the livestream session"},"finisher":{"type":"object","description":"Finisher information","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"fb_id":{"type":"string","description":"Facebook ID"},"id":{"type":"string","description":"Finisher ID"},"name":{"type":"string","description":"Finisher name"}}},"id":{"type":"string","description":"Livestream session ID"},"inserted_at":{"type":"string","description":"Created date"},"name":{"type":"string","description":"Livestream session name (campaign)"},"origin_post_id":{"type":"string","description":"Origin post ID"},"post_ids":{"type":"array","items":{"type":"string"},"description":"List of post IDs"},"remain_warehouse_ids":{"type":"array","items":{"type":"string"},"description":"List of inventory sync warehouse IDs"},"shop_id":{"type":"integer","description":"Shop ID"},"start_time":{"type":"string","description":"Start time of the livestream session"},"total_comments":{"type":"integer","description":"Total number of comments"},"total_customers":{"type":"integer","description":"Total number of customers"},"warehouse_id":{"type":"string","description":"Order creation warehouse ID"}}},"PaginatedResponse":{"type":"object","description":"Paginated response","properties":{"data":{"type":"array","description":"List of items"},"page_number":{"type":"integer","description":"Page number"},"page_size":{"type":"integer","description":"Page size"},"success":{"type":"boolean","description":"Success status"},"total_entries":{"type":"integer","description":"Total entries"},"total_pages":{"type":"integer","description":"Total pages"}}},"SimpleResponse":{"type":"object","description":"Simple response with success status","properties":{"success":{"type":"boolean","description":"Success status"}}},"DataResponse":{"type":"object","description":"Response with data and success status","properties":{"data":{"description":"Response data"},"success":{"type":"boolean","description":"Success status"}}},"WebhookOrderResponse":{"type":"object","description":"Webhook response when webhook_types includes orders","allOf":[{"type":"object","properties":{"id":{"type":"integer","description":"Order ID"},"system_id":{"type":"integer","description":"System ID"},"shop_id":{"type":"integer","description":"Shop ID"},"inserted_at":{"type":"string","format":"date-time","description":"Order creation time"},"updated_at":{"type":"string","format":"date-time","description":"Order update time"},"status":{"type":"integer","description":"Order status","enum":[0,17,11,12,13,20,1,8,9,2,3,16,4,15,5,6,7],"x-enum-descriptions":["New","Waiting for confirmation","Restocking","Wait for printing","Printed","Purchased","Confirmed","Packaging","Waiting for pick up","Shipped","Received","Collected money","Returning","Partial return","Returned","Canceled","Deleted recently"]},"status_name":{"type":"string","description":"Order status name"},"bill_full_name":{"type":"string","description":"Customer name"},"bill_phone_number":{"type":"string","description":"Phone number of customer"},"bill_email":{"type":"string","description":"Customer email"},"conversation_id":{"type":"string","description":"Conversation ID"},"page_id":{"type":"string","description":"Facebook page ID"},"post_id":{"type":"string","description":"Post ID"},"ad_id":{"type":"string","description":"Ad ID"},"shipping_fee":{"type":"integer","description":"Shipping fee"},"partner_fee":{"type":"integer","description":"Fee from shipping partner"},"fee_marketplace":{"type":"integer","description":"Fees from e-commerce platforms"},"customer_pay_fee":{"type":"boolean","description":"Customer pay shipping fee"},"is_free_shipping":{"type":"boolean","description":"Free shipping"},"is_livestream":{"type":"boolean","description":"Is livestream order"},"is_live_shopping":{"type":"boolean","description":"Is live shopping order"},"is_smc":{"type":"boolean","description":"Shopping on Messenger"},"received_at_shop":{"type":"boolean","description":"true: Sales at counter, false: Sell online"},"total_discount":{"type":"integer","description":"Discount total"},"note":{"type":"string","description":"Internal note"},"note_print":{"type":"string","description":"Note for printing"},"returned_reason":{"type":"integer","description":"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_name":{"type":"string","description":"Return reason name"},"sub_status":{"type":"integer","description":"Reason for delivery delay"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"warehouse_info":{"type":"object","description":"Warehouse information","properties":{"name":{"type":"string","description":"Warehouse name"},"phone_number":{"type":"string","description":"Warehouse phone number"},"full_address":{"type":"string","description":"Warehouse full address"},"address":{"type":"string","description":"Warehouse address"},"province_id":{"type":"string","description":"Province ID"},"district_id":{"type":"string","description":"District ID"},"commune_id":{"type":"string","description":"Commune ID"},"affiliate_id":{"type":"string","description":"Affiliate ID"},"ffm_id":{"type":"string","description":"FFM ID"},"has_snappy_service":{"type":"boolean","description":"Has Snappy service"},"custom_id":{"type":"string","description":"Custom ID"}}},"creator_id":{"type":"string","description":"Creator ID"},"creator":{"type":"object","description":"Order creator","properties":{"id":{"type":"string","description":"Creator ID"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"name":{"type":"string","description":"Creator name"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"items":{"type":"array","description":"Product list. When creating or updating an order, each entry must include `variation_id` and `quantity`. `variation_info` is optional — if omitted, the backend treats it as an empty object; send it (with `retail_price`) when you need the line price to be explicit.","items":{"type":"object","required":["variation_id","quantity"],"properties":{"product_id":{"type":"string","description":"Product ID"},"quantity":{"type":"integer","description":"Quantity"},"returned_count":{"type":"integer","description":"Returned count"},"assigning_seller_id":{"type":"string","description":"Assigning seller ID"},"quantity_by_combo_products":{"type":"array","description":"Quantity by combo products","items":{"type":"object"}},"discount_each_product":{"type":"integer","description":"Discount for each product"},"is_bonus_product":{"type":"boolean","description":"Is bonus product"},"is_discount_percent":{"type":"boolean","description":"Is discount by percent"},"is_wholesale":{"type":"boolean","description":"Is wholesale"},"is_composite":{"type":"boolean","description":"Is composite product"},"one_time_product":{"type":"boolean","description":"One time product"},"note":{"type":"string","description":"Product note"},"note_product":{"type":"string","description":"Product note"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"measure_group_id":{"type":"integer","description":"Measure group ID"},"variation_info":{"type":"object","description":"Variation information. Optional when creating/updating an order (the backend defaults it to an empty object if omitted). Its inner fields are not individually required, but sending `retail_price` is recommended so the line price is correct.","properties":{"id":{"type":"string","description":"Variation ID"},"name":{"type":"string","description":"Product name"},"product_id":{"type":"string","description":"Product ID"},"retail_price":{"type":"integer","description":"Retail price. Not strictly required, but recommended when creating/updating an order so the line price is correct."},"detail":{"type":"string","description":"Variation detail"},"images":{"type":"array","description":"Variation images","items":{"type":"string","format":"uri"}},"fields":{"type":"array","description":"Variation fields","items":{"type":"object","properties":{"id":{"type":"string","description":"Field ID"},"name":{"type":"string","description":"Field name"},"value":{"type":"string","description":"Field value"},"keyValue":{"type":"string","description":"Key value"}}}},"barcode":{"type":"string","description":"Barcode"},"brand_id":{"type":"string","description":"Brand ID"},"category_ids":{"type":"array","description":"Category IDs","items":{"type":"integer"}},"display_id":{"type":"string","description":"Display ID"},"product_display_id":{"type":"string","description":"Product display ID"},"last_imported_price":{"type":"integer","description":"Last imported price"},"is_upsale_product":{"type":"boolean","description":"Upsale product"},"weight":{"type":"integer","description":"Weight"},"measure_info":{"type":"object","description":"Measure information","properties":{"measure_id":{"type":"integer","description":"Measure ID"},"exchange_value":{"type":"integer","description":"Exchange value"}}},"avg_price":{"type":"integer","description":"Average import price"}}},"components":{"type":"array","description":"Product components","items":{"type":"object","properties":{"component_id":{"type":"string","description":"Component ID"},"quantity":{"type":"integer","description":"Quantity"},"variation_id":{"type":"string","description":"Variation ID"},"variation_info":{"type":"object","description":"Variation information"}}}},"id":{"type":"integer","description":"Item ID"},"variation_id":{"type":"string","description":"Variation ID"}}}},"partner":{"type":"object","description":"Partner information\nWhen updating an order that already has shipping info, only the fields you send are written; omitted fields keep their current values. Send `null` to clear `partner_id`, `extend_code` or `shop_partner_id`.\n","properties":{"partner_id":{"type":"integer","description":"Partner ID"},"cod":{"type":"integer","description":"Reconciliation COD"},"extend_code":{"type":"string","description":"Shipping order ID on partner system"},"total_fee":{"type":"integer","description":"Total fee"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"},"delivery_name":{"type":"string","description":"Shipper name"},"delivery_tel":{"type":"string","description":"Delivery phone"},"picked_up_at":{"type":"string","format":"date-time","description":"Picked up at"},"sort_code":{"type":"string","description":"Sort code"},"paid_at":{"type":"string","format":"date-time","description":"Paid at"},"system_created":{"type":"boolean","description":"System created"},"extend_update":{"type":"array","description":"Update from courier","items":{"type":"object","properties":{"key":{"type":"string","description":"Update key"},"status":{"type":"string","description":"Status"},"tracking_id":{"type":"string","description":"Partner extend code"},"note":{"type":"string","description":"Courier notes"},"update_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"partner_status":{"type":"string","nullable":true,"description":"Partner shipping status","enum":["waiting","request_received","processing_picked_up","picking_up","delay_pickup","picked_up","waiting_on_the_way","on_the_way","contact_delivery_company","out_for_delivery","delay_delivery","inform_recipient","undeliverable","waiting_for_return","delivered","delivered_cod","returning","returned","returned_cod","canceled"],"x-enum-descriptions":["Waiting for processing","Carrier received the request","Processing pickup","Picking up","Delayed pickup","Picked up","Waiting for transit","In transit","Contact the carrier","Out for delivery","Delayed delivery","Notify the recipient","Undeliverable","Waiting for return","Delivered","Delivered, COD reconciled","Returning","Returned","Returned, COD reconciled","Canceled"]},"partner_name":{"type":"string","nullable":true,"description":"Partner name"},"first_delivery_at":{"type":"string","format":"date-time","nullable":true,"description":"First delivery time"},"first_undeliverable_at":{"type":"string","format":"date-time","nullable":true,"description":"First failed delivery time"},"count_of_delivery":{"type":"integer","nullable":true,"minimum":0,"maximum":32767,"description":"Number of delivery attempts. Courier updates add 1 each time the shipment moves to `out_for_delivery` or `delay_delivery`.\nCan be set when creating or updating an order (integer 0-32767); omitted or invalid values keep the current value, and later courier updates keep counting from the value you set.\n","example":2},"order_number_vtp":{"type":"string","nullable":true,"description":"Viettel Post tracking number"},"printed_form":{"type":"object","nullable":true,"description":"Printed form"}}},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"payment_purchase_histories":{"type":"array","description":"Payment histories","items":{"type":"object","properties":{"amount":{"type":"integer","description":"Amount of money"},"type":{"type":"string","description":"Payment type"},"inserted_at":{"type":"string","format":"date-time","description":"Transaction time"},"result_code":{"type":"string","description":"Result code"},"ipn_reply":{"type":"boolean","description":"IPN reply"},"voucher_amount":{"type":"integer","description":"Voucher amount"},"tags":{"type":"array","description":"Tags","items":{"type":"string"}}}}},"tags":{"type":"array","description":"Tags list","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID"},"name":{"type":"string","description":"Tag name"}}}},"marketer":{"type":"object","description":"Marketer information","properties":{"id":{"type":"string","description":"Marketer ID"},"name":{"type":"string","description":"Marketer name"},"email":{"type":"string","description":"Marketer email"},"phone_number":{"type":"string","description":"Marketer phone number"},"fb_id":{"type":"string","description":"Marketer Facebook ID"},"avatar_url":{"type":"string","description":"Marketer avatar URL"}}},"pke_mkter":{"type":"string","description":"Marketer ID"},"activated_combo_products":{"type":"object","description":"Activated combo products information","properties":{"combo_product_id":{"type":"integer","description":"Combo product ID"},"quantity_combo_activated":{"type":"integer","description":"Quantity combo activated"},"combo_product_info":{"type":"object","description":"Combo product information"}}},"activated_promotion_advances":{"type":"array","description":"Activated promotion advances information","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID"},"promotion_advance_id":{"type":"string","description":"Promotion advance ID"},"promotion_advance_info":{"type":"object","description":"Promotion advance information"}}}},"invoice_info_list":{"type":"array","description":"Invoice information list","items":{"type":"object","properties":{"error":{"type":"string","description":"Error message if any"},"invoice_detail":{"type":"object","description":"Invoice detail information. The fields to send depend on `invoice_type`:\n- `company`: use `company_name`, `company_tax_id`, `company_address`, `company_email` (and optionally `company_address_breakdown`).\n- `personal`: use `name`, `phone_number`, `identity_code`, `tax_id`, `email`.\n","properties":{"name":{"type":"string","description":"Full name of the individual requesting the invoice (`invoice_type` = `personal`)","example":"Hoang Anh"},"phone_number":{"type":"string","description":"Phone number of the individual (`invoice_type` = `personal`)","example":"0934283743"},"identity_code":{"type":"string","description":"Citizen identity card / ID number of the individual (`invoice_type` = `personal`)","example":"029374382740"},"tax_id":{"type":"string","description":"Personal tax ID of the individual, if any (`invoice_type` = `personal`)","example":""},"email":{"type":"string","description":"Email of the individual to receive the e-invoice (`invoice_type` = `personal`)","example":""},"company_address":{"type":"string","description":"Company address (`invoice_type` = `company`)"},"company_address_breakdown":{"type":"object","description":"Company address breakdown","properties":{"company_additional_info":{"type":"string","description":"Company additional information"},"company_barangay":{"type":"string","description":"Company barangay"},"company_city":{"type":"string","description":"Company city"},"company_detailed_address":{"type":"string","description":"Company detailed address"},"company_district":{"type":"string","description":"Company district"},"company_full_address":{"type":"string","description":"Company full address"},"company_postcode":{"type":"string","description":"Company postcode"},"company_province":{"type":"string","description":"Company province"},"company_region":{"type":"string","description":"Company region"},"company_state":{"type":"string","description":"Company state"},"company_town":{"type":"string","description":"Company town"}}},"company_email":{"type":"string","description":"Company email (`invoice_type` = `company`)"},"company_name":{"type":"string","description":"Company name (`invoice_type` = `company`)"},"company_tax_id":{"type":"string","description":"Company tax ID (`invoice_type` = `company`)"}}},"invoice_type":{"type":"string","enum":["company","personal"],"description":"Invoice type: `company` for an organization, `personal` for an individual.\nDetermines which `invoice_detail` fields are used.\n","example":"personal"},"is_requested":{"type":"boolean","description":"Customer requests an e-invoice for this order. Set `true` together with `invoice_type` and `invoice_detail` to request invoice issuance.","example":true},"order_sn":{"type":"string","description":"Order code on the marketplace"}}}},"reports_by_phone":{"type":"object","description":"Reports by phone number","properties":{"order_fail":{"type":"integer","description":"Number of failed orders"},"order_success":{"type":"integer","description":"Number of successful orders"},"warning":{"type":"integer","description":"Number of warnings orders"}},"example":{"+639175706297":{"order_fail":29,"order_success":20,"warning":0}}},"tracking_link":{"type":"string","description":"Link confirm order"},"payment_link":{"type":"string","description":"Payment link"},"ads_source":{"type":"string","description":"Advertising source"},"bank_payments":{"type":"object","description":"Payment method"},"transfer_proofs":{"type":"array","description":"Bank transfer payment proofs, including verification time, amount and receipt images","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transfer proof ID"},"order_id":{"type":"integer","description":"Order ID"},"shop_id":{"type":"integer","description":"Shop ID"},"payment_id":{"type":"string","description":"Bank payment method ID (matches a key in `bank_payments`)"},"amount":{"type":"integer","description":"Transferred amount"},"images":{"type":"array","description":"Transfer receipt images","items":{"type":"string"}},"note":{"type":"string","nullable":true,"description":"Note"},"is_income":{"type":"boolean","description":"Money received (true) or paid out (false)"},"is_verify":{"type":"boolean","description":"Whether the transfer has been verified"},"verify_at":{"type":"string","format":"date-time","nullable":true,"description":"Verification time"},"verifier":{"type":"object","nullable":true,"description":"Verifier information","properties":{"id":{"type":"string","description":"Verifier ID"},"name":{"type":"string","description":"Verifier name"},"fb_id":{"type":"string","description":"Facebook ID of verifier"},"avatar_url":{"type":"string","description":"Verifier avatar URL"}}},"creator":{"type":"object","nullable":true,"description":"Creator information","properties":{"id":{"type":"string","description":"Creator ID"},"name":{"type":"string","description":"Creator name"},"fb_id":{"type":"string","description":"Facebook ID of creator"},"avatar_url":{"type":"string","description":"Creator avatar URL"}}},"last_editor":{"type":"object","nullable":true,"description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Editor name"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"avatar_url":{"type":"string","description":"Editor avatar URL"}}},"order_info":{"type":"object","nullable":true,"description":"Additional order information"},"inserted_at":{"type":"string","format":"date-time","description":"Transfer proof creation time"},"updated_at":{"type":"string","format":"date-time","description":"Transfer proof update time"}}}},"shopify_order_id":{"type":"string","description":"Shopify order ID"},"shopify_abandon_checkout_id":{"type":"integer","description":"Shopify abandon checkout ID"},"is_abandoned_order":{"type":"boolean","description":"Abandoned-cart flag for creating or updating an order. Send it directly in the request body, not inside `third_party` or `third_party_infomation`.\nAn 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.\nOnly boolean `true` or string `\"true\"` is normalized to `true`; all other submitted values become `false`.\n","example":true},"cod":{"type":"integer","description":"Cash on delivery"},"cash":{"type":"integer","description":"Cash payment"},"account":{"type":"integer","description":"Order source ID"},"account_name":{"type":"string","description":"Order source name"},"advanced_platform_fee":{"type":"object","description":"Fees from e-commerce platforms","properties":{"ads_top_up":{"type":"integer","description":"Ads wallet top-up"},"affiliate_commission":{"type":"integer","description":"Affiliate commission"},"diff_shipping_fee":{"type":"integer","description":"Difference shipping fee"},"marketplace_voucher":{"type":"integer","description":"Marketplace voucher"},"payment_fee":{"type":"integer","description":"Payment fee"},"platform_commission":{"type":"integer","description":"Platform commission"},"seller_transaction_fee":{"type":"integer","description":"Seller transaction fee"},"service_fee":{"type":"integer","description":"Service fee"},"sfp_service_fee":{"type":"integer","description":"SFP service fee"}}},"printing_count":{"type":"integer","description":"Printing count"},"money_to_collect":{"type":"integer","description":"Money to collect"},"marketplace_id":{"type":"string","description":"Marketplace ID","enum":["-2","-3","-4","-9","-16","-17","-20","-25","-27","-28"],"x-enum-descriptions":{"-2":"Tiki","-3":"Shopee","-4":"Lazada","-9":"TikTok","-16":"WooCommerce","-17":"Shopify","-20":"Line Shopping","-25":"Tokopedia","-27":"Mercado Libre","-28":"Tiendanube"}},"total_price":{"type":"integer","description":"Total price"},"shop_customer_address_id":{"type":"string","description":"Customer address ID"},"customer":{"type":"object","description":"Customer information","properties":{"fb_id":{"type":"string","description":"Customer Facebook ID"},"id":{"type":"string","description":"Customer ID"},"name":{"type":"string","description":"Customer name"},"page_id":{"type":"string","description":"Page ID"}}},"total_quantity":{"type":"integer","description":"Total quantity"},"time_assign_marketer":{"type":"string","format":"date-time","description":"Time assign marketer"},"p_utm_source":{"type":"string","description":"UTM Source"},"p_utm_medium":{"type":"string","description":"UTM Medium"},"p_utm_campaign":{"type":"string","description":"UTM Campaign"},"p_utm_term":{"type":"string","description":"UTM Term"},"p_utm_content":{"type":"string","description":"UTM Content"},"p_utm_id":{"type":"string","description":"UTM ID"},"utm_affiliate":{"type":"string","description":"Affiliate"},"link":{"type":"string","description":"Link"},"status_history":{"type":"array","description":"Status update history","items":{"type":"object","properties":{"avatar_url":{"type":"string","description":"Avatar URL"},"editor":{"type":"object","description":"Editor information"},"editor_fb":{"type":"string","description":"Editor Facebook ID"},"editor_id":{"type":"string","description":"Editor ID"},"name":{"type":"string","description":"Name"},"old_status":{"type":"integer","description":"Old status"},"status":{"type":"integer","description":"Status"},"updated_at":{"type":"string","format":"date-time","description":"Updated at"}}}},"duplicated_phone":{"type":"boolean","description":"Duplicated phone"},"order_currency":{"type":"string","description":"Order currency"},"charged_by_vnpay":{"type":"integer","description":"Charged by VNPay"},"charged_by_qrpay":{"type":"integer","description":"Charged by QRPay"},"custom_id":{"type":"string","description":"Custom ID"},"last_editor":{"type":"object","description":"Last editor information","properties":{"id":{"type":"string","description":"Editor ID"},"fb_id":{"type":"string","description":"Facebook ID of editor"},"name":{"type":"string","description":"Editor name"},"email":{"type":"string","description":"Editor email"},"avatar_url":{"type":"string","description":"Editor avatar URL"},"phone_number":{"type":"string","description":"Editor phone number"}}},"last_editor_id":{"type":"string","description":"Last editor ID"},"charged_by_momo":{"type":"integer","description":"Charged by MoMo"},"prepaid_by_point":{"type":"object","description":"Prepaid by point","properties":{"money":{"type":"integer","description":"Money amount","example":15000},"point":{"type":"integer","description":"Point amount","example":15}},"example":{"money":15000,"point":15}},"bank_transfer_images":{"type":"array","description":"Bank transfer images","items":{"type":"string","format":"uri"}},"transfer_money":{"type":"integer","description":"Transfer money"},"lock_order_by_user":{"type":"string","description":"Lock order by user ID"},"assigning_care":{"type":"object","description":"Assigning care information","properties":{"id":{"type":"string","description":"Care ID"},"fb_id":{"type":"string","description":"Facebook ID of care"},"name":{"type":"string","description":"Care name"},"email":{"type":"string","description":"Care email"},"avatar_url":{"type":"string","description":"Care avatar URL"},"phone_number":{"type":"string","description":"Care phone number"}}},"assigning_care_id":{"type":"string","description":"Assigning care ID"},"time_assign_care":{"type":"string","format":"date-time","description":"Time assign care"},"assigning_seller":{"type":"object","description":"Assigning seller information","properties":{"id":{"type":"string","description":"Seller ID"},"fb_id":{"type":"string","description":"Facebook ID of seller"},"name":{"type":"string","description":"Seller name"},"email":{"type":"string","description":"Seller email"},"avatar_url":{"type":"string","description":"Seller avatar URL"},"phone_number":{"type":"string","description":"Seller phone number"}}},"einvoices":{"type":"array","items":{"$ref":"#/components/schemas/EInvoice"}},"charged_by_card":{"type":"integer","description":"Charged by card"},"estimate_delivery_date":{"type":"string","format":"date-time","description":"Estimate delivery date"},"order_sources":{"type":"string","description":"Order sources ID"},"charged_by_fundiin":{"type":"integer","description":"Charged by Fundiin"},"surcharge":{"type":"integer","description":"Surcharge"},"is_linked_partner":{"type":"boolean","description":"Is linked partner"},"call_laters":{"type":"array","description":"Call laters","items":{"type":"object"}},"last_update_status_at":{"type":"string","format":"date-time","description":"Last update status at"},"discount_by_customer_level":{"type":"integer","description":"Discount by customer level"},"viewing":{"type":"array","description":"Viewing","items":{"type":"object"}},"additional_info":{"type":"object","description":"Additional info","properties":{"service_partner":{"type":"string","description":"Service partner","enum":["instant"],"x-enum-descriptions":["Instant"]},"delivery_deadline":{"type":"string","format":"date-time","description":"Delivery deadline (ISO8601, no timezone).","example":"2026-06-03T10:00:00"},"ship_by_date":{"type":"integer","nullable":true,"readOnly":true,"description":"Marketplace ship-by deadline (Unix timestamp, seconds) for Shopee/TikTok orders — the order must be handed over to the carrier before this time, otherwise the marketplace may cancel it automatically. Shopee `ship_by_date`, TikTok `collection_due_time`. `0` = the marketplace has not returned it yet; `null` for non-marketplace orders.","example":1793000000}}},"order_returned_ids":{"type":"string","description":"Order returned IDs"},"cost_surcharge":{"type":"integer","description":"Cost surcharge"},"time_send_partner":{"type":"string","format":"date-time","description":"Time send partner"},"charged_by_kredivo":{"type":"integer","description":"Charged by Kredivo"},"discount":{"type":"integer","description":"Discount"},"histories":{"type":"array","description":"Histories","items":{"type":"object"}},"duplicated_customer":{"type":"boolean","description":"Duplicated customer"},"customer_referral_code":{"type":"object","description":"Customer referral code","properties":{"active":{"type":"string","description":"Active status","example":"true"},"customer_id":{"type":"string","format":"uuid","description":"Customer ID","example":"09bb9399-45f3-4897-a53a-85dde2f886fe"},"discount":{"type":"string","description":"Discount value","example":"10"},"format":{"type":"string","description":"Referral code format","example":"{PHONE_NUMBER}"},"free_products_priced_between_approx":{"type":"object","description":"Free products priced between approximately","properties":{"active":{"type":"string","description":"Active status","example":"true"},"operator":{"type":"string","description":"Comparison operator","example":"GreaterOrEqual"},"price":{"type":"string","description":"Price threshold","example":"150000"}}},"is_percent":{"type":"string","description":"Discount is percentage","example":"true"},"only_customers_with_level_will_have_referral_code":{"type":"string","description":"Only customers with level will have referral code","example":"true"},"referral_code":{"type":"string","description":"Referral code","example":"982843759"},"reward_points_for_old_customers":{"type":"object","description":"Reward points for customers","properties":{"active":{"type":"string","description":"Active status","example":"true"},"money":{"type":"string","description":"Money reward","example":"10000"},"point":{"type":"string","description":"Point reward","example":"1"}}},"shop_customer_id":{"type":"string","format":"uuid","description":"Shop customer ID","example":"f8160a4c-dfa7-4ee8-b540-d245755ea1f1"}},"example":{"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"}},"tax":{"type":"integer","description":"Tax"},"is_from_ecommerce":{"type":"boolean","description":"Is from e-commerce"},"note_image":{"type":"array","description":"Note images","items":{"type":"string","format":"uri"}},"shopify_draft_order_id":{"type":"string","description":"Shopify draft order ID"},"display_id":{"type":"integer","description":"Display ID"},"shop_partner_id":{"type":"integer","description":"Shop partner ID"},"is_locked":{"type":"boolean","description":"Order lock"},"merge_order":{"type":"boolean","description":"Allows merging orders"}}}]},"WebhookCustomerResponse":{"type":"object","description":"Webhook response when webhook_types includes customers","allOf":[{"$ref":"#/components/schemas/Customer"}]},"WebhookProductResponse":{"type":"object","description":"Webhook response when webhook_types includes products","properties":{"data":{"type":"object","properties":{"record":{"$ref":"#/components/schemas/Product"},"success":{"type":"boolean"}}}}},"WebhookInventoryResponse":{"type":"object","description":"Webhook response when webhook_types includes variations_warehouses","properties":{"data":{"type":"object","properties":{"record":{"type":"object","properties":{"variation_id":{"type":"string","description":"Variation ID"},"warehouse_id":{"type":"string","description":"Warehouse ID"},"remain_quantity":{"type":"integer","description":"Remain quantity"},"actual_remain_quantity":{"type":"integer","description":"Actual remain quantity"},"change_quantity":{"type":"integer","description":"Change quantity"},"is_actual_remain_quantity":{"type":"boolean","description":"Is actual remain quantity"},"inserted_at":{"type":"string","format":"date-time","description":"Inserted at"},"type":{"type":"string","description":"Type"}}},"success":{"type":"boolean"}}}}},"WebhookAutoCallResponse":{"type":"object","description":"Auto Voice result sent once to the configured webhook URL. Return HTTP 200 to acknowledge receipt.","properties":{"type":{"type":"string","example":"auto_call"},"shop_id":{"type":"integer","example":4},"order_id":{"type":"string","description":"Order ID or code used to trigger the call","example":"1418"},"phone_number":{"type":"string","example":"0973667874"},"answered":{"type":"boolean","description":"Whether the callee picked up","example":true},"dtmf":{"type":"string","nullable":true,"description":"Digits the callee pressed (null if none)","example":"1"}},"example":{"type":"auto_call","shop_id":4,"order_id":"1418","phone_number":"0973667874","answered":true,"dtmf":"1"}},"AdAccount":{"type":"object","description":"Ad accounts list response","properties":{"success":{"type":"boolean","description":"Success status"},"data":{"type":"array","description":"List of ad accounts","items":{"type":"object","properties":{"id":{"type":"string","description":"Ad account ID"},"name":{"type":"string","description":"Ad account name"},"account_status":{"type":"integer","description":"Account status","enum":[1,2,3,7,8,9,100,101,201,202],"x-enum-descriptions":["Active","Disabled","Unsettled","Awaiting risk review","Awaiting settlement","Within grace period","Awaiting closure","Closed","Any active status","Any closed status"]},"currency":{"type":"string","description":"Currency used by the account"},"is_business":{"type":"boolean","description":"Business account (true) / Personal account (false)"},"sync_succeed_at":{"type":"string","format":"date-time","description":"Last successful sync timestamp"},"tags":{"type":"array","description":"Tags","items":{"type":"string"}}}}},"page_number":{"type":"integer","description":"Current page number"},"page_size":{"type":"integer","description":"Number of records per page"},"total_entries":{"type":"integer","description":"Total number of ad accounts"},"total_pages":{"type":"integer","description":"Total number of pages"}}},"CampaignListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"},"data":{"type":"array","description":"List of campaigns","items":{"type":"object","properties":{"id":{"type":"string","description":"Campaign ID"},"name":{"type":"string","description":"Campaign name"},"status":{"type":"string","description":"Campaign status","enum":["ACTIVE","PAUSED","DELETED","ARCHIVED"],"x-enum-descriptions":["Active","Paused","Deleted","Archived"]},"effective_status":{"type":"string","description":"Effective status","enum":["ACTIVE","PAUSED","DELETED","ARCHIVED","IN_PROCESS","WITH_ISSUES"],"x-enum-descriptions":["Active","Paused","Deleted","Archived","In process","With issues"]},"objective":{"type":"string","description":"Campaign objective","enum":["APP_INSTALLS","BRAND_AWARENESS","CONVERSIONS","EVENT_RESPONSES","LEAD_GENERATION","LINK_CLICKS","LOCAL_AWARENESS","MESSAGES","OFFER_CLAIMS","OUTCOME_APP_PROMOTION","OUTCOME_AWARENESS","OUTCOME_ENGAGEMENT","OUTCOME_LEADS","OUTCOME_SALES","OUTCOME_TRAFFIC","PAGE_LIKES","POST_ENGAGEMENT","PRODUCT_CATALOG_SALES","REACH","STORE_VISITS","VIDEO_VIEWS"],"x-enum-descriptions":["App installs","Brand awareness","Conversions","Event responses","Lead generation","Link clicks","Local awareness","Messages","Offer claims","App promotion","Awareness","Engagement","Leads","Sales","Traffic","Page likes","Post engagement","Product catalog sales","Reach","Store visits","Video views"]},"created_time":{"type":"string","format":"date-time","description":"Campaign creation time"},"start_time":{"type":"string","format":"date-time","description":"Campaign start time"},"end_time":{"type":"string","format":"date-time","nullable":true,"description":"Campaign end time"},"marketer_id":{"type":"string","nullable":true,"description":"Marketer ID assigned"},"product_id":{"type":"string","nullable":true,"description":"Product ID"},"product_category_id":{"type":"string","nullable":true,"description":"Product category ID"},"product":{"nullable":true,"description":"Product of campaign","allOf":[{"$ref":"#/components/schemas/Product"}]},"ad_account":{"type":"object","description":"Ad account","properties":{"id":{"type":"string","description":"Ad account ID"},"name":{"type":"string","description":"Ad account name"},"currency":{"type":"string","description":"Currency used by the account"}}},"insights":{"type":"object","description":"Campaign performance metrics","properties":{"ad_ids":{"type":"array","description":"List of ad IDs in this campaign","items":{"type":"string"}},"impressions":{"type":"number","description":"Number of ad impressions"},"clicks":{"type":"integer","description":"Number of clicks (all)"},"reach":{"type":"integer","description":"Number of people reached via Instant Experience"},"spend":{"type":"number","description":"Total amount spent"},"cpc":{"type":"number","description":"CPC"},"cpm":{"type":"number","description":"CPM"},"cpp":{"type":"number","description":"CPP"},"ctr":{"type":"number","description":"CTR"},"frequency":{"type":"number","description":"Average frequency of ad views per person"},"ad_performance_session":{"type":"integer","description":"Overall performance metric"},"cost_per_1000_accounts_center_reach":{"type":"number","description":"Cost per 1000 accounts center reach"},"cost_per_result":{"type":"number","description":"Cost per result"},"avg_purchase_conversion_value":{"type":"number","description":"Average purchase conversion value"},"indicator_result":{"type":"number","description":"Result indicator value"},"result_roas":{"type":"number","description":"Return on ad spend (ROAS)"},"ad_engagement_session":{"type":"integer","description":"Overall engagement metric"},"link_click":{"type":"integer","description":"Link clicks"},"like":{"type":"integer","description":"Facebook likes"},"comment":{"type":"integer","description":"Post comments"},"post_engagement":{"type":"integer","description":"Post engagements"},"post_reaction":{"type":"integer","description":"Post reactions"},"post":{"type":"integer","description":"Post shares"},"onsite_conversion_post_save":{"type":"integer","description":"Post saves"},"photo_view":{"type":"integer","description":"Photo views"},"video_view":{"type":"integer","description":"Video plays (at least 3 seconds)"},"inline_link_click_ctr":{"type":"number","description":"CTR (link click-through rate, %)"},"outbound_click":{"type":"integer","description":"Outbound clicks"},"onsite_conversion_messaging_conversation_started_7d":{"type":"integer","description":"Messaging conversations started (7-day window)"},"onsite_conversion_messaging_first_reply":{"type":"integer","description":"New messaging contacts"},"onsite_conversion_messaging_block":{"type":"integer","description":"Messaging blocks"},"video_thruplay_watched_actions":{"type":"integer","description":"ThruPlays"},"video_play_actions":{"type":"integer","description":"Video plays"},"video_p25_watched_actions":{"type":"integer","description":"Video plays at 25% completion"},"video_p50_watched_actions":{"type":"integer","description":"Video plays at 50% completion"},"video_p75_watched_actions":{"type":"integer","description":"Video plays at 75% completion"},"video_p95_watched_actions":{"type":"integer","description":"Video plays at 95% completion"},"video_p100_watched_actions":{"type":"integer","description":"Video plays at 100% completion"},"estimated_ad_recallers":{"type":"number","description":"Estimated ad recall lift (people)"},"cost_per_outbound_click":{"type":"number","description":"Cost per outbound click"},"cost_per_thruplay":{"type":"number","description":"Cost per ThruPlay"},"outbound_clicks_ctr":{"type":"number","description":"Outbound click-through rate (%)"},"cost_per_post_engagement":{"type":"number","description":"Cost per post engagement"},"estimated_ad_recall_rate":{"type":"number","description":"Estimated ad recall lift rate (%)"},"cost_per_estimated_ad_recallers":{"type":"number","description":"Cost per estimated ad recall lift (people)"},"cost_per_messaging_conversation_started":{"type":"number","description":"Cost per messaging conversation started"},"lead":{"type":"number","description":"Leads"},"website_lead":{"type":"number","description":"Website leads"},"offline_lead":{"type":"number","description":"Offline leads"},"meta_lead":{"type":"number","description":"Meta leads"},"lead_conversion_value":{"type":"number","description":"Lead conversion value"},"website_lead_conversion_value":{"type":"number","description":"Website lead conversion value"},"offline_lead_conversion_value":{"type":"number","description":"Offline lead conversion value"},"meta_lead_conversion_value":{"type":"number","description":"Meta lead conversion value"},"cost_per_lead":{"type":"number","description":"Cost per lead"},"omni_purchase":{"type":"number","description":"Purchases"},"inapp_omni_purchase":{"type":"number","description":"In-app purchases"},"website_omni_purchase":{"type":"number","description":"Website purchases"},"offline_omni_purchase":{"type":"number","description":"Offline purchases"},"meta_omni_purchase":{"type":"number","description":"Meta purchases"},"omni_purchase_conversion_value":{"type":"number","description":"Purchase conversion value"},"inapp_omni_purchase_conversion_value":{"type":"number","description":"In-app purchase conversion value"},"website_omni_purchase_conversion_value":{"type":"number","description":"Website purchase conversion value"},"offline_omni_purchase_conversion_value":{"type":"number","description":"Offline purchase conversion value"},"meta_omni_purchase_conversion_value":{"type":"number","description":"Meta purchase conversion value"},"cost_per_omni_purchase":{"type":"number","description":"Cost per purchase"},"omni_initiated_checkout":{"type":"number","description":"Checkout initiated"},"inapp_omni_initiated_checkout":{"type":"number","description":"In-app checkout initiated"},"website_omni_initiated_checkout":{"type":"number","description":"Website checkout initiated"},"offline_omni_initiated_checkout":{"type":"number","description":"Offline checkout initiated"},"meta_omni_initiated_checkout":{"type":"number","description":"Meta checkout initiated"},"omni_initiated_checkout_conversion_value":{"type":"number","description":"Checkout initiated conversion value"},"inapp_omni_initiated_checkout_conversion_value":{"type":"number","description":"In-app checkout initiated conversion value"},"website_omni_initiated_checkout_conversion_value":{"type":"number","description":"Website checkout initiated conversion value"},"offline_omni_initiated_checkout_conversion_value":{"type":"number","description":"Offline checkout initiated conversion value"},"meta_omni_initiated_checkout_conversion_value":{"type":"number","description":"Meta checkout initiated conversion value"},"cost_per_omni_initiated_checkout":{"type":"number","description":"Cost per checkout initiated"},"omni_complete_registration":{"type":"number","description":"Registrations completed"},"inapp_omni_complete_registration":{"type":"number","description":"In-app registrations completed"},"website_omni_complete_registration":{"type":"number","description":"Website registrations completed"},"offline_omni_complete_registration":{"type":"number","description":"Offline registrations completed"},"omni_complete_registration_conversion_value":{"type":"number","description":"Registration completed conversion value"},"inapp_omni_complete_registration_conversion_value":{"type":"number","description":"In-app registration completed conversion value"},"website_omni_complete_registration_conversion_value":{"type":"number","description":"Website registration completed conversion value"},"offline_omni_complete_registration_conversion_value":{"type":"number","description":"Offline registration completed conversion value"},"cost_per_omni_complete_registration":{"type":"number","description":"Cost per registration completed"},"omni_view_content":{"type":"number","description":"Content views"},"inapp_omni_view_content":{"type":"number","description":"In-app content views"},"website_omni_view_content":{"type":"number","description":"Website content views"},"offline_omni_view_content":{"type":"number","description":"Offline content views"},"meta_omni_view_content":{"type":"number","description":"Meta content views"},"omni_view_content_conversion_value":{"type":"number","description":"Content view conversion value"},"inapp_omni_view_content_conversion_value":{"type":"number","description":"In-app content view conversion value"},"website_omni_view_content_conversion_value":{"type":"number","description":"Website content view conversion value"},"offline_omni_view_content_conversion_value":{"type":"number","description":"Offline content view conversion value"},"meta_omni_view_content_conversion_value":{"type":"number","description":"Meta content view conversion value"},"cost_per_omni_view_content":{"type":"number","description":"Cost per content view"},"omni_search":{"type":"number","description":"Searches"},"inapp_omni_search":{"type":"number","description":"In-app searches"},"website_omni_search":{"type":"number","description":"Website searches"},"offline_omni_search":{"type":"number","description":"Offline searches"},"omni_search_conversion_value":{"type":"number","description":"Search conversion value"},"inapp_omni_search_conversion_value":{"type":"number","description":"In-app search conversion value"},"website_omni_search_conversion_value":{"type":"number","description":"Website search conversion value"},"offline_omni_search_conversion_value":{"type":"number","description":"Offline search conversion value"},"cost_per_omni_search":{"type":"number","description":"Cost per search"},"omni_add_to_cart":{"type":"number","description":"Add to cart"},"inapp_omni_add_to_cart":{"type":"number","description":"In-app add to cart"},"website_omni_add_to_cart":{"type":"number","description":"Website add to cart"},"offline_omni_add_to_cart":{"type":"number","description":"Offline add to cart"},"meta_omni_add_to_cart":{"type":"number","description":"Meta add to cart"},"omni_add_to_cart_conversion_value":{"type":"number","description":"Add to cart conversion value"},"inapp_omni_add_to_cart_conversion_value":{"type":"number","description":"In-app add to cart conversion value"},"website_omni_add_to_cart_conversion_value":{"type":"number","description":"Website add to cart conversion value"},"offline_omni_add_to_cart_conversion_value":{"type":"number","description":"Offline add to cart conversion value"},"meta_omni_add_to_cart_conversion_value":{"type":"number","description":"Meta add to cart conversion value"},"cost_per_omni_add_to_cart":{"type":"number","description":"Cost per add to cart"},"omni_add_to_wishlist":{"type":"number","description":"Add to wishlist"},"inapp_omni_add_to_wishlist":{"type":"number","description":"In-app add to wishlist"},"website_omni_add_to_wishlist":{"type":"number","description":"Website add to wishlist"},"offline_omni_add_to_wishlist":{"type":"number","description":"Offline add to wishlist"},"meta_omni_add_to_wishlist":{"type":"number","description":"Meta add to wishlist"},"omni_add_to_wishlist_conversion_value":{"type":"number","description":"Add to wishlist conversion value"},"inapp_omni_add_to_wishlist_conversion_value":{"type":"number","description":"In-app add to wishlist conversion value"},"website_omni_add_to_wishlist_conversion_value":{"type":"number","description":"Website add to wishlist conversion value"},"offline_omni_add_to_wishlist_conversion_value":{"type":"number","description":"Offline add to wishlist conversion value"},"meta_omni_add_to_wishlist_conversion_value":{"type":"number","description":"Meta add to wishlist conversion value"},"cost_per_omni_add_to_wishlist":{"type":"number","description":"Cost per add to wishlist"},"customize_product_total":{"type":"number","description":"Product customizations"},"inapp_customize_product_total":{"type":"number","description":"In-app product customizations"},"website_customize_product_total":{"type":"number","description":"Website product customizations"},"offline_customize_product_total":{"type":"number","description":"Offline product customizations"},"customize_product_total_conversion_value":{"type":"number","description":"Product customization conversion value"},"inapp_customize_product_total_conversion_value":{"type":"number","description":"In-app product customization conversion value"},"website_customize_product_total_conversion_value":{"type":"number","description":"Website product customization conversion value"},"offline_customize_product_total_conversion_value":{"type":"number","description":"Offline product customization conversion value"},"cost_per_customize_product_total":{"type":"number","description":"Cost per product customization"},"start_trial_total":{"type":"number","description":"Trials started"},"inapp_start_trial_total":{"type":"number","description":"In-app trials started"},"website_start_trial_total":{"type":"number","description":"Website trials started"},"offline_start_trial_total":{"type":"number","description":"Offline trials started"},"start_trial_total_conversion_value":{"type":"number","description":"Trial started conversion value"},"inapp_start_trial_total_conversion_value":{"type":"number","description":"In-app trial started conversion value"},"website_start_trial_total_conversion_value":{"type":"number","description":"Website trial started conversion value"},"offline_start_trial_total_conversion_value":{"type":"number","description":"Offline trial started conversion value"},"cost_per_start_trial_total":{"type":"number","description":"Cost per trial started"},"subscribe_total":{"type":"number","description":"Subscriptions"},"inapp_subscribe_total":{"type":"number","description":"In-app subscriptions"},"website_subscribe_total":{"type":"number","description":"Website subscriptions"},"offline_subscribe_total":{"type":"number","description":"Offline subscriptions"},"subscribe_total_conversion_value":{"type":"number","description":"Subscription conversion value"},"inapp_subscribe_total_conversion_value":{"type":"number","description":"In-app subscription conversion value"},"website_subscribe_total_conversion_value":{"type":"number","description":"Website subscription conversion value"},"offline_subscribe_total_conversion_value":{"type":"number","description":"Offline subscription conversion value"},"cost_per_subscribe_total":{"type":"number","description":"Cost per subscription"},"submit_application_total":{"type":"number","description":"Applications submitted"},"inapp_submit_application_total":{"type":"number","description":"In-app applications submitted"},"website_submit_application_total":{"type":"number","description":"Website applications submitted"},"offline_submit_application_total":{"type":"number","description":"Offline applications submitted"},"meta_submit_application_total":{"type":"number","description":"Meta applications submitted"},"submit_application_total_conversion_value":{"type":"number","description":"Application submitted conversion value"},"inapp_submit_application_total_conversion_value":{"type":"number","description":"In-app application submitted conversion value"},"website_submit_application_total_conversion_value":{"type":"number","description":"Website application submitted conversion value"},"offline_submit_application_total_conversion_value":{"type":"number","description":"Offline application submitted conversion value"},"meta_submit_application_total_conversion_value":{"type":"number","description":"Meta application submitted conversion value"},"cost_per_submit_application_total":{"type":"number","description":"Cost per application submitted"},"contact_total":{"type":"number","description":"Contacts"},"inapp_contact_total":{"type":"number","description":"In-app contacts"},"website_contact_total":{"type":"number","description":"Website contacts"},"offline_contact_total":{"type":"number","description":"Offline contacts"},"contact_total_conversion_value":{"type":"number","description":"Contact conversion value"},"inapp_contact_total_conversion_value":{"type":"number","description":"In-app contact conversion value"},"website_contact_total_conversion_value":{"type":"number","description":"Website contact conversion value"},"offline_contact_total_conversion_value":{"type":"number","description":"Offline contact conversion value"},"cost_per_contact_total":{"type":"number","description":"Cost per contact"},"landing_page_view":{"type":"number","description":"Landing page views"},"inapp_landing_page_view":{"type":"number","description":"In-app landing page views"},"website_landing_page_view":{"type":"number","description":"Website landing page views"},"cost_per_landing_page_view":{"type":"number","description":"Cost per landing page view"},"order_created":{"type":"number","description":"Orders created"},"order_shipped":{"type":"number","description":"Orders shipped"},"purchase_roas":{"type":"number","description":"Purchase ROAS"},"inapp_purchase_roas":{"type":"number","description":"In-app purchase ROAS"},"website_purchase_roas":{"type":"number","description":"Website purchase ROAS"},"order_statistics":{"type":"array","description":"Order count grouped by day offset from campaign start","items":{"type":"object","properties":{"id":{"type":"integer","description":"Day offset"},"order_count":{"type":"integer","description":"Number of orders on that day"}}}}}}}}},"summary":{"type":"object","description":"Aggregated performance metrics across all campaigns","properties":{"impressions":{"type":"number","description":"Total impressions"},"clicks":{"type":"integer","description":"Total clicks"},"reach":{"type":"integer","description":"Total unique people reached"},"spend":{"type":"number","description":"Total amount spent"},"cpc":{"type":"number","description":"CPC"},"cpm":{"type":"number","description":"CPM"},"cpp":{"type":"number","description":"CPP"},"ctr":{"type":"number","description":"CTR"},"frequency":{"type":"number","description":"Average frequency"}}},"page_number":{"type":"integer","description":"Current page number"},"page_size":{"type":"integer","description":"Number of records per page"},"total_entries":{"type":"integer","description":"Total number of campaigns"},"total_pages":{"type":"integer","description":"Total number of pages"}}},"AdSetListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"},"data":{"type":"array","description":"List of ad sets","items":{"type":"object","properties":{"id":{"type":"string","description":"Ad set ID"},"name":{"type":"string","description":"Ad set name"},"status":{"type":"string","description":"Ad set status","enum":["ACTIVE","PAUSED","DELETED","ARCHIVED"],"x-enum-descriptions":["Active","Paused","Deleted","Archived"]},"effective_status":{"type":"string","description":"Effective status","enum":["ACTIVE","PAUSED","DELETED","PENDING_REVIEW","DISAPPROVED","PREAPPROVED","PENDING_BILLING_INFO","CAMPAIGN_PAUSED","ARCHIVED","ADSET_PAUSED","IN_PROCESS","WITH_ISSUES"],"x-enum-descriptions":["Active","Paused","Deleted","Pending review","Disapproved","Preapproved","Pending billing info","Campaign paused","Archived","Ad set paused","In process","With issues"]},"created_time":{"type":"string","format":"date-time","description":"Ad set creation time"},"start_time":{"type":"string","format":"date-time","description":"Ad set start time"},"end_time":{"type":"string","format":"date-time","nullable":true,"description":"Ad set end time"},"bid_amount":{"type":"integer","description":"Bid amount"},"bid_strategy":{"type":"string","nullable":true,"description":"Bid strategy","enum":["LOWEST_COST_WITHOUT_CAP","LOWEST_COST_WITH_BID_CAP","COST_CAP","LOWEST_COST_WITH_MIN_ROAS"],"x-enum-descriptions":["Lowest cost without cap","Lowest cost with bid cap","Cost cap","Lowest cost with minimum ROAS"]},"billing_event":{"type":"string","description":"Billing event","enum":["APP_INSTALLS","IMPRESSIONS","LINK_CLICKS","OFFER_CLAIMS","PAGE_LIKES","POST_ENGAGEMENT","VIDEO_VIEWS","THRUPLAY","PURCHASE","LISTING_INTERACTION"],"x-enum-descriptions":["App installs","Impressions","Link clicks","Offer claims","Page likes","Post engagement","Video views","ThruPlay","Purchase","Listing interaction"]},"daily_budget":{"type":"integer","description":"Daily budget"},"lifetime_budget":{"type":"integer","description":"Lifetime budget"},"destination_type":{"type":"string","description":"Destination type","enum":["WEBSITE","APP","MESSENGER","APPLINKS_AUTOMATIC","WHATSAPP","INSTAGRAM_DIRECT","FACEBOOK","MESSAGING_MESSENGER_WHATSAPP","MESSAGING_INSTAGRAM_DIRECT_MESSENGER","MESSAGING_INSTAGRAM_DIRECT_MESSENGER_WHATSAPP","MESSAGING_INSTAGRAM_DIRECT_WHATSAPP","SHOP_AUTOMATIC","ON_AD","ON_POST","ON_EVENT","ON_VIDEO","ON_PAGE","INSTAGRAM_PROFILE","FACEBOOK_PAGE","INSTAGRAM_PROFILE_AND_FACEBOOK_PAGE","INSTAGRAM_LIVE"],"x-enum-descriptions":["Website","App","Messenger","App links automatic","WhatsApp","Instagram Direct","Facebook","Messenger & WhatsApp","Instagram & Messenger","Instagram Direct & Messenger & WhatsApp","Instagram Direct & WhatsApp","Shop automatic","On ad","On post","On event","On video","On page","Instagram profile","Facebook page","Instagram profile and Facebook page","Instagram Live"]},"optimization_goal":{"type":"string","description":"Optimization goal","enum":["NONE","APP_INSTALLS","AD_RECALL_LIFT","ENGAGED_USERS","EVENT_RESPONSES","IMPRESSIONS","LEAD_GENERATION","QUALITY_LEAD","LINK_CLICKS","OFFSITE_CONVERSIONS","PAGE_LIKES","POST_ENGAGEMENT","QUALITY_CALL","REACH","LANDING_PAGE_VIEWS","VISIT_INSTAGRAM_PROFILE","VALUE","THRUPLAY","DERIVED_EVENTS","APP_INSTALLS_AND_OFFSITE_CONVERSIONS","CONVERSATIONS","IN_APP_VALUE","MESSAGING_PURCHASE_CONVERSION","SUBSCRIBERS","REMINDERS_SET","MEANINGFUL_CALL_ATTEMPT","PROFILE_VISIT","PROFILE_AND_PAGE_ENGAGEMENT","ADVERTISER_SILOED_VALUE","AUTOMATIC_OBJECTIVE","MESSAGING_APPOINTMENT_CONVERSION"],"x-enum-descriptions":["None","App installs","Ad recall lift","Engaged users","Event responses","Impressions","Lead generation","Quality lead","Link clicks","Offsite conversions","Page likes","Post engagement","Quality call","Reach","Landing page views","Visit Instagram profile","Value","ThruPlay","Derived events","App installs and offsite conversions","Conversations","In-app value","Messaging purchase conversion","Subscribers","Reminders set","Meaningful call attempt","Profile visit","Profile and page engagement","Advertiser siloed value","Automatic objective","Messaging appointment conversion"]},"marketer_id":{"type":"string","nullable":true,"description":"Marketer ID assigned"},"product_id":{"type":"string","nullable":true,"description":"ID of product"},"product_category_id":{"type":"string","nullable":true,"description":"ID of product category"},"ad_account":{"type":"object","description":"Ad account","properties":{"id":{"type":"string","description":"Ad account ID"},"name":{"type":"string","description":"Ad account name"},"currency":{"type":"string","description":"Currency used by the account"}}},"ad_campaign":{"type":"object","description":"Campaign of ad set","properties":{"id":{"type":"string","description":"Campaign ID"},"name":{"type":"string","description":"Campaign name"}}},"insights":{"type":"object","description":"Ad set performance metrics","properties":{"ad_ids":{"type":"array","description":"List of ad IDs in this campaign","items":{"type":"string"}},"impressions":{"type":"number","description":"Number of ad impressions"},"clicks":{"type":"integer","description":"Number of clicks (all)"},"reach":{"type":"integer","description":"Number of people reached via Instant Experience"},"spend":{"type":"number","description":"Total amount spent"},"cpc":{"type":"number","description":"CPC"},"cpm":{"type":"number","description":"CPM"},"cpp":{"type":"number","description":"CPP"},"ctr":{"type":"number","description":"CTR"},"frequency":{"type":"number","description":"Average frequency of ad views per person"},"ad_performance_session":{"type":"integer","description":"Overall performance metric"},"cost_per_1000_accounts_center_reach":{"type":"number","description":"Cost per 1000 accounts center reach"},"cost_per_result":{"type":"number","description":"Cost per result"},"avg_purchase_conversion_value":{"type":"number","description":"Average purchase conversion value"},"indicator_result":{"type":"number","description":"Result indicator value"},"result_roas":{"type":"number","description":"Return on ad spend (ROAS)"},"ad_engagement_session":{"type":"integer","description":"Overall engagement metric"},"link_click":{"type":"integer","description":"Link clicks"},"like":{"type":"integer","description":"Facebook likes"},"comment":{"type":"integer","description":"Post comments"},"post_engagement":{"type":"integer","description":"Post engagements"},"post_reaction":{"type":"integer","description":"Post reactions"},"post":{"type":"integer","description":"Post shares"},"onsite_conversion_post_save":{"type":"integer","description":"Post saves"},"photo_view":{"type":"integer","description":"Photo views"},"video_view":{"type":"integer","description":"Video plays (at least 3 seconds)"},"inline_link_click_ctr":{"type":"number","description":"CTR (link click-through rate, %)"},"outbound_click":{"type":"integer","description":"Outbound clicks"},"onsite_conversion_messaging_conversation_started_7d":{"type":"integer","description":"Messaging conversations started (7-day window)"},"onsite_conversion_messaging_first_reply":{"type":"integer","description":"New messaging contacts"},"onsite_conversion_messaging_block":{"type":"integer","description":"Messaging blocks"},"video_thruplay_watched_actions":{"type":"integer","description":"ThruPlays"},"video_play_actions":{"type":"integer","description":"Video plays"},"video_p25_watched_actions":{"type":"integer","description":"Video plays at 25% completion"},"video_p50_watched_actions":{"type":"integer","description":"Video plays at 50% completion"},"video_p75_watched_actions":{"type":"integer","description":"Video plays at 75% completion"},"video_p95_watched_actions":{"type":"integer","description":"Video plays at 95% completion"},"video_p100_watched_actions":{"type":"integer","description":"Video plays at 100% completion"},"estimated_ad_recallers":{"type":"number","description":"Estimated ad recall lift (people)"},"cost_per_outbound_click":{"type":"number","description":"Cost per outbound click"},"cost_per_thruplay":{"type":"number","description":"Cost per ThruPlay"},"outbound_clicks_ctr":{"type":"number","description":"Outbound click-through rate (%)"},"cost_per_post_engagement":{"type":"number","description":"Cost per post engagement"},"estimated_ad_recall_rate":{"type":"number","description":"Estimated ad recall lift rate (%)"},"cost_per_estimated_ad_recallers":{"type":"number","description":"Cost per estimated ad recall lift (people)"},"cost_per_messaging_conversation_started":{"type":"number","description":"Cost per messaging conversation started"},"lead":{"type":"number","description":"Leads"},"website_lead":{"type":"number","description":"Website leads"},"offline_lead":{"type":"number","description":"Offline leads"},"meta_lead":{"type":"number","description":"Meta leads"},"lead_conversion_value":{"type":"number","description":"Lead conversion value"},"website_lead_conversion_value":{"type":"number","description":"Website lead conversion value"},"offline_lead_conversion_value":{"type":"number","description":"Offline lead conversion value"},"meta_lead_conversion_value":{"type":"number","description":"Meta lead conversion value"},"cost_per_lead":{"type":"number","description":"Cost per lead"},"omni_purchase":{"type":"number","description":"Purchases"},"inapp_omni_purchase":{"type":"number","description":"In-app purchases"},"website_omni_purchase":{"type":"number","description":"Website purchases"},"offline_omni_purchase":{"type":"number","description":"Offline purchases"},"meta_omni_purchase":{"type":"number","description":"Meta purchases"},"omni_purchase_conversion_value":{"type":"number","description":"Purchase conversion value"},"inapp_omni_purchase_conversion_value":{"type":"number","description":"In-app purchase conversion value"},"website_omni_purchase_conversion_value":{"type":"number","description":"Website purchase conversion value"},"offline_omni_purchase_conversion_value":{"type":"number","description":"Offline purchase conversion value"},"meta_omni_purchase_conversion_value":{"type":"number","description":"Meta purchase conversion value"},"cost_per_omni_purchase":{"type":"number","description":"Cost per purchase"},"omni_initiated_checkout":{"type":"number","description":"Checkout initiated"},"inapp_omni_initiated_checkout":{"type":"number","description":"In-app checkout initiated"},"website_omni_initiated_checkout":{"type":"number","description":"Website checkout initiated"},"offline_omni_initiated_checkout":{"type":"number","description":"Offline checkout initiated"},"meta_omni_initiated_checkout":{"type":"number","description":"Meta checkout initiated"},"omni_initiated_checkout_conversion_value":{"type":"number","description":"Checkout initiated conversion value"},"inapp_omni_initiated_checkout_conversion_value":{"type":"number","description":"In-app checkout initiated conversion value"},"website_omni_initiated_checkout_conversion_value":{"type":"number","description":"Website checkout initiated conversion value"},"offline_omni_initiated_checkout_conversion_value":{"type":"number","description":"Offline checkout initiated conversion value"},"meta_omni_initiated_checkout_conversion_value":{"type":"number","description":"Meta checkout initiated conversion value"},"cost_per_omni_initiated_checkout":{"type":"number","description":"Cost per checkout initiated"},"omni_complete_registration":{"type":"number","description":"Registrations completed"},"inapp_omni_complete_registration":{"type":"number","description":"In-app registrations completed"},"website_omni_complete_registration":{"type":"number","description":"Website registrations completed"},"offline_omni_complete_registration":{"type":"number","description":"Offline registrations completed"},"omni_complete_registration_conversion_value":{"type":"number","description":"Registration completed conversion value"},"inapp_omni_complete_registration_conversion_value":{"type":"number","description":"In-app registration completed conversion value"},"website_omni_complete_registration_conversion_value":{"type":"number","description":"Website registration completed conversion value"},"offline_omni_complete_registration_conversion_value":{"type":"number","description":"Offline registration completed conversion value"},"cost_per_omni_complete_registration":{"type":"number","description":"Cost per registration completed"},"omni_view_content":{"type":"number","description":"Content views"},"inapp_omni_view_content":{"type":"number","description":"In-app content views"},"website_omni_view_content":{"type":"number","description":"Website content views"},"offline_omni_view_content":{"type":"number","description":"Offline content views"},"meta_omni_view_content":{"type":"number","description":"Meta content views"},"omni_view_content_conversion_value":{"type":"number","description":"Content view conversion value"},"inapp_omni_view_content_conversion_value":{"type":"number","description":"In-app content view conversion value"},"website_omni_view_content_conversion_value":{"type":"number","description":"Website content view conversion value"},"offline_omni_view_content_conversion_value":{"type":"number","description":"Offline content view conversion value"},"meta_omni_view_content_conversion_value":{"type":"number","description":"Meta content view conversion value"},"cost_per_omni_view_content":{"type":"number","description":"Cost per content view"},"omni_search":{"type":"number","description":"Searches"},"inapp_omni_search":{"type":"number","description":"In-app searches"},"website_omni_search":{"type":"number","description":"Website searches"},"offline_omni_search":{"type":"number","description":"Offline searches"},"omni_search_conversion_value":{"type":"number","description":"Search conversion value"},"inapp_omni_search_conversion_value":{"type":"number","description":"In-app search conversion value"},"website_omni_search_conversion_value":{"type":"number","description":"Website search conversion value"},"offline_omni_search_conversion_value":{"type":"number","description":"Offline search conversion value"},"cost_per_omni_search":{"type":"number","description":"Cost per search"},"omni_add_to_cart":{"type":"number","description":"Add to cart"},"inapp_omni_add_to_cart":{"type":"number","description":"In-app add to cart"},"website_omni_add_to_cart":{"type":"number","description":"Website add to cart"},"offline_omni_add_to_cart":{"type":"number","description":"Offline add to cart"},"meta_omni_add_to_cart":{"type":"number","description":"Meta add to cart"},"omni_add_to_cart_conversion_value":{"type":"number","description":"Add to cart conversion value"},"inapp_omni_add_to_cart_conversion_value":{"type":"number","description":"In-app add to cart conversion value"},"website_omni_add_to_cart_conversion_value":{"type":"number","description":"Website add to cart conversion value"},"offline_omni_add_to_cart_conversion_value":{"type":"number","description":"Offline add to cart conversion value"},"meta_omni_add_to_cart_conversion_value":{"type":"number","description":"Meta add to cart conversion value"},"cost_per_omni_add_to_cart":{"type":"number","description":"Cost per add to cart"},"omni_add_to_wishlist":{"type":"number","description":"Add to wishlist"},"inapp_omni_add_to_wishlist":{"type":"number","description":"In-app add to wishlist"},"website_omni_add_to_wishlist":{"type":"number","description":"Website add to wishlist"},"offline_omni_add_to_wishlist":{"type":"number","description":"Offline add to wishlist"},"meta_omni_add_to_wishlist":{"type":"number","description":"Meta add to wishlist"},"omni_add_to_wishlist_conversion_value":{"type":"number","description":"Add to wishlist conversion value"},"inapp_omni_add_to_wishlist_conversion_value":{"type":"number","description":"In-app add to wishlist conversion value"},"website_omni_add_to_wishlist_conversion_value":{"type":"number","description":"Website add to wishlist conversion value"},"offline_omni_add_to_wishlist_conversion_value":{"type":"number","description":"Offline add to wishlist conversion value"},"meta_omni_add_to_wishlist_conversion_value":{"type":"number","description":"Meta add to wishlist conversion value"},"cost_per_omni_add_to_wishlist":{"type":"number","description":"Cost per add to wishlist"},"customize_product_total":{"type":"number","description":"Product customizations"},"inapp_customize_product_total":{"type":"number","description":"In-app product customizations"},"website_customize_product_total":{"type":"number","description":"Website product customizations"},"offline_customize_product_total":{"type":"number","description":"Offline product customizations"},"customize_product_total_conversion_value":{"type":"number","description":"Product customization conversion value"},"inapp_customize_product_total_conversion_value":{"type":"number","description":"In-app product customization conversion value"},"website_customize_product_total_conversion_value":{"type":"number","description":"Website product customization conversion value"},"offline_customize_product_total_conversion_value":{"type":"number","description":"Offline product customization conversion value"},"cost_per_customize_product_total":{"type":"number","description":"Cost per product customization"},"start_trial_total":{"type":"number","description":"Trials started"},"inapp_start_trial_total":{"type":"number","description":"In-app trials started"},"website_start_trial_total":{"type":"number","description":"Website trials started"},"offline_start_trial_total":{"type":"number","description":"Offline trials started"},"start_trial_total_conversion_value":{"type":"number","description":"Trial started conversion value"},"inapp_start_trial_total_conversion_value":{"type":"number","description":"In-app trial started conversion value"},"website_start_trial_total_conversion_value":{"type":"number","description":"Website trial started conversion value"},"offline_start_trial_total_conversion_value":{"type":"number","description":"Offline trial started conversion value"},"cost_per_start_trial_total":{"type":"number","description":"Cost per trial started"},"subscribe_total":{"type":"number","description":"Subscriptions"},"inapp_subscribe_total":{"type":"number","description":"In-app subscriptions"},"website_subscribe_total":{"type":"number","description":"Website subscriptions"},"offline_subscribe_total":{"type":"number","description":"Offline subscriptions"},"subscribe_total_conversion_value":{"type":"number","description":"Subscription conversion value"},"inapp_subscribe_total_conversion_value":{"type":"number","description":"In-app subscription conversion value"},"website_subscribe_total_conversion_value":{"type":"number","description":"Website subscription conversion value"},"offline_subscribe_total_conversion_value":{"type":"number","description":"Offline subscription conversion value"},"cost_per_subscribe_total":{"type":"number","description":"Cost per subscription"},"submit_application_total":{"type":"number","description":"Applications submitted"},"inapp_submit_application_total":{"type":"number","description":"In-app applications submitted"},"website_submit_application_total":{"type":"number","description":"Website applications submitted"},"offline_submit_application_total":{"type":"number","description":"Offline applications submitted"},"meta_submit_application_total":{"type":"number","description":"Meta applications submitted"},"submit_application_total_conversion_value":{"type":"number","description":"Application submitted conversion value"},"inapp_submit_application_total_conversion_value":{"type":"number","description":"In-app application submitted conversion value"},"website_submit_application_total_conversion_value":{"type":"number","description":"Website application submitted conversion value"},"offline_submit_application_total_conversion_value":{"type":"number","description":"Offline application submitted conversion value"},"meta_submit_application_total_conversion_value":{"type":"number","description":"Meta application submitted conversion value"},"cost_per_submit_application_total":{"type":"number","description":"Cost per application submitted"},"contact_total":{"type":"number","description":"Contacts"},"inapp_contact_total":{"type":"number","description":"In-app contacts"},"website_contact_total":{"type":"number","description":"Website contacts"},"offline_contact_total":{"type":"number","description":"Offline contacts"},"contact_total_conversion_value":{"type":"number","description":"Contact conversion value"},"inapp_contact_total_conversion_value":{"type":"number","description":"In-app contact conversion value"},"website_contact_total_conversion_value":{"type":"number","description":"Website contact conversion value"},"offline_contact_total_conversion_value":{"type":"number","description":"Offline contact conversion value"},"cost_per_contact_total":{"type":"number","description":"Cost per contact"},"landing_page_view":{"type":"number","description":"Landing page views"},"inapp_landing_page_view":{"type":"number","description":"In-app landing page views"},"website_landing_page_view":{"type":"number","description":"Website landing page views"},"cost_per_landing_page_view":{"type":"number","description":"Cost per landing page view"},"order_created":{"type":"number","description":"Orders created"},"order_shipped":{"type":"number","description":"Orders shipped"},"purchase_roas":{"type":"number","description":"Purchase ROAS"},"inapp_purchase_roas":{"type":"number","description":"In-app purchase ROAS"},"website_purchase_roas":{"type":"number","description":"Website purchase ROAS"},"order_statistics":{"type":"array","description":"Order count grouped by day offset from campaign start","items":{"type":"object","properties":{"id":{"type":"integer","description":"Day offset"},"order_count":{"type":"integer","description":"Number of orders on that day"}}}}}},"targeting":{"type":"object","description":"Audience targeting settings","properties":{"age_min":{"type":"integer","description":"Minimum age"},"age_max":{"type":"integer","description":"Maximum age"},"age_range":{"type":"array","description":"Age range [min, max]","items":{"type":"integer"}},"genders":{"type":"array","description":"Gender targeting: 1 = male, 2 = female","items":{"type":"integer"}},"device_platforms":{"type":"array","description":"Device platforms targeted","items":{"type":"string"}},"publisher_platforms":{"type":"array","description":"Publisher platforms targeted","items":{"type":"string"}},"facebook_positions":{"type":"array","description":"Facebook ad placements","items":{"type":"string"}},"locales":{"type":"array","description":"Language locale IDs","items":{"type":"integer"}},"geo_locations":{"type":"object","description":"Geographic targeting","properties":{"countries":{"type":"array","description":"Country codes","items":{"type":"string"}},"location_types":{"type":"array","description":"Location types (home, recent, travel_in)","items":{"type":"string"}}}},"flexible_spec":{"type":"array","description":"Flexible audience targeting (interests, behaviors, life events)","items":{"type":"object","properties":{"interests":{"type":"array","description":"Interest targeting","items":{"type":"object","properties":{"id":{"type":"string","description":"Interest ID"},"name":{"type":"string","description":"Interest name"}}}},"behaviors":{"type":"array","description":"Behavior targeting","items":{"type":"object","properties":{"id":{"type":"string","description":"Behavior ID"},"name":{"type":"string","description":"Behavior name"}}}},"life_events":{"type":"array","description":"Life event targeting","items":{"type":"object","properties":{"id":{"type":"string","description":"Life event ID"},"name":{"type":"string","description":"Life event name"}}}},"relationship_statuses":{"type":"array","description":"Relationship status targeting","items":{"type":"integer"}}}}},"targeting_automation":{"type":"object","description":"Advantage audience automation settings","properties":{"advantage_audience":{"type":"integer","description":"Advantage audience enabled: 1 = yes, 0 = no"}}}}}}}},"summary":{"type":"object","description":"Aggregated performance metrics across all ad sets","properties":{"impressions":{"type":"number","description":"Total impressions"},"clicks":{"type":"integer","description":"Total clicks"},"reach":{"type":"integer","description":"Total unique people reached"},"spend":{"type":"number","description":"Total amount spent"},"cpc":{"type":"number","description":"CPC"},"cpm":{"type":"number","description":"CPM"},"cpp":{"type":"number","description":"CPP"},"ctr":{"type":"number","description":"CTR"},"frequency":{"type":"number","description":"Average frequency"}}},"page_number":{"type":"integer","description":"Current page number"},"page_size":{"type":"integer","description":"Number of records per page"},"total_entries":{"type":"integer","description":"Total number of ad sets"},"total_pages":{"type":"integer","description":"Total number of pages"}}},"AdListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Success status"},"data":{"type":"array","description":"List of ads","items":{"type":"object","properties":{"id":{"type":"string","description":"Ad ID"},"name":{"type":"string","description":"Ad name"},"status":{"type":"string","description":"Ad status","enum":["ACTIVE","PAUSED","DELETED","ARCHIVED"],"x-enum-descriptions":["Active","Paused","Deleted","Archived"]},"effective_status":{"type":"string","description":"Effective status","enum":["ACTIVE","PAUSED","DELETED","PENDING_REVIEW","DISAPPROVED","PREAPPROVED","PENDING_BILLING_INFO","CAMPAIGN_PAUSED","ARCHIVED","ADSET_PAUSED","IN_PROCESS","WITH_ISSUES"],"x-enum-descriptions":["Active","Paused","Deleted","Pending review","Disapproved","Preapproved","Pending billing info","Campaign paused","Archived","Ad set paused","In process","With issues"]},"created_time":{"type":"string","format":"date-time","description":"Ad creation time"},"marketer_id":{"type":"string","nullable":true,"description":"Marketer ID assigned"},"product_id":{"type":"string","nullable":true,"description":"ID of product"},"product_category_id":{"type":"string","nullable":true,"description":"ID of product category"},"ad_account":{"type":"object","description":"Ad account","properties":{"id":{"type":"string","description":"Ad account ID"},"name":{"type":"string","description":"Ad account name"},"currency":{"type":"string","description":"Currency used by the account"}}},"ad_campaign":{"type":"object","description":"Parent campaign of the ad","properties":{"id":{"type":"string","description":"Campaign ID"},"name":{"type":"string","description":"Campaign name"}}},"ad_set":{"type":"object","description":"Ad group","properties":{"id":{"type":"string","description":"Ad set ID"},"name":{"type":"string","description":"Ad set name"}}},"ad_creative":{"type":"object","description":"Facebook post (bài viết)","properties":{"id":{"type":"string","description":"Creative ID"},"name":{"type":"string","description":"Post content"},"object_story_id":{"type":"string","description":"Facebook post ID"}}},"insights":{"type":"object","description":"Ad performance metrics","properties":{"ad_ids":{"type":"array","description":"List of ad IDs in this campaign","items":{"type":"string"}},"impressions":{"type":"number","description":"Number of ad impressions"},"clicks":{"type":"integer","description":"Number of clicks (all)"},"reach":{"type":"integer","description":"Number of people reached via Instant Experience"},"spend":{"type":"number","description":"Total amount spent"},"cpc":{"type":"number","description":"CPC"},"cpm":{"type":"number","description":"CPM"},"cpp":{"type":"number","description":"CPP"},"ctr":{"type":"number","description":"CTR"},"frequency":{"type":"number","description":"Average frequency of ad views per person"},"ad_performance_session":{"type":"integer","description":"Overall performance metric"},"cost_per_1000_accounts_center_reach":{"type":"number","description":"Cost per 1000 accounts center reach"},"cost_per_result":{"type":"number","description":"Cost per result"},"avg_purchase_conversion_value":{"type":"number","description":"Average purchase conversion value"},"indicator_result":{"type":"number","description":"Result indicator value"},"result_roas":{"type":"number","description":"Return on ad spend (ROAS)"},"ad_engagement_session":{"type":"integer","description":"Overall engagement metric"},"link_click":{"type":"integer","description":"Link clicks"},"like":{"type":"integer","description":"Facebook likes"},"comment":{"type":"integer","description":"Post comments"},"post_engagement":{"type":"integer","description":"Post engagements"},"post_reaction":{"type":"integer","description":"Post reactions"},"post":{"type":"integer","description":"Post shares"},"onsite_conversion_post_save":{"type":"integer","description":"Post saves"},"photo_view":{"type":"integer","description":"Photo views"},"video_view":{"type":"integer","description":"Video plays (at least 3 seconds)"},"inline_link_click_ctr":{"type":"number","description":"CTR (link click-through rate, %)"},"outbound_click":{"type":"integer","description":"Outbound clicks"},"onsite_conversion_messaging_conversation_started_7d":{"type":"integer","description":"Messaging conversations started (7-day window)"},"onsite_conversion_messaging_first_reply":{"type":"integer","description":"New messaging contacts"},"onsite_conversion_messaging_block":{"type":"integer","description":"Messaging blocks"},"video_thruplay_watched_actions":{"type":"integer","description":"ThruPlays"},"video_play_actions":{"type":"integer","description":"Video plays"},"video_p25_watched_actions":{"type":"integer","description":"Video plays at 25% completion"},"video_p50_watched_actions":{"type":"integer","description":"Video plays at 50% completion"},"video_p75_watched_actions":{"type":"integer","description":"Video plays at 75% completion"},"video_p95_watched_actions":{"type":"integer","description":"Video plays at 95% completion"},"video_p100_watched_actions":{"type":"integer","description":"Video plays at 100% completion"},"estimated_ad_recallers":{"type":"number","description":"Estimated ad recall lift (people)"},"cost_per_outbound_click":{"type":"number","description":"Cost per outbound click"},"cost_per_thruplay":{"type":"number","description":"Cost per ThruPlay"},"outbound_clicks_ctr":{"type":"number","description":"Outbound click-through rate (%)"},"cost_per_post_engagement":{"type":"number","description":"Cost per post engagement"},"estimated_ad_recall_rate":{"type":"number","description":"Estimated ad recall lift rate (%)"},"cost_per_estimated_ad_recallers":{"type":"number","description":"Cost per estimated ad recall lift (people)"},"cost_per_messaging_conversation_started":{"type":"number","description":"Cost per messaging conversation started"},"lead":{"type":"number","description":"Leads"},"website_lead":{"type":"number","description":"Website leads"},"offline_lead":{"type":"number","description":"Offline leads"},"meta_lead":{"type":"number","description":"Meta leads"},"lead_conversion_value":{"type":"number","description":"Lead conversion value"},"website_lead_conversion_value":{"type":"number","description":"Website lead conversion value"},"offline_lead_conversion_value":{"type":"number","description":"Offline lead conversion value"},"meta_lead_conversion_value":{"type":"number","description":"Meta lead conversion value"},"cost_per_lead":{"type":"number","description":"Cost per lead"},"omni_purchase":{"type":"number","description":"Purchases"},"inapp_omni_purchase":{"type":"number","description":"In-app purchases"},"website_omni_purchase":{"type":"number","description":"Website purchases"},"offline_omni_purchase":{"type":"number","description":"Offline purchases"},"meta_omni_purchase":{"type":"number","description":"Meta purchases"},"omni_purchase_conversion_value":{"type":"number","description":"Purchase conversion value"},"inapp_omni_purchase_conversion_value":{"type":"number","description":"In-app purchase conversion value"},"website_omni_purchase_conversion_value":{"type":"number","description":"Website purchase conversion value"},"offline_omni_purchase_conversion_value":{"type":"number","description":"Offline purchase conversion value"},"meta_omni_purchase_conversion_value":{"type":"number","description":"Meta purchase conversion value"},"cost_per_omni_purchase":{"type":"number","description":"Cost per purchase"},"omni_initiated_checkout":{"type":"number","description":"Checkout initiated"},"inapp_omni_initiated_checkout":{"type":"number","description":"In-app checkout initiated"},"website_omni_initiated_checkout":{"type":"number","description":"Website checkout initiated"},"offline_omni_initiated_checkout":{"type":"number","description":"Offline checkout initiated"},"meta_omni_initiated_checkout":{"type":"number","description":"Meta checkout initiated"},"omni_initiated_checkout_conversion_value":{"type":"number","description":"Checkout initiated conversion value"},"inapp_omni_initiated_checkout_conversion_value":{"type":"number","description":"In-app checkout initiated conversion value"},"website_omni_initiated_checkout_conversion_value":{"type":"number","description":"Website checkout initiated conversion value"},"offline_omni_initiated_checkout_conversion_value":{"type":"number","description":"Offline checkout initiated conversion value"},"meta_omni_initiated_checkout_conversion_value":{"type":"number","description":"Meta checkout initiated conversion value"},"cost_per_omni_initiated_checkout":{"type":"number","description":"Cost per checkout initiated"},"omni_complete_registration":{"type":"number","description":"Registrations completed"},"inapp_omni_complete_registration":{"type":"number","description":"In-app registrations completed"},"website_omni_complete_registration":{"type":"number","description":"Website registrations completed"},"offline_omni_complete_registration":{"type":"number","description":"Offline registrations completed"},"omni_complete_registration_conversion_value":{"type":"number","description":"Registration completed conversion value"},"inapp_omni_complete_registration_conversion_value":{"type":"number","description":"In-app registration completed conversion value"},"website_omni_complete_registration_conversion_value":{"type":"number","description":"Website registration completed conversion value"},"offline_omni_complete_registration_conversion_value":{"type":"number","description":"Offline registration completed conversion value"},"cost_per_omni_complete_registration":{"type":"number","description":"Cost per registration completed"},"omni_view_content":{"type":"number","description":"Content views"},"inapp_omni_view_content":{"type":"number","description":"In-app content views"},"website_omni_view_content":{"type":"number","description":"Website content views"},"offline_omni_view_content":{"type":"number","description":"Offline content views"},"meta_omni_view_content":{"type":"number","description":"Meta content views"},"omni_view_content_conversion_value":{"type":"number","description":"Content view conversion value"},"inapp_omni_view_content_conversion_value":{"type":"number","description":"In-app content view conversion value"},"website_omni_view_content_conversion_value":{"type":"number","description":"Website content view conversion value"},"offline_omni_view_content_conversion_value":{"type":"number","description":"Offline content view conversion value"},"meta_omni_view_content_conversion_value":{"type":"number","description":"Meta content view conversion value"},"cost_per_omni_view_content":{"type":"number","description":"Cost per content view"},"omni_search":{"type":"number","description":"Searches"},"inapp_omni_search":{"type":"number","description":"In-app searches"},"website_omni_search":{"type":"number","description":"Website searches"},"offline_omni_search":{"type":"number","description":"Offline searches"},"omni_search_conversion_value":{"type":"number","description":"Search conversion value"},"inapp_omni_search_conversion_value":{"type":"number","description":"In-app search conversion value"},"website_omni_search_conversion_value":{"type":"number","description":"Website search conversion value"},"offline_omni_search_conversion_value":{"type":"number","description":"Offline search conversion value"},"cost_per_omni_search":{"type":"number","description":"Cost per search"},"omni_add_to_cart":{"type":"number","description":"Add to cart"},"inapp_omni_add_to_cart":{"type":"number","description":"In-app add to cart"},"website_omni_add_to_cart":{"type":"number","description":"Website add to cart"},"offline_omni_add_to_cart":{"type":"number","description":"Offline add to cart"},"meta_omni_add_to_cart":{"type":"number","description":"Meta add to cart"},"omni_add_to_cart_conversion_value":{"type":"number","description":"Add to cart conversion value"},"inapp_omni_add_to_cart_conversion_value":{"type":"number","description":"In-app add to cart conversion value"},"website_omni_add_to_cart_conversion_value":{"type":"number","description":"Website add to cart conversion value"},"offline_omni_add_to_cart_conversion_value":{"type":"number","description":"Offline add to cart conversion value"},"meta_omni_add_to_cart_conversion_value":{"type":"number","description":"Meta add to cart conversion value"},"cost_per_omni_add_to_cart":{"type":"number","description":"Cost per add to cart"},"omni_add_to_wishlist":{"type":"number","description":"Add to wishlist"},"inapp_omni_add_to_wishlist":{"type":"number","description":"In-app add to wishlist"},"website_omni_add_to_wishlist":{"type":"number","description":"Website add to wishlist"},"offline_omni_add_to_wishlist":{"type":"number","description":"Offline add to wishlist"},"meta_omni_add_to_wishlist":{"type":"number","description":"Meta add to wishlist"},"omni_add_to_wishlist_conversion_value":{"type":"number","description":"Add to wishlist conversion value"},"inapp_omni_add_to_wishlist_conversion_value":{"type":"number","description":"In-app add to wishlist conversion value"},"website_omni_add_to_wishlist_conversion_value":{"type":"number","description":"Website add to wishlist conversion value"},"offline_omni_add_to_wishlist_conversion_value":{"type":"number","description":"Offline add to wishlist conversion value"},"meta_omni_add_to_wishlist_conversion_value":{"type":"number","description":"Meta add to wishlist conversion value"},"cost_per_omni_add_to_wishlist":{"type":"number","description":"Cost per add to wishlist"},"customize_product_total":{"type":"number","description":"Product customizations"},"inapp_customize_product_total":{"type":"number","description":"In-app product customizations"},"website_customize_product_total":{"type":"number","description":"Website product customizations"},"offline_customize_product_total":{"type":"number","description":"Offline product customizations"},"customize_product_total_conversion_value":{"type":"number","description":"Product customization conversion value"},"inapp_customize_product_total_conversion_value":{"type":"number","description":"In-app product customization conversion value"},"website_customize_product_total_conversion_value":{"type":"number","description":"Website product customization conversion value"},"offline_customize_product_total_conversion_value":{"type":"number","description":"Offline product customization conversion value"},"cost_per_customize_product_total":{"type":"number","description":"Cost per product customization"},"start_trial_total":{"type":"number","description":"Trials started"},"inapp_start_trial_total":{"type":"number","description":"In-app trials started"},"website_start_trial_total":{"type":"number","description":"Website trials started"},"offline_start_trial_total":{"type":"number","description":"Offline trials started"},"start_trial_total_conversion_value":{"type":"number","description":"Trial started conversion value"},"inapp_start_trial_total_conversion_value":{"type":"number","description":"In-app trial started conversion value"},"website_start_trial_total_conversion_value":{"type":"number","description":"Website trial started conversion value"},"offline_start_trial_total_conversion_value":{"type":"number","description":"Offline trial started conversion value"},"cost_per_start_trial_total":{"type":"number","description":"Cost per trial started"},"subscribe_total":{"type":"number","description":"Subscriptions"},"inapp_subscribe_total":{"type":"number","description":"In-app subscriptions"},"website_subscribe_total":{"type":"number","description":"Website subscriptions"},"offline_subscribe_total":{"type":"number","description":"Offline subscriptions"},"subscribe_total_conversion_value":{"type":"number","description":"Subscription conversion value"},"inapp_subscribe_total_conversion_value":{"type":"number","description":"In-app subscription conversion value"},"website_subscribe_total_conversion_value":{"type":"number","description":"Website subscription conversion value"},"offline_subscribe_total_conversion_value":{"type":"number","description":"Offline subscription conversion value"},"cost_per_subscribe_total":{"type":"number","description":"Cost per subscription"},"submit_application_total":{"type":"number","description":"Applications submitted"},"inapp_submit_application_total":{"type":"number","description":"In-app applications submitted"},"website_submit_application_total":{"type":"number","description":"Website applications submitted"},"offline_submit_application_total":{"type":"number","description":"Offline applications submitted"},"meta_submit_application_total":{"type":"number","description":"Meta applications submitted"},"submit_application_total_conversion_value":{"type":"number","description":"Application submitted conversion value"},"inapp_submit_application_total_conversion_value":{"type":"number","description":"In-app application submitted conversion value"},"website_submit_application_total_conversion_value":{"type":"number","description":"Website application submitted conversion value"},"offline_submit_application_total_conversion_value":{"type":"number","description":"Offline application submitted conversion value"},"meta_submit_application_total_conversion_value":{"type":"number","description":"Meta application submitted conversion value"},"cost_per_submit_application_total":{"type":"number","description":"Cost per application submitted"},"contact_total":{"type":"number","description":"Contacts"},"inapp_contact_total":{"type":"number","description":"In-app contacts"},"website_contact_total":{"type":"number","description":"Website contacts"},"offline_contact_total":{"type":"number","description":"Offline contacts"},"contact_total_conversion_value":{"type":"number","description":"Contact conversion value"},"inapp_contact_total_conversion_value":{"type":"number","description":"In-app contact conversion value"},"website_contact_total_conversion_value":{"type":"number","description":"Website contact conversion value"},"offline_contact_total_conversion_value":{"type":"number","description":"Offline contact conversion value"},"cost_per_contact_total":{"type":"number","description":"Cost per contact"},"landing_page_view":{"type":"number","description":"Landing page views"},"inapp_landing_page_view":{"type":"number","description":"In-app landing page views"},"website_landing_page_view":{"type":"number","description":"Website landing page views"},"cost_per_landing_page_view":{"type":"number","description":"Cost per landing page view"},"order_created":{"type":"number","description":"Orders created"},"order_shipped":{"type":"number","description":"Orders shipped"},"purchase_roas":{"type":"number","description":"Purchase ROAS"},"inapp_purchase_roas":{"type":"number","description":"In-app purchase ROAS"},"website_purchase_roas":{"type":"number","description":"Website purchase ROAS"},"order_statistics":{"type":"array","description":"Order count grouped by day offset from campaign start","items":{"type":"object","properties":{"id":{"type":"integer","description":"Day offset"},"order_count":{"type":"integer","description":"Number of orders on that day"}}}}}}}}},"summary":{"type":"object","description":"Aggregated performance metrics across all ads","properties":{"impressions":{"type":"number","description":"Total impressions"},"clicks":{"type":"integer","description":"Total clicks"},"reach":{"type":"integer","description":"Total unique people reached"},"spend":{"type":"number","description":"Total amount spent"},"cpc":{"type":"number","description":"CPC"},"cpm":{"type":"number","description":"CPM"},"cpp":{"type":"number","description":"CPP"},"ctr":{"type":"number","description":"CTR"},"frequency":{"type":"number","description":"Average frequency"}}},"page_number":{"type":"integer","description":"Current page number"},"page_size":{"type":"integer","description":"Number of records per page"},"total_entries":{"type":"integer","description":"Total number of ads"},"total_pages":{"type":"integer","description":"Total number of pages"}}},"Reconciliation":{"type":"object","description":"Reconciliation session with its orders","properties":{"system_id":{"type":"integer","description":"Internal session ID. Use it for the `system_id` filter"},"display_id":{"type":"integer","description":"Session code shown on the shop screen"},"custom_id":{"type":"string","nullable":true,"description":"Code set by the shop or the marketplace (e.g. statement ID)"},"partner_id":{"type":"string","nullable":true,"description":"Shipping partner ID on Pancake system"},"control_type":{"type":"string","enum":["control_cod","control_fee","all","merge"],"x-enum-descriptions":["COD reconciliation","Shipping fee reconciliation","COD and shipping fee reconciliation","Session merged from orders"],"description":"Session type. Very old sessions without a type are returned as `all`"},"note":{"type":"string","nullable":true,"description":"Note"},"excel_cod":{"type":"integer","nullable":true,"description":"Total COD according to the carrier statement"},"excel_fee":{"type":"integer","nullable":true,"description":"Total shipping fee according to the carrier statement"},"pos_cod":{"type":"integer","nullable":true,"description":"Total COD according to POS orders"},"paid_at":{"type":"string","format":"date-time","nullable":true,"description":"Payment time of the session"},"payment_status":{"type":"string","enum":["paid","unpaid"],"x-enum-descriptions":["Paid","Unpaid"],"description":"Payment status"},"creator":{"allOf":[{"$ref":"#/components/schemas/ReconciliationUser"}],"nullable":true,"description":"User who created the session"},"updater":{"allOf":[{"$ref":"#/components/schemas/ReconciliationUser"}],"nullable":true,"description":"User who last edited the session. Null for sessions never edited since the field was introduced"},"inserted_at":{"type":"string","format":"date-time","description":"Session creation time"},"updated_at":{"type":"string","format":"date-time","description":"Last update time. Sync cursor for incremental sync; bumped by every change including attaching transactions and removal"},"is_removed":{"type":"boolean","description":"True when the session was removed (soft delete). Only returned with `include_removed=true`"},"orders":{"type":"array","description":"Orders of the session. Never truncated","items":{"$ref":"#/components/schemas/ReconciliationOrder"}}}},"ReconciliationUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"User ID"},"name":{"type":"string","nullable":true,"description":"User name. Null when the user was deleted from the system"}}},"ReconciliationOrder":{"type":"object","description":"Order snapshot inside a reconciliation session","properties":{"order_id":{"type":"integer","description":"Internal order ID (`system_id` of the order)"},"display_id":{"type":"integer","nullable":true,"description":"Order ID shown on the shop (`id` of the order)"},"custom_id":{"type":"string","nullable":true,"description":"Custom order code set by the shop"},"extend_code":{"type":"string","nullable":true,"description":"Tracking code from the shipping partner"},"order_number_vtp":{"type":"string","nullable":true,"description":"Viettel Post order number"},"order_status":{"type":"integer","nullable":true,"description":"Order status at the time the order was added to the session. Same values as `status` of the order"},"result":{"type":"string","nullable":true,"enum":["succeed","mismatch","failed"],"x-enum-descriptions":["Matched","Mismatched amount","Not reconciled (order not found or invalid)"],"description":"Reconciliation result of the order in this session"},"message":{"type":"string","nullable":true,"description":"Reason when the order could not be reconciled"},"cod_amount":{"type":"integer","nullable":true,"description":"COD amount according to the shipping partner. Null when this session does not reconcile COD for the order"},"partner_fee":{"type":"integer","nullable":true,"description":"Shipping fee according to the shipping partner"},"pos_cod":{"type":"integer","nullable":true,"description":"COD amount of the order on POS"},"currency":{"type":"string","nullable":true,"description":"Currency of the order"},"reconciliation_at":{"type":"string","format":"date-time","nullable":true,"description":"Reconciliation time of the order"}}}}}}