Welcome to the FlashShip API documentation. This API enables seamless integration with our services, allowing you to create and manage order, track deliveries, and access real-time updates efficiently.
\nThe API is designed to integrate with consumers' back-end services. It accepts and returns JSON-encoded data.
\nCustomers must provide the IP addresses of their production servers to FlashShip for whitelisting before using the production API.
\nBase API URL:
\nTest environment: https://devpod.flashship.net/seller-api-v2
\nProduction environment: https://api.flashship.net/seller-api-v2
\nUpdate 21 Nov 2025:
\nUpdate 15 Aug 2025:
\nUpdate 29 Apr 2025:
\nUpdate 20 Feb 2025:
\nUpdate 12 Feb 2025:
\nUpdate 03 Dec 2024:
\nAdded two new \"get List of order detail\" APIs:
\nBy list of order codes.
\nBy list of partner order IDs.
\nUpdate 11 Oct 2024:
\nDeprecated the following order statuses:
\nGROUPED
WAIT_SHIPPING
REJECT_REQUESTED
REJECTED
Introduced new order statuses:
\nREQUEST_CANCEL
\nCANCELED
\nREQUEST_REFUND
\nREFUNDED
\nThe get OrderDetail API now includes a refund_amount field for orders with statuses CANCELED or REFUNDED.
\nAdded a \"code\" field to API response json, indicating error status:
\nFLS-200: success
\nFLS-406: Insufficient balance – order created but payment is PENDING; seller must repay via the web admin panel.
FLS-400: other error
(Refer to the API details below for more information).
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33078347","collectionId":"c659d634-d6b2-4124-89b6-4a9430a91abd","publishedId":"2sA2r9XPGe","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-04-26T03:38:35.000Z"},"item":[{"name":"Authentication","item":[{"name":"Login","id":"6e805eb1-fa48-4a69-ab30-574ba186d460","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\" : \"testuser\",\r\n \"password\" : \"testpassword\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_api_url}}/token","description":"API requests to FlashShip use the Bearer authentication scheme. To authenticate a request, provide the token in the Authorization header of the request:
\nAuthorization: Bearer access_token
The Login API returns an \"access_token\", which can then be used to make other API calls.
\nUse this API to retrieve the list of variants.
\nYou may also select a variant from the following link: https://docs.google.com/spreadsheets/d/1uLofViVPDXeslEiwYg8zPc2_loeudjsb/edit
\n","urlObject":{"path":["orders","list-variant-sku"],"host":["{{base_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"48add4b6-1414-4027-a1dc-9be4b267d347","name":"Variant list","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://devpod.flashship.net/seller-api-v2/orders/list-variant-sku"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 05 Dec 2023 03:57:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1862"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"upgrade-insecure-requests"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"FLS_200\",\n \"msg\": \"success\",\n \"data\": [\n {\n \"variant_id\": 12126,\n \"product_type\": \"SHIRT\",\n \"brand\": \"GILDAN\",\n \"style\": \"G5000\",\n \"size\": \"S\",\n \"color\": \"BLACK\"\n },\n {\n \"variant_id\": 12125,\n \"product_type\": \"SHIRT\",\n \"brand\": \"GILDAN\",\n \"style\": \"G5000\",\n \"size\": \"M\",\n \"color\": \"BLACK\"\n },\n {\n \"variant_id\": 84138,\n \"product_type\": \"TANKTOP\",\n \"brand\": \"GILDAN\",\n \"style\": \"G2200\",\n \"size\": \"3XL\",\n \"color\": \"SPORTGREY\"\n }\n ],\n \"err\": null,\n \"expect_date\": null\n}"}],"_postman_id":"586518a0-e8ed-4d2f-aebc-e98fca6e3f80"},{"name":"Create Shirt Order","id":"6ce04d1a-f7f9-433d-afaf-ba0c2a3a4cd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this API to create a shirt order.
\nRequest parameters:
\nResponse parameters:
\n","urlObject":{"path":["orders","shirt-add"],"host":["{{base_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"a3232464-b68b-4428-8590-44806e1ad132","name":"Create Order Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"\",\r\n \"buyer_first_name\": \"Jack\",\r\n \"buyer_last_name\": \"Sparrow\",\r\n \"buyer_email\": \"nguyenvan_A414@gmail.com\",\r\n \"buyer_phone\": \"766612489\",\r\n \"buyer_address1\": \"18462 Edinbrook Ln\",\r\n \"buyer_address2\": \"\",\r\n \"buyer_city\": \"Westfield\",\r\n \"buyer_province_code\": \"IN\",\r\n \"buyer_zip\": \"46074\",\r\n \"buyer_country_code\": \"US\",\r\n \"shipment\": \"1\",\r\n \"link_label\":null,\r\n \"products\": [\r\n {\r\n \"variant_id\": 12128,\r\n \"printer_design_front_url\": \"https://drive.google.com/file/d/XXXXXXXXXX/view?usp=sharing\",// Minimum requirement must have one URL (front ,back,right,left,neck)\r\n \"printer_design_back_url\": null,// Minimum requirement must have one URL (front ,back,right,left,neck)\r\n \"printer_design_right_url\": null,// Minimum requirement must have one URL (front ,back,right,left,neck)\r\n \"printer_design_left_url\": null,// Minimum requirement must have one URL (front ,back,right,left,neck)\r\n \"printer_design_neck_url\": null,// Minimum requirement must have one URL (front ,back,right,left,neck)\r\n \"mockup_front_url\": \"https://drive.google.com/file/d/XXXXXXXXXX/view?usp=sharing\",\r\n \"mockup_back_url\": null,\r\n \"mockup_right_url\": null,\r\n \"mockup_left_url\": null,\r\n \"mockup_neck_url\": null,\r\n \"quantity\": 2,\r\n \"special_print\": 1,\r\n \"note\": \"\",\r\n \"printType\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://devpod.flashship.net/seller-api-v2/orders/shirt-add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 05 Dec 2023 03:59:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"47"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"upgrade-insecure-requests"}],"cookie":[],"responseTime":null,"body":"{\n \"code\":\"FLS_200\",\n \"msg\": \"success\",\n \"data\": \"KPOWDPRCA\",\n \"err\": null\n}"}],"_postman_id":"6ce04d1a-f7f9-433d-afaf-ba0c2a3a4cd2"},{"name":"Create Ornament Order","id":"4f65ade3-948e-44d9-b041-e584cb704c4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this API to create an ornament order.
\nRequest parameters:
\nResponse parameters:
\n","urlObject":{"path":["orders","ornament-add"],"host":["{{base_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"11b8406e-08a8-4f23-b229-0eaab466747a","name":"Create Ornament Order Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"order_id_0000001\", // if order_id is empty system will return you a random order_id, order_id is unique\r\n \"buyer_first_name\": \"Jack\", // required\r\n \"buyer_last_name\": \"Sparrow\",\r\n \"buyer_email\": \"nguyenvan_A1148@gmail.com\",\r\n \"buyer_phone\": \"766612489\",\r\n \"buyer_address1\": \"18462 Edinbrook Ln\", // required\r\n \"buyer_address2\": \"\",\r\n \"buyer_city\": \"Westfield\", // required\r\n \"buyer_province_code\": \"IN\", // required and use abbreviations for US state names\r\n \"buyer_zip\": \"46074\", // required\r\n \"buyer_country_code\": \"US\", // default value is US\r\n \"shipment\": \"1\",\r\n \"link_label\":null,\r\n \"products\": [\r\n {\r\n \"variant_id\": 53119, // required - id of an ornament variant\r\n \"printer_design_front_url\": \"https://...\",\r\n \"mockup_front_url\": \"https://....\",\r\n \"quantity\": 1, // required\r\n \"note\": \"\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://devpod.flashship.net/seller-api-v2/orders/shirt-add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 05 Dec 2023 03:59:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"47"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"upgrade-insecure-requests"}],"cookie":[],"responseTime":null,"body":"{\n \"code\":\"FLS_200\",\n \"msg\": \"success\",\n \"data\": \"KPOWDPRCA\",\n \"err\": null\n}"}],"_postman_id":"4f65ade3-948e-44d9-b041-e584cb704c4f"},{"name":"Cancel Order","id":"4165d26e-2e22-44be-9187-e8d9564be33e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Cancel an order by providing order_code, which returned by FlashShip after calling shirt-add API.
\nCurrent status of order must not in [\"COMPLETED\"].
\n","urlObject":{"path":["orders","seller-reject"],"host":["{{base_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"2adb8e77-1491-4dd1-89ea-8d926ef3d58e","name":"Cancel Order Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order_code_list\": [\r\n \"GSC4HUQ1B\"\r\n ],\r\n \"reject_note\": \"wrong design\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://devpod.flashship.net/seller-api-v2/orders/seller-reject"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 05 Dec 2023 03:56:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"118"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"upgrade-insecure-requests"}],"cookie":[],"responseTime":null,"body":"{\n \"code\":\"FLS_200\",\n \"msg\": \"success\",\n \"data\": {\n \"order_id_list\": [\n 233292\n ],\n \"order_code_list\": [\n \"GSC4HUQ1B\"\n ],\n \"reject_note\": \"wrong design\"\n },\n \"err\": null\n}"}],"_postman_id":"4165d26e-2e22-44be-9187-e8d9564be33e"},{"name":"get Order Detail by order_code","id":"c79885d3-b1e5-4254-93b0-3fa0d8da8bab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get order detail using FlashShip's order_code.
\nOutput:
\n","urlObject":{"path":["orders","KXILCU5MK"],"host":["{{base_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"1d1e5819-7aaa-446d-bf82-cec3350deb2a","name":"Detail Order","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://devpod.flashship.net/seller-api-v2/orders/KXILCU5MK"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 05 Dec 2023 03:57:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1862"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"upgrade-insecure-requests"}],"cookie":[],"responseTime":null,"body":"{\n \"order_code\": \"MWFT8V123\", \n \"partner_order_id\": \"#123456\",\n \"shipment_method\": 1,\n \"first_name\": \"Jack\",\n \"last_name\": \"Sparrow\",\n \"email\": \"support@XXX.com\",\n \"phone\": \"\",\n \"province\": \"AZ\",\n \"country\": \"US\",\n \"region\": \"AZ\",\n \"address_line_1\": \"6445 McCauley Ter\",\n \"address_line_2\": \"\",\n \"city\": \"EDINA\",\n \"zip\": \"55439\",\n \"note\": null,\n \"status\": \"CONFIRMED\",\n \"created\": \"2024-02-14T14:13:29+07:00\",\n \"quantity\": 1,\n \"tracking_number\": null,\n \"reject_user\": null,\n \"reject_note\": null,\n \"reject_type\": null,\n \"reject_request_date\": null,\n \"reject_confirm_date\": null,\n \"total_fee\": 10.99,\n \"carrier\": null, \n \"products\": [\n {\n \"variant_id\": 12101,\n \"variant_sku\": \"M/WHITE\",\n \"front_print_url\": \"https://drive.google.com/file/d/XXXXXXXXXX/view?usp=sharing\",\n \"back_print_url\": null,\n \"left_print_url\": null,\n \"right_print_url\": null,\n \"neck_print_url\": null,\n \"pocket_print_url\": null,\n \"hood_print_url\": null,\n \"mockup_front\": \"https://drive.google.com/file/d/XXXXXXXXXX/view?usp=sharing\",\n \"mockup_back\": null, \n \"mockup_right\": null,\n \"mockup_left\": null, \n \"mockup_neck\": null,\n \"mockup_pocket\": null,\n \"mockup_hood\": null,\n \"quantity\": 1,\n \"note\": \"\",\n \"product_type_enum\": \"SHIRT\"\n }\n ] \n}"}],"_postman_id":"c79885d3-b1e5-4254-93b0-3fa0d8da8bab"},{"name":"get Order Detail by partner_order_id","id":"2d757a7b-e7dc-4f9e-afda-0cae89ed656f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get order detail by partner_order_id.
\nInput: partner_order_id.
\nOutput: list order detail informations.
\n","urlObject":{"path":["orders","partner-order-id"],"host":["{{base_api_url}}"],"query":[],"variable":[]}},"response":[{"id":"527240e8-c509-48cf-a1b8-38501888281d","name":"Detail Order Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"partner_order_id\": \"#123456\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://devpod.flashship.net/seller-api-v2/orders/partner-order-id"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 05 Dec 2023 03:56:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"118"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"upgrade-insecure-requests"}],"cookie":[],"responseTime":null,"body":"{\n \"order_code\": \"MWFT8V123\", \n \"partner_order_id\": \"#123456\",\n \"shipment_method\": 1,\n \"first_name\": \"Jack\",\n \"last_name\": \"Sparrow\",\n \"email\": \"support@XXX.com\",\n \"phone\": \"\",\n \"province\": \"AZ\",\n \"country\": \"US\",\n \"region\": \"AZ\",\n \"address_line_1\": \"6445 McCauley Ter\",\n \"address_line_2\": \"\",\n \"city\": \"EDINA\",\n \"zip\": \"55439\",\n \"note\": null,\n \"status\": \"CONFIRMED\",\n \"created\": \"2024-02-14T14:13:29+07:00\",\n \"quantity\": 1,\n \"tracking_number\": null,\n \"tracking_status\": null,\n \"reject_user\": null,\n \"reject_note\": null,\n \"reject_type\": null,\n \"reject_request_date\": null,\n \"reject_confirm_date\": null,\n \"total_fee\": 10.99,\n \"carrier\": null, \n \"products\": [\n {\n \"variant_id\": 12101,\n \"variant_sku\": \"M/WHITE\",\n \"front_print_url\": \"https://drive.google.com/file/d/XXXXXXXXXX/view?usp=sharing\",\n \"back_print_url\": null,\n \"left_print_url\": null,\n \"right_print_url\": null,\n \"neck_print_url\": null,\n \"pocket_print_url\": null,\n \"hood_print_url\": null,\n \"mockup_front\": \"https://drive.google.com/file/d/XXXXXXXXXX/view?usp=sharing\",\n \"mockup_back\": null, \n \"mockup_right\": null,\n \"mockup_left\": null, \n \"mockup_neck\": null,\n \"mockup_pocket\": null,\n \"quantity\": 1,\n \"note\": \"\",\n \"product_type_enum\": \"SHIRT\"\n }\n ] \n}"}],"_postman_id":"2d757a7b-e7dc-4f9e-afda-0cae89ed656f"},{"name":"get List of Order Details by Partner Order Ids","id":"b530a4c5-3fa8-41dc-a6d8-652e821f4694","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get List of order details by Partner Order Ids, maximum 20 orders per request.
\nInput: list_partner_order_id
\nOutput: order detail informations.
\n","urlObject":{"path":["orders","list-partner-order-id"],"host":["{{base_api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b530a4c5-3fa8-41dc-a6d8-652e821f4694"},{"name":"get List of Order Details by Order Codes","id":"414fbe6e-401c-4181-acb7-747414722631","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get List order details by order codes, maximum 20 orders per request.
\nInput: list_order_code.
\nOutput: order detail informations.
\n","urlObject":{"path":["orders","list-order-code"],"host":["{{base_api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"414fbe6e-401c-4181-acb7-747414722631"}],"id":"af7b83c7-7621-4590-b3f5-19d84cab3aea","description":"The Orders API allows you to create new orders and retreive order information.
\nEach order will go through different states while being processed. The following order status types indicate those states:
\n","_postman_id":"af7b83c7-7621-4590-b3f5-19d84cab3aea"},{"name":"Webhook","item":[{"name":"Order created","id":"e39cb753-e4de-41f1-af2f-b51e52974f9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-signature","value":"abcdef","type":"text"},{"key":"type","value":"order:created","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"type\": \"order:created\",\r\n\t\"created_at\": \"2025-04-16T12:50:11.615120283+07:00\",\r\n\t\"resource\": {\r\n\t\t\"partner_order_id\": \"partner-id-12345\",\r\n\t\t\"order_code\": \"ABCDEFGHI\",\r\n\t\t\"status\": \"CONFIRMED\",\r\n\t\t\"payment_status\": \"INIT\",\r\n\t\t\"tracking_status\": null,\r\n\t\t\"tracking_number\": null,\r\n\t\t\"quantity\": 2,\r\n\t\t\"total_fee\": 20\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://partner-domain.com/webhook-url","urlObject":{"protocol":"https","path":["webhook-url"],"host":["partner-domain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e39cb753-e4de-41f1-af2f-b51e52974f9a"},{"name":"Order status updated","id":"64c00ac8-cd34-4666-b3be-f29c91beff0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-signature","value":"abcdef","type":"text"},{"key":"type","value":"order:status:updated","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"type\": \"order:status:updated\",\r\n\t\"created_at\": \"2025-04-16T12:50:11.615120283+07:00\",\r\n\t\"resource\": {\r\n\t\t\"partner_order_id\": \"partner-id-12345\",\r\n\t\t\"order_code\": \"ABCDEFGHI\",\r\n\t\t\"status\": \"COMPLETED\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://partner-domain.com/webhook-url","urlObject":{"protocol":"https","path":["webhook-url"],"host":["partner-domain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"64c00ac8-cd34-4666-b3be-f29c91beff0c"},{"name":"Order shipment created","id":"570c8110-8a15-4aba-965c-b059473dff3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-signature","value":"abcdef","type":"text"},{"key":"type","value":"order:shipment:created","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"type\": \"order:shipment:created\",\r\n\t\"created_at\": \"2025-04-16T12:50:11.615120283+07:00\",\r\n\t\"resource\": {\r\n\t\t\"partner_order_id\": \"partner-id-12345\",\r\n\t\t\"order_code\": \"ABCDEFGHI\",\r\n\t\t\"shipping_carrier\": \"USPS\",\r\n\t\t\"tracking_number\": \"1234567890123456789012\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://partner-domain.com/webhook-url","urlObject":{"protocol":"https","path":["webhook-url"],"host":["partner-domain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"570c8110-8a15-4aba-965c-b059473dff3b"},{"name":"Order shipment status changed","id":"b5332790-c5a2-4258-9c88-8c5545b0ca75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-signature","value":"abcdef","type":"text"},{"key":"type","value":"order:shipment:status","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"type\": \"order:shipment:status\",\r\n\t\"created_at\": \"2025-04-16T12:50:11.615120283+07:00\",\r\n\t\"resource\": {\r\n\t\t\"partner_order_id\": \"partner-id-12345\",\r\n\t\t\"order_code\": \"ABCDEFGHI\",\r\n\t\t\"tracking_status\": \"Delivered\",\r\n\t\t\"tracking_number\": \"1234567890123456789012\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://partner-domain.com/webhook-url","urlObject":{"protocol":"https","path":["webhook-url"],"host":["partner-domain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b5332790-c5a2-4258-9c88-8c5545b0ca75"},{"name":"Order payment pending","id":"970e8147-6665-403c-a36c-765cdca981e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-signature","value":"abcdef","type":"text"},{"key":"type","value":"order:payment:pending","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"type\": \"order:payment:pending\",\r\n\t\"created_at\": \"2025-04-23T15:40:27.829409256+07:00\",\r\n\t\"resource\": {\r\n\t\t\"partner_order_id\": \"partner-id-12345\",\r\n\t\t\"order_code\": \"ABCDEFGHI\",\r\n\t\t\"payment_status\": \"PENDING\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://partner-domain.com/webhook-url","urlObject":{"protocol":"https","path":["webhook-url"],"host":["partner-domain","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"970e8147-6665-403c-a36c-765cdca981e1"}],"id":"8bff1546-fccf-43ab-ad6a-494f78229b18","description":"Using Webhooks allows you to receive notifications about certain events, i.e an order is created.
\nWhen an event occurs, FlashShip server will make a POST request to your defined URL that will contain a JSON object in the request body. Your server has to respond with HTTP status 200 OK, otherwise, the request will be retried 4 times, each after 5 minutes interval. After the 4th time, the message will be discarded. Continued webhook delivery failures may result in temporarily disabling your webhooks for 1 hour.
Signature:
\nx-signature on a webhook's headers can be used to verify that a webhook came from FlashShip, calculated using HMAC SHA-256 algorithm with the request json payload and the webhook secret:
\n\n\nx-signature = HmacSHA256(payload_json, webhook_secret)
\n
Webhook event types:
Seller can use value of \"type\" in request header to identify type of webhook events. FlashShip will deliver the following webhook events:
order:created - a new order has been created.
\norder:status:updated - the status of an order has changed, for example from IN-PRODUCING to COMPLETED.
\norder:shipment:created - when FlashShip retreives tracking_number from your link_label url, or when a shipping label is created, FlashShip will send the tracking number.
\norder:shipment:status - when the delivery status of the package changes: Pre-Shipment, In Transit, Delivered
\norder:payment:pending - payment status of the order has changed to PENDING.
\nTo set up webhooks, use API requests described below:
\n","_postman_id":"8bff1546-fccf-43ab-ad6a-494f78229b18"}],"event":[{"listen":"prerequest","script":{"id":"88aedd41-02c0-41a5-9bda-97c421eba616","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"422b1a9e-72a3-405a-a8a0-5d38a5cd1957","type":"text/javascript","exec":[""]}}],"variable":[{"key":"username","value":"test","type":"string"},{"key":"password","value":"@Test123","type":"string"},{"key":"order_code","value":"KXILCU5MK"}]}