{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7ce33a2e-ef7d-472d-8bff-1ee81c94243d","name":"API Logistic","description":"# API Logistic\n\nThis API collection is designed specifically for logistics 3PL (Third-Party Logistics) partners who wish to integrate with Forstok's omni-channel marketplace platform. It enables seamless communication and data exchange between logistics providers and Forstok, supporting efficient order fulfillment and shipment tracking.\n\n\n\n## Intended Audience\n\nThis collection is intended for technical teams at logistics 3PL companies who are responsible for integrating their systems with Forstok to automate and streamline order processing, shipment updates, and delivery notifications.\n\n## Main Use Cases\n\n- **Order Integration:** Retrieve and manage order details from Forstok's marketplace to initiate fulfillment processes.\n \n- **AWB (Air Waybill) Updates:** Update AWB numbers and booking codes for orders, ensuring accurate shipment tracking.\n \n- **Shipment Status Updates:** Notify Forstok of shipment status changes (e.g., shipped, delivered, cancelled, failed delivery, completed) to keep order statuses in sync.\n \n- **Webhook Management:** Register, update, and manage webhook callback URLs to receive real-time notifications about order events, such as shipment creation or status changes.\n \n- **Security:** Set and manage webhook security keys to ensure secure communication between Forstok and logistics partners.\n \n\n## Getting Started\n\n1. **Authentication:** Obtain an access token using the provided authentication endpoints. All API requests require a valid token.\n \n2. **API Endpoints:** Use the endpoints in this collection to perform order-related operations, update shipment information, and manage webhooks.\n \n3. **Webhooks:** Register your callback URLs to receive automated notifications for key order events.\n \n\nFor detailed parameter descriptions and example requests, refer to the documentation within each request in this collection.\n\nFor further support or onboarding, please contact the Forstok integration team.\n\n---\n\n### **3PL Account Integration with Forstok**\n\nThis API process is used to connect a 3PL (Third-Party Logistics) account with a Forstok user account.\n\n---\n\n### **Integration Flow**\n\n1. The user must be **logged in to Forstok** before performing the integration.\n \n - If the user is not logged in, they will be redirected to the login page automatically.\n \n2. Open the integration URL below to begin the authorization process:\n \n\n```\nhttps://accounts.forstok.com/integration/logistic?userid={{3PL_account_email}}&scope=webhook_logistic,manage_webhook_logistic,manage_order_logistic&callback_url={{callback_url}}&channel_id={{channel_3PL_id}}&access_token={{access_token}}\n\n ```\n\n| Parameter | Description |\n| --- | --- |\n| `userid` | Email of the 3PL account that will be integrated |\n| `scope` | List of permissions required for integration: `webhook_logistic`, `manage_webhook_logistic`, `manage_order_logistic` |\n| `callback_url` | URL endpoint that will receive the response after authentication |\n| `channel_id` | The channel ID assigned to the 3PL integration |\n| `access_token` | Token required to authorize integration |\n\n---\n\n### **Callback Response**\n\nOnce authentication is successfully completed, Forstok will send a request to your `callback_url` with the following additional parameters:\n\n| Parameter | Description |\n| --- | --- |\n| `profile_id` | Unique ID of the user profile in Forstok |\n| `profile_name` | Name of the Forstok user profile |\n\n## Forstok Master Courier\n\n[https://docs.google.com/spreadsheets/d/1rbTrvEd2yc91EEBMz_jA4G5DDc84jZ0zcie5Hx6Sv64/edit?usp=sharing](https://docs.google.com/spreadsheets/d/1rbTrvEd2yc91EEBMz_jA4G5DDc84jZ0zcie5Hx6Sv64/edit?usp=sharing)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"8187389","team":319636,"collectionId":"7ce33a2e-ef7d-472d-8bff-1ee81c94243d","publishedId":"2sB3QRp7an","public":true,"publicUrl":"https://apilogistic.forstok.com","privateUrl":"https://go.postman.co/documentation/8187389-7ce33a2e-ef7d-472d-8bff-1ee81c94243d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-10-23T03:37:13.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/1aba82988a6e14999f9bcd2259fd3012a734c82d7ec222fe79118f233557bf85","favicon":"https://forstok.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://apilogistic.forstok.com/view/metadata/2sB3QRp7an"}