{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"55ed7ee5-9b45-47ea-a196-f438ff98aa98","name":"3PL Systems, Inc. - Public API Collection","description":"Welcome to the 3PL Systems, Inc. API Postman collection. In this collection, you will find our publicly available API suite that includes shipment, customer, carrier, and accounting management. This Postman collection does not provide access to all available APIs. 3PL Systems, Inc. will provide access to other APIs not included in this documentation upon request.\n\nIn order to gain access to the API, you will first need to gain access to the API keys. These keys are either provided by 3PL Systems, Inc. or the freight brokerage that you're integrating with directly.\n\nIn the event you have any questions, feel free to email our support team at [Support@3plsystems.com](https://mailto:Support@3plsystems.com)\n\n<u><b>Configuration</b></u>\n\nThere are variables already set within the project that you will need to fill out in order to interact with the API endpoints. There are two types of credentials, shipper and system. The shipper credentials are for those looking to interact with the 'Shipper Access Endpoints' and the system credentials are for those looking to interact with the 'Global System' and 'Brokerware Accounting' endpoints.\n\n**PLEASE COMPARE YOUR RESULTS IN THE API TO THE SYSTEM OF ORIGIN. THE RESULTS RETURNED IN THE API ARE THE RESPONSIBILITY OF THE ENGINEER INTEGRATING THEM INTO THEIR APPLICATIONS. CUSTOM INTEGRATIONS CAN RETURN UNKNOWN RESULTS BASED ON YOUR CONFIGURATION.**\n\n**Available Variables**\n\n- baseUrl\n    \n    - The baseURL is the URL that points to the system that you're trying to integrate with. This URL can be provided to you by the company you're trying to push or pull information from.\n        \n- Client Credentials\n    \n    - The below credentials are generated directly from the Customer Profile on the staff side of the application under 'Customer Tools'. These credentials can be accessed and generated from 'API Keys'.\n        \n        - ClientIdClient\n            \n        - ClientSecretClient\n            \n- Global Credentials\n    \n    - The below credentials are generated directly from the 'General Information' page accessed in the upper right hand corner of the system by an Admin. You will find the API key button in the bottom left hand area of the 'General Information' page.\n        \n        - Credentials:\n            \n            - ClientIdGlobal\n                \n            - ClientSecretGlobal\n                \n\n### CreateShipmentApiModel\n\n- **PickupDate** (DateTime)\n    \n- **PickupOpenTime** (DateTime)\n    \n- **PickupCloseTime** (DateTime)\n    \n- **EstimatedDelivery** (DateTime)\n    \n- **EstimatedDeliveryOpenTime** (DateTime)\n    \n- **EstimatedDeliveryCloseTime** (DateTimel)\n    \n- **DeliveryDate** (DateTime)\n    \n- **ShipperPickupArrival** (DateTime)\n    \n- **ShipperPickupDeparture** (DateTime)\n    \n- **ConsigneeDeliverArrival** (DateTime)\n    \n- **ConsigneeDeliverDeparture** (DateTime)\n    \n- **Source** (String; Max: 100 characters)\n    \n- **PickupNumber** (String; Max: 50 characters)\n    \n- **PoReference** (String; Max: 50 characters)\n    \n- **ShipperNumber** (String; Max: 100 characters)\n    \n- **ShipperAddress** (String)\n    \n- **ShipperAddress2** (String; Max: 50 characters)\n    \n- **ShipperCity** (String; Max: 50 characters)\n    \n- **ShipperName** (String; Max: 50 characters)\n    \n- **ShipperContact** (String; Max: 50 characters)\n    \n- **ShipperEmail** (String; Max: 50 characters)\n    \n- **ShipperPhone** (String; Max: 50 characters)\n    \n- **ShipperFax** (String; Max: 50 characters)\n    \n- **ShipperLocationCode** (String)\n    \n- **ConsigneeAddress** (String)\n    \n- **ConsigneeAddress2** (String; Max: 50 characters)\n    \n- **ConsigneeState** (String; Max: 50 characters)\n    \n- **ConsigneeCity** (String; Max: 50 characters)\n    \n- **ConsigneeName** (String; Max: 50 characters)\n    \n- **ConsigneeContact** (String; Max: 50 characters)\n    \n- **ConsigneeEmail** (String; Max: 50 characters)\n    \n- **ConsigneePhone** (String; Max: 50 characters)\n    \n- **ConsigneeFax** (String; Max: 50 characters)\n    \n- **ConsigneeLocationCode** (String)\n    \n- **IsConsigneeCitySpecified** (Boolean)\n    \n- **IsShipperCitySpecified** (Boolean)\n    \n- **ReferenceNumber** (String; Max: 50 characters)\n    \n- **BillOfLandingNote** (String; Max: 2000 characters)\n    \n- **PalletCount** (Int32)\n    \n- **ShipmentValue** (Decimal)\n    \n- **Carrier** (CreateShipmnetCarrier; Custom class)\n    \n- **ShipmentStatus** (String)\n    \n- **CustomFields** (List; Custom class list)\n    \n- **BillToCode** (Int32?; Optional)\n    \n- **BuyerClientLoadId** (Int32?; Optional)\n    \n- **AssignTo** (String)\n    \n- **Test** (Boolean)\n    \n- **IsUpdateIfDuplicatedReferenceNumber** (Boolean)\n    \n- **IsPalletized** (Boolean)\n    \n- **NumberOfPallets** (Int32)\n    \n\n### CustomField\n\n- **FieldName** (String)\n    \n- **FieldValue** (String)\n    \n\n### CreateShipmnetCarrier\n\n- **CarrierScac** (String; Max: 10 characters)\n    \n- **ProviderScac** (String; Max: 10 characters)\n    \n- **ProNumber** (String; Max: 50 characters)\n    \n- **RateQuoteId** (String)\n\n\n\n### Webhooks\n\nTo be notified of load status changes instead of polling, see the **Webhooks (Sent to You)** folder.\n\n### Hazardous materials\n\nSet `isHazardous: true` on an item, then add these item fields as needed. The API doesn't enforce which ones are required, so send everything your carriers need.\n\n- **hazardUnNumber** (String; Max: 50 characters): UN/NA number\n- **isUnNumber** (Boolean): `true` = UN number, `false` = NA number\n- **properShippingName** (String; Max: 100 characters)\n- **hazardClass** (Decimal; e.g. 3 or 2.1)\n- **subsidiaryHazardClass** (Decimal)\n- **hazardSubCategoryCode** / **subsidiaryHazardSubCategoryCode** (String; Max: 20 characters)\n- **hazardPackagingGroup** (`I`, `II`, `III` or `None`)\n- **hazardContactName** (String; Max: 100 characters), **hazardContactNumber** (String; Max: 50 characters): emergency contact\n- **hazardContractNumber** (String; Max: 50 characters)\n- **hazardChemicalName** (String)\n- **hazardMarkAsLimitedQty** (Boolean)\n- **netExplosiveMass** (Decimal)\n\nOther item fields: **unitsWeight** (`LB` default, `KG`, `TONS`), **unitsDimension** (`Inches` default, `Feet`, `Meters`, `Yards`, `Centimeters`), **pcf** (calculated from weight and dimensions when 0), **sealNumber**, **containerNumber**, **pickupStopSequence** / **dropStopSequence** (multi-stop).\n\n### Load numbers\n\nEvery `loadId` / `loadid` parameter and field means the **load number** shown in the application, not an internal ID.\n\n### API versions\n\nEndpoints accept a version in the path, for example `/api/v1.4/RatingWithRateQuoteId` or `/api/clientv1.2/CreateShipmentAPI`. `/api/v1` and `/api/clientv1` keep the original behavior. Each version includes the changes of the versions before it, and `v2` includes all of them.\n\n| Version | Change |\n|---|---|\n| `v1.1` | **Get Loads:** `carriers[]` describes the carrier actually hauling the load (name, MC number, address, phone, `carrierScac`), and `providerName`/`carrierCode` are `null`. On `v1` they describe the billing carrier and `providerName` holds the provider. |\n| `v1.2` | **Rating and create shipment:** when any item's `packaging` is `Pallets`, the load is marked palletized, and `numberOfPallets` defaults to the total pieces on those items. |\n| `v1.3` | **Rating and create shipment:** for accounts using Shiplify, location accessorials for the shipper and consignee (for example liftgate) are added automatically. |\n| `v1.4` | **Get Carrier Rates W/ Rate Breakdown and Create Shipment with RateIDGuid:** multi-stop `shipmentAddresses`, address book location codes and the stop note fields are used for rating and booking. Below `v1.4` they are ignored there, and the load is rated shipper to consignee. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"60273494","team":1352324,"collectionId":"55ed7ee5-9b45-47ea-a196-f438ff98aa98","publishedId":"2sBYHbsc3e","public":true,"publicUrl":"https://documenter-api.postman.tech/view/60273494/2sBYHbsc3e","privateUrl":"https://go.postman.co/documentation/60273494-55ed7ee5-9b45-47ea-a196-f438ff98aa98","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.12.12","publishDate":"2026-11-19T02:45:37.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://postman-image-service.postman.com/api/cloudinary-proxy/postman/image/upload/t_team_logo_pubdoc/v1/team/2689fbaf4d270cb571e21b17bc3d8248daeeae73e44bbb29f6d35a41451e3dfb","favicon":""},"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://documenter.gw.postman.com/view/metadata/2sBYHbsc3e"}