openapi: 3.0.0 info: version: 2.0.0 title: A guide to C.H. Robinson's REST APIs description: " \n# Introduction \nWelcome to C.H. Robinson's API reference page! \n\nOur modern REST APIs enable partners to leverage the vast C.H. Robinson transportation and supply chain expertise and technology capabilities. C.H. Robinson APIs bring everything you love about our business directly into your ERP or TMS system. \n### **How we drive customer success:** \n* Allow our customers to retrieve real-time quotes, and if desired, turn those quotes into orders. \n* Customers can submit, update, and delete orders. \n* Provide our customers with real-time order and shipment tracking events. \n* Allow customers to retrieve summary and detail invoice data while also providing the physical invoice document. \n* Allow customers to retrive any documents needed for their orders and shipments. \n\n **For the customers interested in starting the onboarding process please click here.** \n### **How we drive carrier connectivity:** \n* Allow carriers to search the C.H. Robinson available shipment store. \n* Allow carriers to make offers on loads from the available shipment store. \n* Allow carriers to book loads from the available shipment store when there are load costs attached. \n* Allow carriers to provide stop and location updates on the load(s) they are transporting. \n* Allow carriers to post relevant documents directly to C.H. Robinson. \n* We provide Load Details through a callback upon booking to allow carriers to electronically build the load in their TMS platform. \n\n **For the carriers interested in starting the onboarding process please click here.**" servers: - url: https://sandbox-api.navisphere.com description: Test environment. - url: https://api.navisphere.com description: Production environment. security: - sandbox: [] tags: - name: Resources description: "Public Postman Collection \n\n Clicking this link will open an additional tab - select 'save as' from your browser, and import the downloaded file into Postman" - name: Authentication description: "\nC.H. Robinson uses OAuth v2.0 to secure connections to its APIs. oAuth v2 works by delegating user authentication to the service that hosts the user account and authorizing third-party applications to access the user account. For a user to authenticate and use any of C.H. Robinson's APIs, the user must [generate a token](https://developer.chrobinson.com/api-reference#operation/Generate%20Token). \n\n **Special Note** \n\n Generated tokens are valid for 24 hours. Users should only be hitting the C.H. Robinson authentication endpoint once every 24 hours. Calling the authentication endpoint multiple times within the same 24 hour period may result in users being subjected to rate limiting. \n\nClick the image to open it in a new tab to resize it.\n\n\"Authorization" - name: Rating description: "C.H. Robinson's rating product allows our customers to retrieve contractual or transactional quotes. Customers can generate quotes with nothing more than weights and zip codes! However, the more detailed the rate request, the more refined the quote is. C.H. Robinson has taken this functionality a step further and can accommodate our customer's e-commerce platforms to be the rating engine they use to give their customers shipping costs. One of the great features of C.H. Robinson's rating API is the ability for customers to turn the received quote into an order. \n## Rating and Quote to Order \n\nTo maximize the quote to order experience, we require more information than the bare minimum required parameters. Each parameter that has these \"conditional\" requirements has been specifically called out in the parameter description.\n See [Order Create With Quote ID](https://developer.chrobinson.com/api-reference#operation/Order%20Create%20with%20Quote%20ID) to learn more about the Quote to Order process. \n\n #### Notes: \n * **Multi-Stop Shipments:** For shipments with more than two stops (that is more than one pick and one drop), the Order Create with Quote ID endpoint can receive only a quote ID and no other supplemental shipment data. \n * **Incomplete Orders:** Orders created in C.H. Robinson's Navisphere® Order Management system will be marked as incomplete if any data fields marked as “required” are not included. Incomplete orders will require manual intervention by C.H. Robinson team members to be processed. \n## Rating and Order Create \n\nAlternatively, you may also use the rating endpoint to retrieve a quote and use the Order Create method to complete the resulting order tender into C.H. Robinson. Please review the Rating Workflow Options Guide to understand the advantages and tradeoffs between the Order Create and Order Create with QuoteID workflows. \n## Rating and Transactional Truckload Quotes \n\nOur rating API can provide Real-time Transactional truckload quotes. These are also known as Spot-Bid quotes or market rates. Please review the Transactional Truckload and Equipment Handling Guide for more detail. \n## Density Based Freight Classification \n\nThe NMFTA (National Motor Freight Traffic Association) publishes the NMFC (National Motor Freight Classification) which is a standard for evaluating product classifications for use in transportation. There are four transportation characteristics that are used to determine product classifications: \n * Density \n * Stowability \n * Handling \n * Liability \nIn many instances, all four characteristics hold equal weight in determining the product's classification. However, in some instances, one characteristic can hold more weight than the other. For those commodities that use Density as the primary determining factor for freight classification, C.H. Robinson provides a service for retrieving the estimated classification, based solely on density, for further use in the actual rate requests." - name: Orders and Booking description: "C.H. Robinson’s Orders and Bookings products are the starting point for all freight execution in Navisphere®. They provide a unified gateway for customers to submit and manage shipment and booking details—whether leveraging C.H. Robinson’s brokerage services or using Navisphere® for tracking and transportation management." - name: Events description: | C.H. Robinson's Events product gives complete, near real-time order and shipment information, including all transportation updates. Integrating with C.H. Robinson's Events API give partners near visibility into their supply chain directly to their own TMS or ERP system. There are two ways to integrate with C.H. Robinson events: via a callback/webhook (preferred and most real-time) or via a periodic event retrieval (easiest to implement and less real-time). - name: Visibility description: "Navisphere® Vision and Visibility tool is a global visibility technology that allows select customers to view and proactively manage their supply chain movements from a single platform. The tool combines real-time order and shipment information with transportation updates and external factors that can influence a supply chain, including weather, traffic, and current events to help customers prevent potential disruptions." - name: Shipments description: "C.H. Robinson's Shipments product allows our partner base to access C.H. Robinson's available shipments, send offers on those shipments, and book those shipments. Additionally, our partners can update C.H. Robinson on any shipments that C.H. Robinson is responsible for, as well as view status of payment." - name: Financials description: "C.H. Robinson's financial product provides customers and carriers insight into their invoicing. \n\nCurrently, customers can retrieve their invoice information from the Financials product. C.H. Robinson gives customers the ability to retrieve all active invoices in a single call along with the flexibility to retrieve detailed information from each invoice if desired. \n\n Carries can use C.H. Robinsons Financials product to check the status of payment for invoices they have submitted." - name: Documents description: "C.H. Robinson's Documents product allows our partners to generate, post, and retrieve documents. C.H. Robinson currently offers customers the ability to generate blank BOLs and retrieve signed BOLs, PODs, and Lumper receipts. Additionally, carriers can post documents to their shipments." #- name: Purchase Orders # description: "Purchase Order (PO management) is a service that combines reporting capabilities through our single global technology platform, Navisphere®, and operational # expertise through skilled people who understand our customers' perspective and the logistics industry at large." - name: Labels description: "A service for generating small parcel shipping labels. An associated C.H. Robinson order is also created to track the package updates through Navisphere®. Note: Configuration of your company’s parcel carrier account details within Navisphere® is required as a prerequisite for using this API. Contact your C.H. Robinson or TMC account representative to begin this process." paths: #---Authentication--------------------------------------------------------------------------------------- /v1/oauth/token: post: description: Allows partner to retrieve their own auth token. operationId: Generate Token security: [] tags: - Authentication requestBody: description: generate auth token required: true content: application/json: schema: $ref: '#/components/schemas/tokenRequest' application/ x-www-form-urlencoded: schema: $ref: '#/components/schemas/tokenRequest' x-code-samples: - lang: Curl source: "curl -X POST \\ \n https://sandbox-api.navisphere.com/v1/oauth/token \\ \n -H 'Content-Type: application/json' \\ \n -d '{ \n \"client_id\": \"Your Client ID\", \n \"client_secret\": \"Your Client Secret\", \n \"audience\": \"https://inavisphere.chrobinson.com\", \n \"grant_type\": \"client_credentials\" \n }'" - lang: Java source: "HttpResponse response = Unirest.post(\"https://sandbox-api.navisphere.com/v1/oauth/token\") \n .header(\"Content-Type\", \"application/json\") \n .body(\"{\n \"client_id\": \"Your Client ID\",\n \"client_secret\": \"Your Client Secret\",\n \"audience\": \"https://inavisphere.chrobinson.com\",\n \"grant_type\": \"client_credentials\"\n}\") \n .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'POST', \n url: 'https://sandbox-api.navisphere.com/v1/oauth/token', \n headers: { 'Content-Type': 'application/json' }, \n body: { \n \tclient_id: 'Your Client ID', \n \tclient_secret: 'Your Client Secret', \n \taudience: 'https://inavisphere.chrobinson.com', \n \tgrant_type: 'client_credentials' \n }, \n json: true }; \n\n request(options, function (error, response, body) { \n \tif (error) throw new Error(error); \n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/oauth/token\"); \n var request = new RestRequest(Method.POST); \n request.AddHeader(\"Content-Type\", \"application/json\"); \n request.AddParameter(\"undefined\", \n \"{\n \"client_id\": \"Your Client ID\",\n \"client_secret\": \"Your Client Secret\",\n \"audience\": \"https://inavisphere.chrobinson.com\",\n \"grant_type\": \"client_credentials\"\n}\", ParameterType.RequestBody); \n IRestResponse response = client.Execute(request);" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/tokenSuccessResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact you C.H. Robinson rep. #---Rating----------------------------------------------------------------------------------------------- /v1/quotes: post: description: "Allows partner to generate quote from posted shipment information." operationId: Rating Request tags: - Rating requestBody: description: JSON object of shipment information. required: true content: application/json: schema: $ref: '#/components/schemas/ratingPost' examples: Payload: value: items: - description: widgets freightClass: 400 weight: 250 weightUnitOfMeasure: Pounds packagingLength: 24 packagingWidth: 10 packagingHeight: 10 packagingUnitOfMeasure: Inches pallets: 1 quantity: 1 palletSpaces: 1 packagingVolume: 3 packagingVolumeUnitOfMeasure: CubicFeet density: 25 linearSpace: 8 insuranceValue: 50000 packagingType: BIN productCode: wdgt temperatureType: Dry temperatureUnit: Fahrenheit requiredTemperatureHigh: 85 requiredTemperatureLow: 35 unitsPerPallet: 36 unitWeight: 14 unitVolume: 3 isStackable: 'true' isOverWeightOverDimensional: 'false' isUsedGood: 'false' isHazardous: 'false' hazardousDescription: Car Battery hazardousEmergencyPhone: '5555555555' nationalMotorFreightClass: '156600' upcNumber: '1234567890' skuNumber: 01234-001-F10-6 pluNumber: '4026' pickupSequenceNumber: 1 dropSequenceNumber: 2 referenceNumbers: - type: PO value: PO12345 unNumber: UN2796 packagingGroup: I hazmatClassCode: '8' origin: name: Origin Location address1: 14800 Charlson Rd address2: Building 1 address3: Room 212 city: Eden Prairie stateProvinceCode: MN countryCode: US postalCode: '55347' openDateTime: 2022-01-28T13:00:00.000Z closeDateTime: 2022-01-28T21:00:00.000Z latitude: 31.717096 longitude: -99.132553 specialRequirement: liftGate: 'false' insidePickup: 'false' residentialNonCommercial: 'false' limitedAccess: 'false' tradeShoworConvention: 'false' constructionSite: 'false' dropOffAtCarrierTerminal: 'false' hasDropTrailer: 'true' isPort: 'false' unLocode: US AC8 iata: ACB customerLocationId: '541849' sequenceNumber: 1 referenceNumbers: - type: PU value: PickUpNumber1 destination: name: Destination Location address1: 800 Washington Avenue North address2: Building 1 address3: Suite 550 city: Minneapolis stateProvinceCode: MN countryCode: US postalCode: '55401' openDateTime: 2022-01-29T13:00:00.000Z closeDateTime: 2022-01-29T21:00:00.000Z latitude: 44.989386 longitude: -93.278626 specialRequirement: liftGate: 'false' insidePickup: 'false' insideDelivery: 'false' residentialNonCommercial: 'false' limitedAccess: 'false' tradeShoworConvention: 'false' constructionSite: 'false' dropOffAtCarrierTerminal: 'false' pickupAtCarrierTerminal: 'false' hasDropTrailer: 'true' isPort: 'false' unLocode: US AC8 iata: ACB customerLocationId: '948145' sequenceNumber: 3 referenceNumbers: - type: DEL value: DeliverNumber1 additionalLocations: - name: Additional Location address1: 800 Washington Avenue North address2: Building 1 address3: Suite 550 city: Minneapolis stateProvinceCode: MN countryCode: US postalCode: '55401' latitude: 44.989386 longitude: -93.278626 openDateTime: 2022-01-29T13:00:00.000Z closeDateTime: 2022-01-29T21:00:00.000Z specialRequirement: liftGate: 'false' insidePickup: 'false' insideDelivery: 'false' residentialNonCommercial: 'false' limitedAccess: 'false' tradeShoworConvention: 'false' constructionSite: 'false' dropOffAtCarrierTerminal: 'false' pickupAtCarrierTerminal: 'false' dropTrailer: 'false' isPort: 'false' unLocode: US AC8 iata: ACB customerLocationId: '948145' sequenceNumber: 2 referenceNumbers: - type: DEL value: DeliverNumber1 shipDate: 2026-09-05T19:05:18.768Z platform: 5FF4892D-17C4-4D4D-A958-9784D3124 transactionId: "1234567899456" customerCode: C8283603 transportModes: - mode: LTL equipments: - equipmentType: Van quantity: 1 referenceNumbers: - type: "MBOL" value: MBOL12345 optionalAccessorials: - EXL Minimum: value: items: - actualWeight: 40000 weightUnit: Pounds origin: countryCode: US postalCode: '55347' destination: countryCode: US postalCode: '33830' shipDate: 2026-09-05T19:05:18.768Z customerCode: C8283603 transportModes: - mode: TL Minimum for Q2O: value: items: - freightClass: 400 weight: 250 weightUnitOfMeasure: Pounds insuranceValue: 50000 packagingCode: BIN productCode: wdgt origin: name: Origin Location address1: 14800 Charlson Rd city: Eden Prairie stateProvinceCode: MN countryCode: US postalCode: '55347' destination: name: Destination Location address1: 800 Washington Avenue North city: Minneapolis stateProvinceCode: MN countryCode: US postalCode: '55401' shipDate: "2026-09-05T19:05:18.768Z" customerCode: "C8283603" transportModes: - mode: LTL x-code-samples: - lang: Curl source: "curl -X POST \\ \n https://sandbox-api.navisphere.com/v1/quotes \\\n -H 'Authorization: Bearer YOUR TOKEN' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \t\"items\": [{ \n \t\t\"description\": \"widgets\",\n \t\t\"freightClass\": 400,\n \t\t\"actualWeight\": 250,\n \t\t\"weightUnit\": \"Pounds\",\n \t\t\"length\": 24,\n \t\t\"width\": 10,\n \t\t\"height\": 10,\n \t\t\"linearUnit\": \"Inches\",\n \t\t\"pallets\": 1,\n \t\t\"pieces\": 1,\n \t\t\"palletSpaces\": 1,\n \t\t\"volume\": 3,\n \t\t\"volumeUnit\": \"CubicFeet\",\n \t\t\"density\": 25,\n \t\t\"linearSpace\": 8,\n \t\t\"declaredValue\": 50000,\n \t\t\"packagingCode\": \"BIN\",\n \t\t\"productCode\": \"wdgt\",\n \t\t\"productName\": \"widgets\",\n \t\t\"temperatureSensitive\": \"Dry\",\n \t\t\"temperatureUnit\": \"Fahrenheit\",\n \t\t\"requiredTemperatureHigh\": 85,\n \t\t\"requiredTemperatureLow\": 35,\n \t\t\"unitsPerPallet\": 36,\n \t\t\"unitWeight\": 14,\n \t\t\"unitVolume\": 3,\n \t\t\"isStackable\": \"true\",\n \t\t\"isOverWeightOverDimensional\": \"false\",\n \t\t\"isUsedGood\": \"false\",\n \t\t\"isHazardous\": \"false\",\n \t\t\"hazardousDescription\": \"Car Battery\",\n \t\t\"hazardousEmergencyPhone\": \"5555555555\",\n \t\t\"nmfc\": \"156600\",\n \t\t\"upc\": \"1234567890\",\n \t\t\"sku\": \"01234-001-F10-6\",\n \t\t\"plu\": \"4026\",\n \t\t\"referenceNumbers\": [{ \n \t\t\t\"type\": \"PO\",\n \t\t\t\"value\": \"PO12345\"\n \t\t}],\n \t\t\"unNumber\": \"UN2796\",\n \t\t\"packagingGroup\": \"I\",\n \t\t\"hazmatClass\": \"8\"\n \t}],\n \t\"origin\": { \n \t\t\"locationName\": \"Origin Location\",\n \t\t\"address1\": \"14800 Charlson Rd\",\n \t\t\"address2\": \"Building 1\",\n \t\t\"address3\": \"Room 212\",\n \t\t\"city\": \"Eden Prairie\",\n \t\t\"stateProvinceCode\": \"MN\",\n \t\t\"countryCode\": \"US\",\n \t\t\"postalCode\": \"55347\",\n \t\t\"latitude\": 31.717096,\n \t\t\"longitude\": -99.132553,\n \t\t\"specialRequirement\": { \n \t\t\t\"liftGate\": \"false\",\n \t\t\t\"insidePickup\": \"false\",\n \t\t\t\"insideDelivery\": \"false\",\n \t\t\t\"residentialNonCommercial\": \"false\",\n \t\t\t\"limitedAccess\": \"false\",\n \t\t\t\"tradeShoworConvention\": \"false\",\n \t\t\t\"constructionSite\": \"false\",\n \t\t\t\"dropOffAtCarrierTerminal\": \"false\",\n \t\t\t\"pickupAtCarrierTerminal\": \"false\" \t\t},\n \t\t\"isPort\": \"false\",\n \t\t\"unLocode\": \"US AC8\",\n \t\t\"iata\": \"ACB\",\n \t\t\"customerLocationId\": \"W541849\",\n \t\t\"referenceNumbers\": [{\n \t\t\t\"type\": \"PU\",\n \t\t\t\"value\": \"PickUpNumber1\" \t\t}]\n \t},\n \t\"destination\": {\n \t\t\"locationName\": \"Destination Location\",\n \t\t\"address1\": \"800 Washington Avenue North\",\n \t\t\"address2\": \"Building 1\",\n \t\t\"address3\": \"Suite 550\",\n \t\t\"city\": \"Minneapolis\",\n \t\t\"stateProvinceCode\": \"MN\",\n \t\t\"countryCode\": \"US\",\n \t\t\"postalCode\": \"55401\",\n \t\t\"latitude\": 44.989386,\n \t\t\"longitude\": -93.278626,\n \t\t\"specialRequirement\": {\n \t\t\t\"liftGate\": \"false\",\n \t\t\t\"insidePickup\": \"false\",\n \t\t\t\"insideDelivery\": \"false\",\n \t\t\t\"residentialNonCommercial\": \"false\",\n \t\t\t\"limitedAccess\": \"false\",\n \t\t\t\"tradeShoworConvention\": \"false\",\n \t\t\t\"constructionSite\": \"false\",\n \t\t\t\"dropOffAtCarrierTerminal\": \"false\",\n \t\t\t\"pickupAtCarrierTerminal\": \"false\"\n \t\t},\n \t\t\"isPort\": \"false\",\n \t\t\"unLocode\": \"US AC8\",\n \t\t\"iata\": \"ACB\",\n \t\t\"customerLocationId\": \"W541849\",\n \t\t\"referenceNumbers\": [{\n \t\t\t\"type\": \"DEL\",\n \t\t\t\"value\": \"DeliverNumber1\"\n \t\t}]\n \t},\n \t\"shipDate\": \"2019-03-20T20:30:00.0000000Z\",\n \t\"customerCode\": \"C8283603\",\n \t\"declaredValue\": 50000,\n \t\"transportModes\": [{ \n \t\t\"mode\": \"LTL\",\n \t\t\"equipments\": [{\n \t\t\t\"equipmentType\": \"Van\",\n \t\t\t\"quantity\": 1\n \t\t}]\n \t}],\n \t\"referenceNumbers\": [{\n \t\t\"type\": \"MBOL\",\n \t\t\"value\": \"MBOL12345\"\n \t}],\n \t\"optionalAccessorials\": [\"EXL\"] \n \t}'" - lang: Java source: "HttpResponse response = Unirest.post(\"https://sandbox-api.navisphere.com/v1/quotes\") .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOUR TOKEN\")\n .body(\"{\n \"items\": [\n {\n \"description\": \"widgets\",\n \"freightClass\": 400,\n \"actualWeight\": 250,\n \"weightUnit\": \"Pounds\",\n \"length\": 24,\n \"width\": 10,\n \"height\": 10,\n \"linearUnit\": \"Inches\",\n \"pallets\": 1,\n \"pieces\": 1,\n \"palletSpaces\": 1,\n \"volume\": 3,\n \"volumeUnit\": \"CubicFeet\",\n \"density\": 25,\n \"linearSpace\": 8,\n \"declaredValue\": 50000,\n \"packagingCode\": \"BIN\",\n \"productCode\": \"wdgt\",\n \"productName\": \"widgets\",\n \"temperatureSensitive\": \"Dry\",\n \"temperatureUnit\": \"Fahrenheit\",\n \"requiredTemperatureHigh\": 85,\n \"requiredTemperatureLow\": 35,\n \"unitsPerPallet\": 36,\n \"unitWeight\": 14,\n \"unitVolume\": 3,\n \"isStackable\": \"true\",\n \"isOverWeightOverDimensional\": \"false\",\n \"isUsedGood\": \"false\",\n \"isHazardous\": \"false\",\n \"hazardousDescription\": \"Car Battery\",\n \"hazardousEmergencyPhone\": \"5555555555\",\n \"nmfc\": \"156600\",\n \"upc\": \"1234567890\",\n \"sku\": \"01234-001-F10-6\",\n \"plu\": \"4026\",\n \"referenceNumbers\": [\n {\n \"type\": \"PO\",\n \"value\": \"PO12345\"\n }\n ]\n }\n ],\n \"origin\": {\n \"locationName\": \"Origin Location\",\n \"address1\": \"14800 Charlson Rd\",\n \"address2\": \"Building 1\",\n \"address3\": \"Room 212\",\n \"city\": \"Eden Prairie\",\n \"stateProvinceCode\": \"MN\",\n \"countryCode\": \"US\",\n \"postalCode\": \"55347\",\n \"latitude\": 31.717096,\n \"longitude\": -99.132553,\n \"specialRequirement\": {\n \"liftGate\": \"false\",\n \"insidePickup\": \"false\",\n \"insideDelivery\": \"false\",\n \"residentialNonCommercial\": \"false\",\n \"limitedAccess\": \"false\",\n \"tradeShoworConvention\": \"false\",\n \"constructionSite\": \"false\",\n \"dropOffAtCarrierTerminal\": \"false\",\n \"pickupAtCarrierTerminal\": \"false\"\n },\n \"isPort\": \"false\",\n \"unLocode\": \"US AC8\",\n \"iata\": \"ACB\",\n \"customerLocationId\": \"W541849\",\n \"referenceNumbers\": [\n {\n \"type\": \"PU\",\n \"value\": \"PickUpNumber1\"\n }\n ]\n },\n \"destination\": {\n \"locationName\": \"Destination Location\",\n \"address1\": \"800 Washington Avenue North\",\n \"address2\": \"Building 1\",\n \"address3\": \"Suite 550\",\n \"city\": \"Minneapolis\",\n \"stateProvinceCode\": \"MN\",\n \"countryCode\": \"US\",\n \"postalCode\": \"55401\",\n \"latitude\": 44.989386,\n \"longitude\": -93.278626,\n \"specialRequirement\": {\n \"liftGate\": \"false\",\n \"insidePickup\": \"false\",\n \"insideDelivery\": \"false\",\n \"residentialNonCommercial\": \"false\",\n \"limitedAccess\": \"false\",\n \"tradeShoworConvention\": \"false\",\n \"constructionSite\": \"false\",\n \"dropOffAtCarrierTerminal\": \"false\",\n \"pickupAtCarrierTerminal\": \"false\"\n },\n \"isPort\": \"false\",\n \"unLocode\": \"US AC8\",\n \"iata\": \"ACB\",\n \"customerLocationId\": \"W541849\",\n \"referenceNumbers\": [\n {\n \"type\": \"DEL\",\n \"value\": \"DeliverNumber1\"\n }\n ]\n },\n \"shipDate\": \"2019-03-20T20:30:00.0000000Z\",\n \"customerCode\": \"C8283603\",\n \"declaredValue\": 50000,\n \"transportModes\": [\n {\n \"mode\": \"LTL\",\n \"equipments\": [\n {\n \"equipmentType\": \"Van\",\n \"quantity\": 1\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"MBOL\",\n \"value\": \"MBOL12345\"\n }\n ],\n \"optionalAccessorials\": [\n \"EXL\"\n ]\n}\")\n .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'POST', \n url: 'https://sandbox-api.navisphere.com/v1/quotes', \n headers: \n { Authorization: 'Bearer YOUR TOKEN', \n 'Content-Type': 'application/json' },\n body: { \n \titems: [ { \n \t\tdescription: 'widgets',\n \t\tfreightClass: 400,\n \t\tweight: 250,\n \t\tweightUnitOfMeasure: 'Pounds',\n \t\tpackagingLength: 24,\n \t\tpackagingWidth: 10,\n \t\tpackagingHeight: 10,\n \t\tpackagingUnitOfMeasure: 'Inches',\n \t\tpallets: 1,\n \t\tquantity: 1,\n \t\tpalletSpaces: 1,\n \t\tpackagingVolume: 3,\n \t\tpackagingVolumeUnitOfMeasure: 'CubicFeet',\n \t\tdensity: 25,\n \t\tlinearSpace: 8,\n \t\tinsuranceValue: 50000,\n \t\tpackagingCode: 'BIN',\n \t\tproductCode: 'wdgt',\n \t\ttemperatureType: 'Dry',\n \t\ttemperatureUnit: 'Fahrenheit',\n \t\trequiredTemperatureHigh: 85,\n \t\trequiredTemperatureLow: 35,\n \t\tunitsPerPallet: 36,\n \t\tunitWeight: 14,\n \t\tunitVolume: 3,\n \t\tisStackable: 'true',\n \t\tisOverWeightOverDimensional: 'false',\n \t\tisUsedGood: 'false',\n \t\tisHazardous: 'false',\n \t\thazardousDescription: 'Car Battery',\n \t\thazardousEmergencyPhone: '5555555555',\n \t\tnationalMotorFreightClass: '156600',\n \t\tupcNumber: '1234567890',\n \t\tskuNumber: '01234-001-F10-6',\n \t\tpluNumber: '4026',\n \t\treferenceNumbers: [ { \n \t\t\ttype: 'PO',\n \t\t\tvalue: 'PO12345' \n \t\t} ], \n \t\tunNumber: 'UN2796',\n \t\tpackagingGroup: 'I',\n \t\thazmatClass: '8'\n \t} ],\n \torigin: {\n \t\tname: 'Origin Location',\n \t\taddress1: '14800 Charlson Rd',\n \t\taddress2: 'Building 1',\n \t\taddress3: 'Room 212',\n \t\tcity: 'Eden Prairie',\n \t\tstateProvinceCode: 'MN',\n \t\tcountryCode: 'US',\n \t\tpostalCode: '55347',\n \t\tlatitude: 31.717096,\n \t\tlongitude: -99.132553,\n \t\tspecialRequirement: { \n \t\t\tliftGate: 'false',\n \t\t\tinsidePickup: 'false',\n \t\t\tinsideDelivery: 'false',\n \t\t\tresidentialNonCommercial: 'false',\n \t\t\tlimitedAccess: 'false',\n \t\t\ttradeShoworConvention: 'false',\n \t\t\tconstructionSite: 'false',\n \t\t\tdropOffAtCarrierTerminal: 'false',\n \t\t\tpickupAtCarrierTerminal: 'false' \n \t\t},\n \t\tisPort: 'false',\n \t\tunLocode: 'US AC8',\n \t\tiata: 'ACB',\n \t\tcustomerLocationId: 'W541849',\n \t\treferenceNumbers: [ {\n \t\t\ttype: 'PU',\n \t\t\tvalue: 'PickUpNumber1'\n \t\t} ] \n \t},\n \tdestination:{\n \t\tname: 'Destination Location',\n \t\taddress1: '800 Washington Avenue North',\n \t\taddress2: 'Building 1',\n \t\taddress3: 'Suite 550',\n \t\tcity: 'Minneapolis',\n \t\tstateProvinceCode: 'MN',\n \t\tcountryCode: 'US',\n \t\tpostalCode: '55401',\n \t\tlatitude: 44.989386,\n \t\tlongitude: -93.278626,\n \t\tspecialRequirement: {\n \t\t\tliftGate: 'false',\n \t\t\tinsidePickup: 'false',\n \t\t\tinsideDelivery: 'false',\n \t\t\tresidentialNonCommercial: 'false',\n \t\t\tlimitedAccess: 'false',\n \t\t\ttradeShoworConvention: 'false',\n \t\t\tconstructionSite: 'false',\n \t\t\tdropOffAtCarrierTerminal: 'false',\n \t\t\tpickupAtCarrierTerminal: 'false'\n \t\t},\n \t\tisPort: 'false',\n \t\tunLocode: 'US AC8',\n \t\tiata: 'ACB',\n \t\tcustomerLocationId: 'W541849',\n \t\treferenceNumbers: [ {\n \t\t\ttype: 'DEL',\n \t\t\tvalue: 'DeliverNumber1' \n \t\t} ] \n \t},\n \tshipDate: '2019-03-20T20:30:00.0000000Z',\n \tcustomerCode: 'C8283603',\n \tdeclaredValue: 50000,\n \ttransportModes:[ { \n \t\tmode: 'LTL',\n \t\tequipments: [ { \n \t\t\tequipmentType: 'Van',\n \t\t\tquantity: 1 \n \t\t} ] \n \t} ],\n \treferenceNumbers: [ { \n \t\ttype: 'MBOL',\n \t\tvalue: 'MBOL12345'\n \t} ],\n \toptionalAccessorials: [ 'EXL' ] },\n \tjson: true };\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/quotes\");\n var request = new RestRequest(Method.POST)\n request.AddHeader(\"Authorization\", \"Bearer YOUR TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n request.AddParameter(\"undefined\", \"{\n \"items\": [\n {\n \"description\": \"widgets\",\n \"freightClass\": 400,\n \"actualWeight\": 250,\n \"weightUnit\": \"Pounds\",\n \"length\": 24,\n \"width\": 10,\n \"height\": 10,\n \"linearUnit\": \"Inches\",\n \"pallets\": 1,\n \"pieces\": 1,\n \"palletSpaces\": 1,\n \"volume\": 3,\n \"volumeUnit\": \"CubicFeet\",\n \"density\": 25,\n \"linearSpace\": 8,\n \"declaredValue\": 50000,\n \"packagingCode\": \"BIN\",\n \"productCode\": \"wdgt\",\n \"productName\": \"widgets\",\n \"temperatureSensitive\": \"Dry\",\n \"temperatureUnit\": \"Fahrenheit\",\n \"requiredTemperatureHigh\": 85,\n \"requiredTemperatureLow\": 35,\n \"unitsPerPallet\": 36,\n \"unitWeight\": 14,\n \"unitVolume\": 3,\n \"isStackable\": \"true\",\n \"isOverWeightOverDimensional\": \"false\",\n \"isUsedGood\": \"false\",\n \"isHazardous\": \"false\",\n \"hazardousDescription\": \"Car Battery\",\n \"hazardousEmergencyPhone\": \"5555555555\",\n \"nmfc\": \"156600\",\n \"upc\": \"1234567890\",\n \"sku\": \"01234-001-F10-6\",\n \"plu\": \"4026\",\n \"referenceNumbers\": [\n {\n \"type\": \"PO\",\n \"value\": \"PO12345\"\n }\n ],\n \"unNumber\": \"UN2796\",\n \"packagingGroup\": \"I\",\n \"hazmatClass\": \"8\"\n }\n ],\n \"origin\": {\n \"locationName\": \"Origin Location\",\n \"address1\": \"14800 Charlson Rd\",\n \"address2\": \"Building 1\",\n \"address3\": \"Room 212\",\n \"city\": \"Eden Prairie\",\n \"stateProvinceCode\": \"MN\",\n \"countryCode\": \"US\",\n \"postalCode\": \"55347\",\n \"latitude\": 31.717096,\n \"longitude\": -99.132553,\n \"specialRequirement\": {\n \"liftGate\": \"false\",\n \"insidePickup\": \"false\",\n \"insideDelivery\": \"false\",\n \"residentialNonCommercial\": \"false\",\n \"limitedAccess\": \"false\",\n \"tradeShoworConvention\": \"false\",\n \"constructionSite\": \"false\",\n \"dropOffAtCarrierTerminal\": \"false\",\n \"pickupAtCarrierTerminal\": \"false\"\n },\n \"isPort\": \"false\",\n \"unLocode\": \"US AC8\",\n \"iata\": \"ACB\",\n \"customerLocationId\": \"W541849\",\n \"referenceNumbers\": [\n {\n \"type\": \"PU\",\n \"value\": \"PickUpNumber1\"\n }\n ]\n },\n \"destination\": {\n \"locationName\": \"Destination Location\",\n \"address1\": \"800 Washington Avenue North\",\n \"address2\": \"Building 1\",\n \"address3\": \"Suite 550\",\n \"city\": \"Minneapolis\",\n \"stateProvinceCode\": \"MN\",\n \"countryCode\": \"US\",\n \"postalCode\": \"55401\",\n \"latitude\": 44.989386,\n \"longitude\": -93.278626,\n \"specialRequirement\": {\n \"liftGate\": \"false\",\n \"insidePickup\": \"false\",\n \"insideDelivery\": \"false\",\n \"residentialNonCommercial\": \"false\",\n \"limitedAccess\": \"false\",\n \"tradeShoworConvention\": \"false\",\n \"constructionSite\": \"false\",\n \"dropOffAtCarrierTerminal\": \"false\",\n \"pickupAtCarrierTerminal\": \"false\"\n },\n \"isPort\": \"false\",\n \"unLocode\": \"US AC8\",\n \"iata\": \"ACB\",\n \"customerLocationId\": \"W541849\",\n \"referenceNumbers\": [\n {\n \"type\": \"DEL\",\n \"value\": \"DeliverNumber1\"\n }\n ]\n },\n \"shipDate\": \"2019-03-20T20:30:00.0000000Z\",\n \"customerCode\": \"C8283603\",\n \"declaredValue\": 50000,\n \"transportModes\": [\n {\n \"mode\": \"LTL\",\n \"equipments\": [\n {\n \"equipmentType\": \"Van\",\n \"quantity\": 1\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"MBOL\",\n \"value\": \"MBOL12345\"\n }\n ],\n \"optionalAccessorials\": [\n \"EXL\"\n ]\n}\", ParameterType.RequestBody);\n IRestResponse response = client.Execute(request);" responses: 201: description: Request successful content: application/json: schema: $ref: '#/components/schemas/quoteSummaries' examples: ContractualQuote: value: quoteSummaries: - quoteId: 319782509 customer: {} totalCharge: 622.87 totalFreightCharge: 616.71 totalAccessorialCharge: 6.17 transit: minimumTransitDays: 1 maximumTransitDays: 2 rates: - rateId: 2962165757 totalRate: 6.17 unitRate: 6.17 quantity: 616.71 rateCode: '405' rateCodeValue: Fuel Surcharge currencyCode: USD isOptional: false - rateId: 2962165758 totalRate: 616.71 unitRate: 616.71 quantity: 1 rateCode: '400' rateCodeValue: Line Haul currencyCode: USD isOptional: false transportModeType: LTL equipmentType: Van quoteSource: MarketRate CarrierSelectQuote: value: quoteSummaries: - quoteId: 399662687 carrier: carrierCode: T5302800 carrierName: Forward Air, Inc. scac: FWDA totalCharge: 138.45 totalFreightCharge: 114.94 totalAccessorialCharge: 23.51 transit: minimumTransitDays: 1 originService: Direct destinationService: Direct rates: - rateId: 3738410707 totalRate: 114.94 unitRate: 114.94 quantity: 1 rateCode: '400' rateCodeValue: Line Haul currencyCode: USD isOptional: false - rateId: 3738410707 totalRate: 23.51 unitRate: 23.51 quantity: 1 rateCode: '405' rateCodeValue: Fuel Surcharge currencyCode: USD isOptional: false transportModeType: LTL equipmentType: Van quoteSource: MarketRate - quoteId: 399662689 carrier: carrierCode: T11765 carrierName: Averitt Express scac: AVRT totalCharge: 165.64 totalFreightCharge: 139.04 totalAccessorialCharge: 26.6 transit: minimumTransitDays: 1 originService: Direct destinationService: Direct rates: - rateId: 3738410708 totalRate: 139.04 unitRate: 139.04 quantity: 1 rateCode: '400' rateCodeValue: Line Haul currencyCode: USD isOptional: false - rateId: 3738410708 totalRate: 26.6 unitRate: 26.6 quantity: 1 rateCode: '405' rateCodeValue: Fuel Surcharge currencyCode: USD isOptional: false transportModeType: LTL equipmentType: Van quoteSource: MarketRate - quoteId: 399662690 carrier: carrierCode: T2080614 carrierName: UPS Freight scac: UPGF totalCharge: 179.44 totalFreightCharge: 157.6 totalAccessorialCharge: 21.84 transit: minimumTransitDays: 1 originService: Direct destinationService: Direct rates: - rateId: 3738410709 totalRate: 157.6 unitRate: 157.6 quantity: 1 rateCode: '400' rateCodeValue: Line Haul currencyCode: USD isOptional: false - rateId: 3738410709 totalRate: 21.84 unitRate: 21.84 quantity: 1 rateCode: '405' rateCodeValue: Fuel Surcharge currencyCode: USD isOptional: false transportModeType: LTL equipmentType: Van quoteSource: MarketRate - quoteId: 399662685 carrier: carrierCode: T3915600 carrierName: US Special Delivery scac: UPPN totalCharge: 100.85 totalFreightCharge: 87.35 totalAccessorialCharge: 13.5 transit: minimumTransitDays: 1 originService: Direct destinationService: Direct rates: - rateId: 3738410710 totalRate: 87.35 unitRate: 87.35 quantity: 1 rateCode: '400' rateCodeValue: Line Haul currencyCode: USD isOptional: false - rateId: 3738410710 totalRate: 13.5 unitRate: 13.5 quantity: 1 rateCode: '405' rateCodeValue: Fuel Surcharge currencyCode: USD isOptional: false transportModeType: LTL equipmentType: Van quoteSource: MarketRate - quoteId: 399662686 carrier: carrierCode: T6282 carrierName: N and M Transfer scac: NMTF totalCharge: 123.75 totalFreightCharge: 106.41 totalAccessorialCharge: 17.34 transit: minimumTransitDays: 1 originService: Direct destinationService: Direct rates: - rateId: 3738410711 totalRate: 106.41 unitRate: 106.41 quantity: 1 rateCode: '400' rateCodeValue: Line Haul currencyCode: USD isOptional: false - rateId: 3738410711 totalRate: 17.34 unitRate: 17.34 quantity: 1 rateCode: '405' rateCodeValue: Fuel Surcharge currencyCode: USD isOptional: false transportModeType: LTL equipmentType: Van quoteSource: MarketRate - quoteId: 399662688 carrier: carrierCode: T9715 carrierName: Estes Express Lines scac: EXLA totalCharge: 158.01 totalFreightCharge: 136.86 totalAccessorialCharge: 21.15 transit: minimumTransitDays: 1 originService: Direct destinationService: Direct rates: - rateId: 3738410712 totalRate: 136.86 unitRate: 136.86 quantity: 1 rateCode: '400' rateCodeValue: Line Haul currencyCode: USD isOptional: false - rateId: 3738410712 totalRate: 21.15 unitRate: 21.15 quantity: 1 rateCode: '405' rateCodeValue: Fuel Surcharge currencyCode: USD isOptional: false transportModeType: LTL equipmentType: Van quoteSource: MarketRate - quoteId: 399662691 carrier: carrierCode: T102231 carrierName: Dohrn Transfer Company scac: DHRN totalCharge: 142.88 totalFreightCharge: 123.76 totalAccessorialCharge: 19.12 transit: minimumTransitDays: 1 originService: Direct destinationService: Direct rates: - rateId: 3738410713 totalRate: 123.76 unitRate: 123.76 quantity: 1 rateCode: '400' rateCodeValue: Line Haul currencyCode: USD isOptional: false - rateId: 3738410713 totalRate: 19.12 unitRate: 19.12 quantity: 1 rateCode: '405' rateCodeValue: Fuel Surcharge currencyCode: USD isOptional: false transportModeType: LTL equipmentType: Van quoteSource: MarketRate - quoteId: 399662696 carrier: carrierCode: T45438 carrierName: Pitt Ohio Express scac: PITD totalCharge: 160.74 totalFreightCharge: 149.69 totalAccessorialCharge: 11.05 transit: minimumTransitDays: 1 originService: Direct destinationService: Direct rates: - rateId: 3738410714 totalRate: 149.69 unitRate: 149.69 quantity: 1 rateCode: '400' rateCodeValue: Line Haul currencyCode: USD isOptional: false - rateId: 3738410714 totalRate: 11.05 unitRate: 11.05 quantity: 1 rateCode: '405' rateCodeValue: Fuel Surcharge currencyCode: USD isOptional: false transportModeType: LTL equipmentType: Van quoteSource: MarketRate 400: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' example: - message: '"referenceNumber" is not allowed' path: - referenceNumber type: object.allowUnknown context: child: referenceNumber value: - type: MBOL value: MBOL12345 key: referenceNumber label: referenceNumber 401: description: Unauthorized content: application/json: schema: type: array items: $ref: '#/components/schemas/error401' 403: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' 404: description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' 500: description: Internal Server Error. Please contact your C.H. Robinson Rep. /v1/quotes/freight-class-estimate: post: description: "Allows partner to retrieve the estimated classification, based solely on density, for further use in the actual rate requests." operationId: Estimating Freight Class tags: - Rating requestBody: description: JSON object of shipment information. required: true content: application/json: schema: $ref: '#/components/schemas/freightClassEstimate' examples: Payload: value: length: 10 width: 10 height: 10 linearUnit: "Inches" weight: 100 weightUnit: "Pounds" originCountryCode: "US" destinationCountryCode: "US" customerCode: C8283603 quantity: 10 shipmentDate: 2026-09-05T19:05:18.768Z totalWeight: 1000 responses: 201: description: Request successful content: application/json: schema: $ref: '#/components/schemas/freightClassEstimateResponse' examples: FreightClassResponse: value: estimatedFreightClassByDensityOnly: 500 400: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' example: - message: '"length" is required' path: - length type: any.required context: label: length key: length 401: description: Unauthorized content: application/json: schema: type: array items: $ref: '#/components/schemas/error401' 403: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' 404: description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' 500: description: Internal Server Error. Please contact your C.H. Robinson Rep. #---Orders----------------------------------------------------------------------------------------------- /v1/orders: post: description: Allows partner to create an order in C.H. Robinson's Navisphere® Order Management system. operationId: Order Create tags: - Orders and Booking requestBody: description: JSON object of shipment information. required: true content: application/json: schema: $ref: '#/components/schemas/order' examples: Payload: value: customers: - customerCode: "C8283603" contacts: - name: Customer One type: Contact companyName: Customer One Company contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: MBOL value: "SIMPMBOL968874" billTos: - customerCode: "C8283603" charges: - rate: 0.45 rateCode: '400' quantity: 147 alternateDescription: Fuel Surcharge currencyCode: USD contacts: - name: Customer One type: Contact companyName: Customer One Company contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: SHID value: "SIMPSHID968874" services: - dateCalculationRule: promisedDeliveryDate serviceLevel: S sellMode: LTL suggestedScac: '4695' suggestedCarrierPartyCode: T2383 locations: - customerLocationId: W541849 type: origin name: CHR Minneapolis address: address1: 410 Terry Ave. N address2: Building 1 address3: Floor 3 address4: Suite 308 city: Minneapolis county: Henepiny lat: '44.989136' long: "-93.278497" stateProvinceCode: MN postalCode: '55401' country: US blindLocation: blindName: Blind Shipping Pick blindAddress: Blind Shipper lane blindCity: Minneapolis blindState: MN openDateTime: '2026-09-05T19:05:18.768Z' closeDateTime: '2026-09-05T19:05:18.768Z' scheduledOpenDateTime: '2026-09-05T19:05:18.768Z' scheduledCloseDateTime: '2026-09-05T19:05:18.768Z' specialRequirement: liftGate: false insidePickup: true residentialNonCommercial: false limitedAccess: false tradeShoworConvention: false constructionSite: false dropOffAtCarrierTerminal: false scalesRequired: false hasDropTrailer: false specialInstructions: Stay hungry. Stay foolish. -Steve Jobs contacts: - name: Pick Location Contact type: Contact companyName: Pick location contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: PU value: "SIMPPU67890" - customerLocationId: W541849 type: destination name: CHR Eden Prairie address: address1: 14701 Charlson Rd address2: Building 2 address3: Floor 2 address4: Room 204 city: Eden Prairie county: Hennepin lat: '44.820839' long: "-93.460654" stateProvinceCode: MN postalCode: '55347' country: US openDateTime: '2026-09-06T19:05:18.770Z' closeDateTime: '2026-09-06T19:05:18.770Z' scheduledOpenDateTime: '2026-09-06T19:05:18.770Z' scheduledCloseDateTime: '2026-09-06T19:05:18.770Z' specialRequirement: liftGate: false insideDelivery: true residentialNonCommercial: false limitedAccess: false tradeShoworConvention: false constructionSite: false pickupAtCarrierTerminal: false sortAndSegregate: false scalesRequired: false hasDropTrailer: false specialInstructions: Whatever you are, be a good one. -Abraham Lincoln contacts: - name: Drop Location Contact type: Contact companyName: Drop Location contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: DEL value: "SIMPDEL67890" items: - packagingType: CAS quantity: 40 description: Widgets productCode: 123-45 freightClass: '70' weight: 5000 weightUnitOfMeasure: Pounds packagingLength: 2 packagingWidth: 2 packagingHeight: 2 packagingUnitOfMeasure: Inches relationships: innerPackQuantity: 50 innerPackUomCode: BOT masterPackQuantity: 4 equipmentLength: 48 equipmentHeight: 60 equipmentWidth: 40 equipmentUnitOfMeasure: Inches totalTrailerFeetUsed: 4 itemEquipment: itemEquipmentCode: B maxTrailerAge: 10 tarpTypeCode: SMOKE loadingTypeCode: CRANE requiredStrapsCount: 10 requiredChainsCount: 10 coilRacks: 6 locksBars: 9 isOwOd: false safetyEquipmentRequired: false packagingVolume: 7680 packagingVolumeUnitOfMeasure: CubicFeet insuranceValue: 1000 pallets: 1 palletSpaces: 1 nationalMotorFreightClass: '50' upcNumber: '1234567890' skuNumber: 01234-001-F10-6 pluNumber: 514a561 isStackable: false isTemperatureSensitive: true temperatureType: Dry temperatureUnit: Celsius requiredTemperatureHigh: 32 requiredTemperatureLow: 0 referenceNumbers: - type: PO value: "SIMPPO67890" referenceNumbers: - type: PRO value: "SIMPPRO67890" isTeam: false measurementSystem: Standard referenceNumbers: - type: JNO value: NOT A REAL ORDER!!!!!!!!!! loadValues: equipmentLength: 48 equipmentWidth: 9 equipmentHeight: 12 trailerNum: "T1234567" onlineParties: - partyType: "CUSTOMER" partyCode: "C1" relationshipIdentifier: "456123" notes: "Created through Postman request by EAPI Team" Order Minimum: value: customers: - customerCode: C8283603 billTos: - customerCode: C8283603 currencyCode: USD services: - locations: - type: origin name: CHR Eden Prairie address: address1: 14701 Charlson Rd city: Eden Prairie stateProvinceCode: MN postalCode: '55347' country: US openDateTime: '2026-09-05T19:05:18.768Z' closeDateTime: '2026-09-05T19:05:18.768Z' - type: destination name: CHR Eden Prairie address: address1: 14701 Charlson Rd city: Eden Prairie stateProvinceCode: MN postalCode: '55347' country: US openDateTime: '2026-09-06T19:05:18.770Z' closeDateTime: '2026-09-06T19:05:18.770Z' items: - packagingType: Case quantity: 50 description: Widgets productCode: 123-45 freightClass: '70' weight: 45000 weightUnitOfMeasure: Pounds insuranceValue: 1000 loadValues: equipmentLength: 48 equipmentWidth: 9 equipmentHeight: 12 trailerNum: "T1234567" Order with Hazmat: value: customers: - customerCode: C8283603 contacts: - name: Customer One type: Contact companyName: Customer One Company contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: MBOL value: SIMPMBOL153138 billTos: - customerCode: C8283603 charges: - rate: 132.45 rateCode: '405' alternateDescription: Fuel Surcharge currencyCode: USD contacts: - name: Customer One type: Contact companyName: Customer One Company contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: SHID value: SIMPSHID153138 services: - serviceLevel: Standard sellMode: TL locations: - customerLocationId: W541849 type: origin name: CHR Minneapolis address: address1: 410 Terry Ave. N address2: Building 1 address3: Floor 3 address4: Suite 308 city: Minneapolis county: Henepiny lat: '44.989136' long: "-93.278497" stateProvinceCode: MN postalCode: '55401' country: US openDateTime: '2026-09-05T19:05:18.768Z' closeDateTime: '2026-09-05T19:05:18.768Z' scheduledOpenDateTime: '2026-09-05T19:05:18.768Z' scheduledCloseDateTime: '2026-09-05T19:05:18.768Z' specialRequirement: liftGate: 'true' insidePickup: 'true' residentialNonCommercial: 'true' limitedAccess: 'true' tradeShoworConvention: 'true' constructionSite: 'true' dropOffAtCarrierTerminal: 'true' scalesRequired: false hasDropTrailer: false specialInstructions: Stay hungry. Stay foolish. -Steve Jobs contacts: - name: Pick Location Contact type: Contact companyName: Pick location contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: PU value: SIMPPU67890 - customerLocationId: W541849 type: destination name: CHR Eden Prairie address: address1: 14701 Charlson Rd address2: Building 2 address3: Floor 2 address4: Room 204 city: Eden Prairie county: Hennepin lat: '44.820839' long: "-93.460654" stateProvinceCode: MN postalCode: '55347' country: US openDateTime: '2026-09-06T19:05:18.770Z' closeDateTime: '2026-09-06T19:05:18.770Z' scheduledOpenDateTime: '2026-09-06T19:05:18.770Z' scheduledCloseDateTime: '2026-09-06T19:05:18.770Z' specialRequirement: liftGate: 'true' insideDelivery: 'true' residentialNonCommercial: 'true' limitedAccess: 'true' tradeShoworConvention: 'true' constructionSite: 'true' pickupAtCarrierTerminal: 'true' sortAndSegregate: 'true' scalesRequired: false hasDropTrailer: false specialInstructions: Whatever you are, be a good one. -Abraham Lincoln contacts: - name: Drop Location Contact type: Contact companyName: Drop Location contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: DEL value: SIMPDEL67890 items: - packagingType: Case quantity: 50 description: Widgets productCode: 123-45 freightClass: '70' weight: 45000 weightUnitOfMeasure: Pounds packagingLength: 2 packagingWidth: 2 packagingHeight: 2 packagingUnitOfMeasure: Inches equipmentLength: 48 equipmentHeight: 9 equipmentWidth: 8 equipmentUnitOfMeasure: Feet packagingVolume: 7680 packagingVolumeUnitOfMeasure: CubicFeet insuranceValue: 1000 pallets: 1 palletSpaces: 1 nationalMotorFreightClass: '50' hazardousProperties: description: Hazardous Material technicalName: Technically Hazardous unNumber: '2796' classCode: '8' packagingGroup: Group I emergencyPhone: '911' authCode: D isPlacarded: false isReportableQuantity: false isPrimaryCommodity: false isNOSCommodity: false upcNumber: '1234567890' skuNumber: 01234-001-F10-6 isStackable: false isTemperatureSensitive: true temperatureType: Dry temperatureUnit: Celsius requiredTemperatureHigh: 32 requiredTemperatureLow: 0 referenceNumbers: - type: PO value: SIMPPO67890 referenceNumbers: - type: PRO value: SIMPPRO67890 measurementSystem: Standard referenceNumbers: - type: JNO value: NOT A REAL ORDER!!!!!!!!!! loadValues: equipmentLength: 48 equipmentWidth: 9 equipmentHeight: 12 trailerNum: "T1234567" notes: Created through EAPI portal "try it now" feature Order with Package: value: customers: - customerCode: "C8283603" contacts: - name: Customer One type: Contact companyName: Customer One Company contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: MBOL value: "{{MBOL}}" billTos: - customerCode: "C8283603" charges: - rate: 132.45 rateCode: '405' alternateDescription: Fuel Surcharge currencyCode: USD contacts: - name: Customer One type: Contact companyName: Customer One Company contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: SHID value: "SIMPSHID968874" services: - serviceLevel: Standard sellMode: TL locations: - customerLocationId: W541849 type: origin name: CHR Minneapolis address: address1: 410 Terry Ave. N address2: Building 1 address3: Floor 3 address4: Suite 308 city: Minneapolis county: Henepiny lat: '44.989136' long: "-93.278497" stateProvinceCode: MN postalCode: '55401' country: US openDateTime: '2026-09-05T19:05:18.768Z' closeDateTime: '2026-09-05T19:05:18.768Z' scheduledOpenDateTime: '2026-09-05T19:05:18.768Z' scheduledCloseDateTime: '2026-09-05T19:05:18.768Z' scalesRequired: false hasDropTrailer: false specialInstructions: Stay hungry. Stay foolish. -Steve Jobs contacts: - name: Pick Location Contact type: Contact companyName: Pick location contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: PU value: SIMPPU67890 - customerLocationId: W541849 type: destination name: CHR Eden Prairie address: address1: 14701 Charlson Rd address2: Building 2 address3: Floor 2 address4: Room 204 city: Eden Prairie county: Hennepin lat: '44.820839' long: "-93.460654" stateProvinceCode: MN postalCode: '55347' country: US openDateTime: '2026-09-06T19:05:18.770Z' closeDateTime: '2026-09-06T19:05:18.770Z' scheduledOpenDateTime: '2026-09-06T19:05:18.770Z' scheduledCloseDateTime: '2026-09-06T19:05:18.770Z' scalesRequired: false hasDropTrailer: false specialInstructions: Whatever you are, be a good one. -Abraham Lincoln contacts: - name: Drop Location Contact type: Contact companyName: Drop Location contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: DEL value: SIMPDEL67890 packages: - packageType: BOX weight: 5 length: 5 width: 5 height: 5 volume: 5 weightLb: 5 packageUnitOfMeasure: Inches packageVolumeUnitOfMeasure: CubicFeet codAmount: 20 declaredValue: 15 trackingNumber: '456789845137' referenceNumbers: - type: PRO value: SIMPPRO67890 measurementSystem: Standard referenceNumbers: - type: JNO value: NOT A REAL ORDER!!!!!!!!!! loadValues: equipmentLength: 48 equipmentWidth: 9 equipmentHeight: 12 trailerNum: "T1234567" notes: Created through Postman request by EAPI Team Order Multi-Stop: value: customers: - customerCode: C8283603 referenceNumbers: - type: MBOL value: SIMPMBOL968874 billTos: - customerCode: C8283603 currencyCode: USD referenceNumbers: - type: SHID value: SIMPSHID968874 services: - sellMode: TL locations: - customerLocationId: W6068742 type: origin name: CHR California address: address1: 1600 Amphitheatre Pkwy city: Mountain View stateProvinceCode: CA postalCode: '940431351' country: US openDateTime: '2019-06-05T18:36:13.131Z' closeDateTime: '2019-06-06T18:36:13.131Z' - customerLocationId: W541849 type: destination name: CHR Minneapolis address: address1: 410 Terry Ave. N address2: Building 1 address3: Floor 3 address4: Suite 308 city: Minneapolis county: Henepiny lat: '44.989136' long: "-93.278497" stateProvinceCode: MN postalCode: '55401' country: US openDateTime: '2019-06-05T18:36:13.131Z' closeDateTime: '2019-06-06T18:36:13.131Z' items: - packagingType: Case quantity: 20 description: Widgets productCode: 123-45 freightClass: '70' weight: 15000 weightUnitOfMeasure: Pounds insuranceValue: 1000 - sellMode: TL locations: - customerLocationId: W541849 type: origin name: CHR Southern California address: address1: 2550 Brittannia Blvd city: San Diego stateProvinceCode: CA postalCode: '92173' country: US openDateTime: '2019-06-05T18:36:13.131Z' closeDateTime: '2019-06-06T18:36:13.131Z' - customerLocationId: W541849 type: destination name: CHR Minneapolis address: address1: 410 Terry Ave. N address2: Building 1 address3: Floor 3 address4: Suite 308 city: Minneapolis county: Henepiny lat: '44.989136' long: "-93.278497" stateProvinceCode: MN postalCode: '55401' country: US openDateTime: '2019-06-05T18:36:13.131Z' closeDateTime: '2019-06-06T18:36:13.131Z' items: - packagingType: Pallet quantity: 10 description: Stuff productCode: 678-99 freightClass: '70' weight: 10000 weightUnitOfMeasure: Pounds insuranceValue: 1000 x-code-samples: - lang: Curl source: "curl -X POST \\ \n https://sandbox-api.navisphere.com/v1/orders \\ \n -H 'Authorization: Bearer YOUR TOKEN' \\ \n -H 'Content-Type: application/json' \\ \n -d '{ \n \t\"customers\": [{ \n \t\t\"customerCode\": \"C8283603\",\n \t\t\"contacts\": [{\n \t\t\t\"name\": \"Contact One\",\n \t\t\t\"type\": \"Contact\",\n \t\t\t\"companyName\": \"Customer One\",\n \t\t\t\"contactMethods\": [{ \n \t\t\t\t\"method\": \"Phone\",\n \t\t\t\t\"value\": \"5554678415\"\n \t\t\t}]\n \t\t}],\n\n \t\t\"referenceNumbers\": [{\n \t\t\t\"type\": \"MBOL\",\n \t\t\t\"value\": \"SIMPMBOL67890\"\n \t\t}]\n \t}],\n \t\"billTos\": [{\n \t\t\"customerCode\": \"C8283603\",\n \t\t\"charges\": [{\n \t\t\t\"rate\": 132.45,\n \t\t\t\"rateCode\": \"405\",\n \t\t\t\"alternateDescription\": \"Fuel Surcharge\"\n \t\t}],\n \t\t\"currencyCode\": \"USD\",\n \t\t\"contacts\": [{\n \t\t\t\"name\": \"Contact One\",\n \t\t\t\"type\": \"Contact\",\n \t\t\t\"companyName\": \"Customer One\",\n \t\t\t\"contactMethods\": [{ \t\t\t\t\"method\": \"Phone\",\n \t\t\t\t\"value\": \"5554678415\"\n \t\t\t}]\n \t\t}],\n \t\t\"referenceNumbers\": [{ \t\t\t\"type\": \"SHID\",\n \t\t\t\"value\": \"SIMPSHID67890\"\n \t\t}]\n \t}],\n \t\"services\": [{\n \t\t\"serviceLevel\": \"Standard\",\n \t\t\"sellMode\": \"TL\",\n \t\t\"locations\": [{\n \t\t\t\"customerLocationId\": \"W541849\",\n \t\t\t\"type\": \"origin\",\n \t\t\t\"name\": \"Origin Location\",\n \t\t\t\"address\": {\n \t\t\t\t\"address1\": \"14800 Charlson Rd\",\n \t\t\t\t\"address2\": \"Building 1\",\n \t\t\t\t\"address3\": \"Floor 2\",\n \t\t\t\t\"address4\": \"Room 212\",\n \t\t\t\t\"city\": \"Eden Prairie\",\n \t\t\t\t\"county\": \"Hennepin\",\n \t\t\t\t\"lat\": 31.717096,\n \t\t\t\t\"long\": -99.132553,\n \t\t\t\t\"stateProvinceCode\": \"MN\",\n \t\t\t\t\"postalCode\": \"55347\",\n \t\t\t\t\"country\": \"US\" \t\t\t},\n \t\t\t\"openDateTime\": \"2019-03-18T17:23:48.983Z\",\n \t\t\t\"closeDateTime\": \"2019-03-19T17:23:48.984Z\",\n \t\t\t\"scheduledOpenDateTime\": \"2019-03-18T17:23:48.983Z\",\n \t\t\t\"scheduledCloseDateTime\": \"2019-03-19T17:23:48.984Z\",\n \t\t\t\"scalesRequired\": false,\n \t\t\t\"hasDropTrailer\": false,\n \t\t\t\"specialInstructions\": \"Stay hungry. Stay foolish. -Steve Jobs\",\n \t\t\t\"contacts\": [{\n \t\t\t\t\"name\": \"Warehouse Contact\",\n \t\t\t\t\"type\": \"Contact\",\n \t\t\t\t\"companyName\": \"Warehouse One\",\n \t\t\t\t\"contactMethods\": [{\n \t\t\t\t\t\"method\": \"Phone\",\n \t\t\t\t\t\"value\": \"5554678415\" \t\t\t\t}]\n \t\t\t}],\n \t\t\t\"referenceNumber\": [{ \n \t\t\t\t\"type\": \"PU\",\n \t\t\t\t\"value\": \"SIMPPU67890\"\n \t\t\t}]\n \t\t},{ \n \t\t\t\"customerLocationId\": \"W541849\",\n \t\t\t\"type\": \"destination\",\n \t\t\t\"name\": \"Destination Location\",\n \t\t\t\"address\": { \t\t\t\t\"address1\": \"800 Washington Avenue North\",\n \t\t\t\t\"address2\": \"Building 1\",\n \t\t\t\t\"address3\": \"Floor 5\",\n \t\t\t\t\"address4\": \"Suite 550\",\n \t\t\t\t\"city\": \"Minneapolis\",\n \t\t\t\t\"county\": \"Hennepin\",\n \t\t\t\t\"lat\": 44.989386,\n \t\t\t\t\"long\": -93.278626,\n \t\t\t\t\"stateProvinceCode\": \"MN\",\n \t\t\t\t\"postalCode\": \"55401\",\n \t\t\t\t\"country\": \"US\"\n \t\t\t},\n \t\t\t\"openDateTime\": \"2019-03-25T17:23:48.984Z\",\n \t\t\t\"closeDateTime\": \"2019-03-26T17:23:48.984Z\",\n \t\t\t\"scheduledOpenDateTime\": \"2019-03-25T17:23:48.984Z\",\n \t\t\t\"scheduledCloseDateTime\": \"2019-03-26T17:23:48.984Z\",\n \t\t\t\"scalesRequired\": false,\n \t\t\t\"hasDropTrailer\": false,\n \t\t\t\"specialInstructions\": \"Whatever you are, be a good one. -Abraham Lincoln\",\n \t\t\t\"contacts\": [{\n \t\t\t\t\"name\": \"Contact two\",\n \t\t\t\t\"type\": \"Contact\",\n \t\t\t\t\"companyName\": \"Warehouse Two\",\n \t\t\t\t\"contactMethods\": [{ \n \t\t\t\t\t\"method\": \"Phone\",\n \t\t\t\t\t\"value\": \"5554678415\"\n \t\t\t\t}]\n \t\t\t}],\n \t\t\t\"referenceNumbers\": [{\n \t\t\t\t\"type\": \"DEL\",\n \t\t\t\t\"value\": \"SIMPDEL67890\"\n \t\t\t}]\n \t\t\t}],\n \t\t\t\"items\": [{\n \t\t\t\t\"packagingType\": \"Case\",\n \t\t\t\t\"quantity\": 50,\n \t\t\t\t\"description\": \"Widgets\",\n \t\t\t\t\"productCode\": \"123-45\",\n \t\t\t\t\"freightClass\": \"70\",\n \t\t\t\t\"weight\": 45000,\n \t\t\t\t\"weightUnitOfMeasure\": \"Pounds\",\n \t\t\t\t\"packagingLength\": 2,\n \t\t\t\t\"packagingWidth\": 2,\n \t\t\t\t\"packagingHeight\": 2,\n \t\t\t\t\"packagingUnitOfMeasure\": \"Inches\",\n \t\t\t\t\"equipmentLength\": 48,\n \t\t\t\t\"equipmentHeight\": 9,\n \t\t\t\t\"equipmentWidth\": 8,\n \t\t\t\t\"equipmentUnitOfMeasure\": \"Feet\",\n \t\t\t\t\"packagingVolume\": 7680,\n \t\t\t\t\"packagingVolumeUnitOfMeasure\": \"CubicFeet\",\n \t\t\t\t\"insuranceValue\": 1000,\n \t\t\t\t\"pallets\": 1,\n \t\t\t\t\"palletSpaces\": 1,\n \t\t\t\t\"nationalMotorFreightClass\": \"50\",\n \t\t\t\t\"hazardousProperties\": {\n \t\t\t\t\t\"description\": \"Hazardous Material\",\n \t\t\t\t\t\"technicalName\": \"Technically Hazardous\",\n \t\t\t\t\t\"unNumber\": \"2796\",\n \t\t\t\t\t\"classCode\": \"8\",\n \t\t\t\t\t\"packagingGroup\": \"Group I\",\n \t\t\t\t\t\"emergencyPhone\": \"911\",\n \t\t\t\t\t\"authCode\": \"D\",\n \t\t\t\t\t\"isPlacarded\": false,\n \t\t\t\t\t\"isReportableQuantity\": false,\n \t\t\t\t\t\"isPrimaryCommodity\": false,\n \t\t\t\t\t\"isNOSCommodity\": false \t\t\t\t},\n \t\t\t\t\"upcNumber\": \"1234567890\",\n \t\t\t\t\"skuNumber\": \"01234-001-F10-6\",\n \t\t\t\t\"isStackable\": false,\n \t\t\t\t\"isTemperatureSensitive\": true,\n \t\t\t\t\"temperatureType\": \"Dry\",\n \t\t\t\t\"temperatureUnit\": \"Celsius\",\n \t\t\t\t\"requiredTemperatureHigh\": 32,\n \t\t\t\t\"requiredTemperatureLow\": 0,\n \t\t\t\t\"referenceNumbers\": [{\n \t\t\t\t\t\"type\": \"PO\",\n \t\t\t\t\t\"value\": \"SIMPPO67890\"\n \t\t\t\t}]\n \t\t\t}],\n \t\t\t\"collectOnDelivered\": [{\n \t\t\t\t\"amount\": 153.24,\n \t\t\t\t\"paymentType\": \"CC\",\n \t\t\t\t\"payableTo\": \"John Doe\",\n \t\t\t\t\"mailTo\": \"Jane Doe\",\n \t\t\t\t\"address\": {\n \t\t\t\t\t\"address1\": \"14800 Charlson Rd\",\n \t\t\t\t\t\"address2\": \"Building 1\",\n \t\t\t\t\t\"address3\": \"Floor 5\",\n \t\t\t\t\t\"address4\": \"Room 212\",\n \t\t\t\t\t\"city\": \"Eden Prairie\",\n \t\t\t\t\t\"county\": \"Hennepin\",\n \t\t\t\t\t\"lat\": 34.1548,\n \t\t\t\t\t\"long\": -84.46578,\n \t\t\t\t\t\"stateProvinceCode\": \"MN\",\n \t\t\t\t\t\"postalCode\": \"55347\",\n \t\t\t\t\t\"country\": \"US\"\n \t\t\t\t},\n \t\t\t\t\"referenceNumbers\": [{\n \t\t\t\t\t\"type\": \"MBOL\",\n \t\t\t\t\t\"value\": \"12345687\"\n \t\t\t\t}]\n \t\t\t}],\n \t\t\t\"referenceNumbers\": [{\n \t\t\t\t\"type\": \"PRO\",\n \t\t\t\t\"value\": \"SIMPPRO67890\"\n \t\t\t}]\n \t\t}],\n \t\t\"measurementSystem\": \"Standard\",\n \t\t\"referenceNumbers\": [{\n \t\t\t\"type\": \"CON\",\n \t\t\t\"value\": \"CON12321NOC\"\n \t\t},{\n \t\t\t\"type\": \"JNO\",\n \t\t\t\"value\": \"NOT A REAL ORDER!!!!!!!!!!\"\n \t\t}],\n \t\t\"loadValues\": {\n \t\t\t\"equipmentLength\": 48,\n \t\t\t\"equipmentWidth\": 9,\n \t\t\t\"trailerNum\": \"T1234567\"\n \t\t},\n \t\t\"onlineParties\": [{\n \t\t\t\"partyType\": \"CUSTOMER\",\n \t\t\t\"partyCode\": \"C1\",\n \t\t\t\"relationshipIdentifier\": \"456123\"\n \t\t}],\n \t\"notes\": \"Created through Schema Test\"\n }'" - lang: Java source: "HttpResponse response = Unirest.post(\"https://sandbox-api.navisphere.com/v1/orders\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .body(\"{\n \"customers\": [\n {\n \"customerCode\": \"C8283603\",\n \"contacts\": [\n {\n \"name\": \"Contact One\",\n \"type\": \"Contact\",\n \"companyName\": \"Customer One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"MBOL\",\n \"value\": \"SIMPMBOL67890\"\n }\n ]\n }\n ],\n \"billTos\": [\n {\n \"customerCode\": \"C8283603\",\n \"charges\": [\n {\n \"rate\": 132.45,\n \"rateCode\": \"405\",\n \"alternateDescription\": \"Fuel Surcharge\"\n }\n ],\n \"currencyCode\": \"USD\",\n \"contacts\": [\n {\n \"name\": \"Contact One\",\n \"type\": \"Contact\",\n \"companyName\": \"Customer One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"SHID\",\n \"value\": \"SIMPSHID67890\"\n }\n ]\n }\n ],\n \"services\": [\n {\n \"serviceLevel\": \"Standard\",\n \"sellMode\": \"TL\",\n \"locations\": [\n {\n \"customerLocationId\": \"W541849\",\n \"type\": \"origin\",\n \"name\": \"Origin Location\",\n \"address\": {\n \"address1\": \"14800 Charlson Rd\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 2\",\n \"address4\": \"Room 212\",\n \"city\": \"Eden Prairie\",\n \"county\": \"Hennepin\",\n \"lat\": 31.717096,\n \"long\": -99.132553,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55347\",\n \"country\": \"US\"\n },\n \"openDateTime\": \"2019-03-18T17:23:48.983Z\",\n \"closeDateTime\": \"2019-03-19T17:23:48.984Z\",\n \"scheduledOpenDateTime\": \"2019-03-18T17:23:48.983Z\",\n \"scheduledCloseDateTime\": \"2019-03-19T17:23:48.984Z\",\n \"scalesRequired\": false,\n \"hasDropTrailer\": false,\n \"specialInstructions\": \"Stay hungry. Stay foolish. -Steve Jobs\",\n \"contacts\": [\n {\n \"name\": \"Warehouse Contact\",\n \"type\": \"Contact\",\n \"companyName\": \"Warehouse One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumber\": [\n {\n \"type\": \"PU\",\n \"value\": \"SIMPPU67890\"\n }\n ]\n },\n {\n \"customerLocationId\": \"W541849\",\n \"type\": \"destination\",\n \"name\": \"Destination Location\",\n \"address\": {\n \"address1\": \"800 Washington Avenue North\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 5\",\n \"address4\": \"Suite 550\",\n \"city\": \"Minneapolis\",\n \"county\": \"Hennepin\",\n \"lat\": 44.989386,\n \"long\": -93.278626,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55401\",\n \"country\": \"US\"\n },\n \"openDateTime\": \"2019-03-25T17:23:48.984Z\",\n \"closeDateTime\": \"2019-03-26T17:23:48.984Z\",\n \"scheduledOpenDateTime\": \"2019-03-25T17:23:48.984Z\",\n \"scheduledCloseDateTime\": \"2019-03-26T17:23:48.984Z\",\n \"scalesRequired\": false,\n \"hasDropTrailer\": false,\n \"specialInstructions\": \"Whatever you are, be a good one. -Abraham Lincoln\",\n \"contacts\": [\n {\n \"name\": \"Contact two\",\n \"type\": \"Contact\",\n \"companyName\": \"Warehouse Two\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"DEL\",\n \"value\": \"SIMPDEL67890\"\n }\n ]\n }\n ],\n \"items\": [\n {\n \"packagingType\": \"Case\",\n \"quantity\": 50,\n \"description\": \"Widgets\",\n \"productCode\": \"123-45\",\n \"freightClass\": \"70\",\n \"weight\": 45000,\n \"weightUnitOfMeasure\": \"Pounds\",\n \"packagingLength\": 2,\n \"packagingWidth\": 2,\n \"packagingHeight\": 2,\n \"packagingUnitOfMeasure\": \"Inches\",\n \"equipmentLength\": 48,\n \"equipmentHeight\": 9,\n \"equipmentWidth\": 8,\n \"equipmentUnitOfMeasure\": \"Feet\",\n \"packagingVolume\": 7680,\n \"packagingVolumeUnitOfMeasure\": \"CubicFeet\",\n \"insuranceValue\": 1000,\n \"pallets\": 1,\n \"palletSpaces\": 1,\n \"nationalMotorFreightClass\": \"50\",\n \"hazardousProperties\": {\n \"description\": \"Hazardous Material\",\n \"technicalName\": \"Technically Hazardous\",\n \"unNumber\": \"2796\",\n \"classCode\": \"8\",\n \"packagingGroup\": \"Group I\",\n \"emergencyPhone\": \"911\",\n \"authCode\": \"D\",\n \"isPlacarded\": false,\n \"isReportableQuantity\": false,\n \"isPrimaryCommodity\": false,\n \"isNOSCommodity\": false\n },\n \"upcNumber\": \"1234567890\",\n \"skuNumber\": \"01234-001-F10-6\",\n \"isStackable\": false,\n \"isTemperatureSensitive\": true,\n \"temperatureType\": \"Dry\",\n \"temperatureUnit\": \"Celsius\",\n \"requiredTemperatureHigh\": 32,\n \"requiredTemperatureLow\": 0,\n \"referenceNumbers\": [\n {\n \"type\": \"PO\",\n \"value\": \"SIMPPO67890\"\n }\n ]\n }\n ],\n \"collectOnDelivered\": [\n {\n \"amount\": 153.24,\n \"paymentType\": \"CC\",\n \"payableTo\": \"John Doe\",\n \"mailTo\": \"Jane Doe\",\n \"address\": {\n \"address1\": \"14800 Charlson Rd\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 5\",\n \"address4\": \"Room 212\",\n \"city\": \"Eden Prairie\",\n \"county\": \"Hennepin\",\n \"lat\": 34.1548,\n \"long\": -84.46578,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55347\",\n \"country\": \"US\"\n },\n \"referenceNumbers\": [\n {\n \"type\": \"MBOL\",\n \"value\": \"12345687\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"PRO\",\n \"value\": \"SIMPPRO67890\"\n }\n ]\n }\n ],\n \"measurementSystem\": \"Standard\",\n \"referenceNumbers\": [\n {\n \"type\": \"CON\",\n \"value\": \"CON12321NOC\"\n },\n {\n \"type\": \"JNO\",\n \"value\": \"NOT A REAL ORDER!!!!!!!!!!\"\n }\n ],\n \"loadValues\":\n {\n \"equipmentLength\": 48,\n \"equipmentWidth\": 9,\n \"trailerNum\": \"T1234567\"\n },\n \"onlineParties\": [\n {\n \"partyType\": \"CUSTOMER\",\n \"partyCode\": \"C1\",\n \"relationshipIdentifier\": \"456123\"\n }\n ],\n \"notes\": \"Created through Schema Test\"\n}\")\n .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'POST',\n \turl: 'https://sandbox-api.navisphere.com/v1/orders',\n \theaders: \n \t{ Authorization: 'Bearer YOU TOKEN',\n \t\t'Content-Type': 'application/json' },\n \tbody: { \n \tcustomers: \n \t\t[ { customerCode: 'C8283603', \n \t\t\tcontacts: \n \t\t\t[ { name: 'Contact One',\n \t\t\t\ttype: 'Contact',\n \t\t\t\tcompanyName: 'Customer One',\n \t\t\t\tcontactMethods: [ { method: 'Phone', value: '5554678415' } ] } ],\n \t\t\treferenceNumbers: [ { type: 'MBOL', value: 'SIMPMBOL67890' } ] } ],\n \tbillTos: \n \t\t[ { customerCode: 'C8283603',\n \t\t\tcharges: \n \t\t\t[ { rate: 132.45,\n \t\t\t\trateCode: '405',\n \t\t\t\talternateDescription: 'Fuel Surcharge' } ],\n \t\t\tcurrencyCode: 'USD',\n \t\t\tcontacts: \n \t\t\t[ { name: 'Contact One',\n \t\t\t\ttype: 'Contact',\n \t\t\t\tcompanyName: 'Customer One',\n \t\t\t\tcontactMethods: [ { method: 'Phone', value: '5554678415' } ] } ],\n \t\t\treferenceNumbers: [ { type: 'SHID', value: 'SIMPSHID67890' } ] } ],\n \tservices: \n \t\t[ { serviceLevel: 'Standard',\n \t\t\tsellMode: 'TL',\n \t\t\tlocations: \n \t\t\t[ { customerLocationId: 'W541849',\n \t\t\t\ttype: 'origin',\n \t\t\t\tname: 'Origin Location',\n \t\t\t\taddress: { \n \t\t\t\t\taddress1: '14800 Charlson Rd',\n \t\t\t\t\taddress2: 'Building 1',\n \t\t\t\t\taddress3: 'Floor 2',\n \t\t\t\t\taddress4: 'Room 212',\n \t\t\t\t\tcity: 'Eden Prairie',\n \t\t\t\t\tcounty: 'Hennepin',\n \t\t\t\t\tlat: 31.717096,\n \t\t\t\t\tlong: -99.132553,\n \t\t\t\t\tstateProvinceCode: 'MN',\n \t\t\t\t\tpostalCode: '55347',\n \t\t\t\t\tcountry: 'US' },\n \t\t\t\topenDateTime: '2019-03-18T17:23:48.983Z',\n \t\t\t\tcloseDateTime: '2019-03-19T17:23:48.984Z',\n \t\t\t\tscheduledOpenDateTime: '2019-03-18T17:23:48.983Z',\n \t\t\t\tscheduledCloseDateTime: '2019-03-19T17:23:48.984Z',\n \t\t\t\tscalesRequired: false,\n \t\t\t\thasDropTrailer: false,\n \t\t\t\tspecialInstructions: 'Stay hungry. Stay foolish. -Steve Jobs',\n \t\t\t\tcontacts:[ { \n \t\t\t\t\tname: 'Warehouse Contact',\n \t\t\t\t\ttype: 'Contact',\n \t\t\t\t\tcompanyName: 'Warehouse One',\n \t\t\t\t\tcontactMethods: [ { method: 'Phone', value: '5554678415' } ] } ],\n \t\t\t\treferenceNumber: [ { type: 'PU', value: 'SIMPPU67890' } ] },{ \n \t\t\t\tcustomerLocationId: 'W541849',\n \t\t\t\ttype: 'destination',\n \t\t\t\tname: 'Destination Location',\n \t\t\t\taddress: { \n \t\t\t\t\taddress1: '800 Washington Avenue North',\n \t\t\t\t\taddress2: 'Building 1',\n \t\t\t\t\taddress3: 'Floor 5',\n \t\t\t\t\taddress4: 'Suite 550',\n \t\t\t\t\tcity: 'Minneapolis',\n \t\t\t\t\tcounty: 'Hennepin',\n \t\t\t\t\tlat: 44.989386,\n \t\t\t\t\tlong: -93.278626,\n \t\t\t\t\tstateProvinceCode: 'MN',\n \t\t\t\t\tpostalCode: '55401',\n \t\t\t\t\tcountry: 'US' },\n \t\t\t\topenDateTime: '2019-03-25T17:23:48.984Z',\n \t\t\t\tcloseDateTime: '2019-03-26T17:23:48.984Z',\n \t\t\t\tscheduledOpenDateTime: '2019-03-25T17:23:48.984Z',\n \t\t\t\tscheduledCloseDateTime: '2019-03-26T17:23:48.984Z',\n \t\t\t\tscalesRequired: false,\n \t\t\t\thasDropTrailer: false,\n \t\t\t\tspecialInstructions: 'Whatever you are, be a good one. -Abraham Lincoln',\n \t\t\t\tcontacts: [ { \n \t\t\t\t\tname: 'Contact two',\n \t\t\t\t\ttype: 'Contact',\n \t\t\t\t\tcompanyName: 'Warehouse Two',\n \t\t\t\t\tcontactMethods: [ { method: 'Phone', value: '5554678415' } ] } ],\n \t\t\t\treferenceNumbers: [ { type: 'DEL', value: 'SIMPDEL67890' } ] } ],\n \t\t\titems: [ { \n \t\t\t\tpackagingType: 'Case',\n \t\t\t\tquantity: 50,\n \t\t\t\tdescription: 'Widgets',\n \t\t\t\tproductCode: '123-45',\n \t\t\t\tfreightClass: '70',\n \t\t\t\tweight: 45000,\n \t\t\t\tweightUnitOfMeasure: 'Pounds',\n \t\t\t\tpackagingLength: 2,\n \t\t\t\tpackagingWidth: 2,\n \t\t\t\tpackagingHeight: 2,\n \t\t\t\tpackagingUnitOfMeasure: 'Inches',\n \t\t\t\tequipmentLength: 48,\n \t\t\t\tequipmentHeight: 9,\n \t\t\t\tequipmentWidth: 8,\n \t\t\t\tequipmentUnitOfMeasure: 'Feet',\n \t\t\t\tpackagingVolume: 7680,\n \t\t\t\tpackagingVolumeUnitOfMeasure: 'CubicFeet',\n \t\t\t\tinsuranceValue: 1000,\n \t\t\t\tpallets: 1,\n \t\t\t\tpalletSpaces: 1,\n \t\t\t\tnationalMotorFreightClass: '50',\n \t\t\t\thazardousProperties: { \n \t\t\t\t\tdescription: 'Hazardous Material',\n \t\t\t\t\ttechnicalName: 'Technically Hazardous',\n \t\t\t\t\tunNumber: '2796',\n \t\t\t\t\tclassCode: '8',\n \t\t\t\t\tpackagingGroup: 'Group I',\n \t\t\t\t\temergencyPhone: '911',\n \t\t\t\t\tauthCode: 'D',\n \t\t\t\t\tisPlacarded: false,\n \t\t\t\t\tisReportableQuantity: false,\n \t\t\t\t\tisPrimaryCommodity: false,\n \t\t\t\t\tisNOSCommodity: false },\n \t\t\t\tupcNumber: '1234567890',\n \t\t\t\tskuNumber: '01234-001-F10-6',\n \t\t\t\tisStackable: false,\n \t\t\t\tisTemperatureSensitive: true,\n \t\t\t\ttemperatureType: 'Dry',\n \t\t\t\ttemperatureUnit: 'Celsius',\n \t\t\t\trequiredTemperatureHigh: 32,\n \t\t\t\trequiredTemperatureLow: 0,\n \t\t\t\treferenceNumbers: [ { type: 'PO', value: 'SIMPPO67890' } ] } ],\n \t\t\tcollectOnDelivered: [ { \n \t\t\t\tamount: 153.24,\n \t\t\t\tpaymentType: 'CC',\n \t\t\t\tpayableTo: 'John Doe',\n \t\t\t\tmailTo: 'Jane Doe',\n \t\t\t\taddress: { \n \t\t\t\t\taddress1: '14800 Charlson Rd',\n \t\t\t\t\taddress2: 'Building 1',\n \t\t\t\t\taddress3: 'Floor 5',\n \t\t\t\t\taddress4: 'Room 212',\n \t\t\t\t\tcity: 'Eden Prairie',\n \t\t\t\t\tcounty: 'Hennepin',\n \t\t\t\t\tlat: 34.1548,\n \t\t\t\t\tlong: -84.46578,\n \t\t\t\t\tstateProvinceCode: 'MN',\n \t\t\t\t\tpostalCode: '55347',\n \t\t\t\t\tcountry: 'US' },\n \t\t\t\treferenceNumbers: [ { type: 'MBOL', value: '12345687' } ] } ],\n \t\t\treferenceNumbers: [ { type: 'PRO', value: 'SIMPPRO67890' } ] } ],\n \t\tmeasurementSystem: 'Standard',\n \t\treferenceNumbers: [ { \n \t\t\ttype: 'CON', value: 'CON12321NOC' },{ \n \t\t\ttype: 'JNO', value: 'NOT A REAL ORDER!!!!!!!!!!' } ],\n \t\tloadValues:\n \t\t{ \n \t\t\tequipmentLength: 48 \n \t\t\tequipmentWidth: 9 \n \t\t\ttrailerNum: 'T1234567' \n \t\t}, \n \t\tonlineParties: [ { partyType: 'CUSTOMER', partyCode: 'C1', relationshipIdentifier: '456123' } ],\n \t\tnotes: 'Created through Schema Test' },\n \tjson: true };\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/orders\"); \n var request = new RestRequest(Method.POST); \n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\"); \n request.AddHeader(\"Content-Type\", \"application/json\"); \n request.AddParameter(\"undefined\", \" {\n \"customers\": [\n {\n \"customerCode\": \"C8283603\",\n \"contacts\": [\n {\n \"name\": \"Contact One\",\n \"type\": \"Contact\",\n \"companyName\": \"Customer One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"MBOL\",\n \"value\": \"SIMPMBOL67890\"\n }\n ]\n }\n ],\n \"billTos\": [\n {\n \"customerCode\": \"C8283603\",\n \"charges\": [\n {\n \"rate\": 132.45,\n \"rateCode\": \"405\",\n \"alternateDescription\": \"Fuel Surcharge\"\n }\n ],\n \"currencyCode\": \"USD\",\n \"contacts\": [\n {\n \"name\": \"Contact One\",\n \"type\": \"Contact\",\n \"companyName\": \"Customer One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"SHID\",\n \"value\": \"SIMPSHID67890\"\n }\n ]\n }\n ],\n \"services\": [\n {\n \"serviceLevel\": \"Standard\",\n \"sellMode\": \"TL\",\n \"locations\": [\n {\n \"customerLocationId\": \"W541849\",\n \"type\": \"origin\",\n \"name\": \"Origin Location\",\n \"address\": {\n \"address1\": \"14800 Charlson Rd\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 2\",\n \"address4\": \"Room 212\",\n \"city\": \"Eden Prairie\",\n \"county\": \"Hennepin\",\n \"lat\": 31.717096,\n \"long\": -99.132553,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55347\",\n \"country\": \"US\"\n },\n \"openDateTime\": \"2019-03-18T17:23:48.983Z\",\n \"closeDateTime\": \"2019-03-19T17:23:48.984Z\",\n \"scheduledOpenDateTime\": \"2019-03-18T17:23:48.983Z\",\n \"scheduledCloseDateTime\": \"2019-03-19T17:23:48.984Z\",\n \"scalesRequired\": false,\n \"hasDropTrailer\": false,\n \"specialInstructions\": \"Stay hungry. Stay foolish. -Steve Jobs\",\n \"contacts\": [\n {\n \"name\": \"Warehouse Contact\",\n \"type\": \"Contact\",\n \"companyName\": \"Warehouse One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumber\": [\n {\n \"type\": \"PU\",\n \"value\": \"SIMPPU67890\"\n }\n ]\n },\n {\n \"customerLocationId\": \"W541849\",\n \"type\": \"destination\",\n \"name\": \"Destination Location\",\n \"address\": {\n \"address1\": \"800 Washington Avenue North\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 5\",\n \"address4\": \"Suite 550\",\n \"city\": \"Minneapolis\",\n \"county\": \"Hennepin\",\n \"lat\": 44.989386,\n \"long\": -93.278626,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55401\",\n \"country\": \"US\"\n },\n \"openDateTime\": \"2019-03-25T17:23:48.984Z\",\n \"closeDateTime\": \"2019-03-26T17:23:48.984Z\",\n \"scheduledOpenDateTime\": \"2019-03-25T17:23:48.984Z\",\n \"scheduledCloseDateTime\": \"2019-03-26T17:23:48.984Z\",\n \"scalesRequired\": false,\n \"hasDropTrailer\": false,\n \"specialInstructions\": \"Whatever you are, be a good one. -Abraham Lincoln\",\n \"contacts\": [\n {\n \"name\": \"Contact two\",\n \"type\": \"Contact\",\n \"companyName\": \"Warehouse Two\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"DEL\",\n \"value\": \"SIMPDEL67890\"\n }\n ]\n }\n ],\n \"items\": [\n {\n \"packagingType\": \"Case\",\n \"quantity\": 50,\n \"description\": \"Widgets\",\n \"productCode\": \"123-45\",\n \"freightClass\": \"70\",\n \"weight\": 45000,\n \"weightUnitOfMeasure\": \"Pounds\",\n \"packagingLength\": 2,\n \"packagingWidth\": 2,\n \"packagingHeight\": 2,\n \"packagingUnitOfMeasure\": \"Inches\",\n \"equipmentLength\": 48,\n \"equipmentHeight\": 9,\n \"equipmentWidth\": 8,\n \"equipmentUnitOfMeasure\": \"Feet\",\n \"packagingVolume\": 7680,\n \"packagingVolumeUnitOfMeasure\": \"CubicFeet\",\n \"insuranceValue\": 1000,\n \"pallets\": 1,\n \"palletSpaces\": 1,\n \"nationalMotorFreightClass\": \"50\",\n \"hazardousProperties\": {\n \"description\": \"Hazardous Material\",\n \"technicalName\": \"Technically Hazardous\",\n \"unNumber\": \"2796\",\n \"classCode\": \"8\",\n \"packagingGroup\": \"Group I\",\n \"emergencyPhone\": \"911\",\n \"authCode\": \"D\",\n \"isPlacarded\": false,\n \"isReportableQuantity\": false,\n \"isPrimaryCommodity\": false,\n \"isNOSCommodity\": false\n },\n \"upcNumber\": \"1234567890\",\n \"skuNumber\": \"01234-001-F10-6\",\n \"isStackable\": false,\n \"isTemperatureSensitive\": true,\n \"temperatureType\": \"Dry\",\n \"temperatureUnit\": \"Celsius\",\n \"requiredTemperatureHigh\": 32,\n \"requiredTemperatureLow\": 0,\n \"referenceNumbers\": [\n {\n \"type\": \"PO\",\n \"value\": \"SIMPPO67890\"\n }\n ]\n }\n ],\n \"collectOnDelivered\": [\n {\n \"amount\": 153.24,\n \"paymentType\": \"CC\",\n \"payableTo\": \"John Doe\",\n \"mailTo\": \"Jane Doe\",\n \"address\": {\n \"address1\": \"14800 Charlson Rd\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 5\",\n \"address4\": \"Room 212\",\n \"city\": \"Eden Prairie\",\n \"county\": \"Hennepin\",\n \"lat\": 34.1548,\n \"long\": -84.46578,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55347\",\n \"country\": \"US\"\n },\n \"referenceNumbers\": [\n {\n \"type\": \"MBOL\",\n \"value\": \"12345687\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"PRO\",\n \"value\": \"SIMPPRO67890\"\n }\n ]\n }\n ],\n \"measurementSystem\": \"Standard\",\n \"referenceNumbers\": [\n {\n \"type\": \"CON\",\n \"value\": \"CON12321NOC\"\n },\n {\n \"type\": \"JNO\",\n \"value\": \"NOT A REAL ORDER!!!!!!!!!!\"\n }\n ],\n \"loadValues\":\n {\n \"equipmentLength\": 48,\n \"equipmentWidth\": 9,\n \"trailerNum\": \"T1234567\"\n },\n \"onlineParties\":\n [{\n \"partyType\": \"CUSTOMER\",\n \"partyCode\": \"C1\",\n \"relationshipIdentifier\": \"456123\"\n }],\n \"notes\": \"Created through Schema Test\"\n}\", ParameterType.RequestBody);\n IRestResponse response = client.Execute(request);" responses: '201': description: Request successful content: application/json: schema: $ref: '#/components/schemas/orderResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' example: - message: '"referenceNumber" is not allowed' path: - services - 0 - locations - 0 - referenceNumber type: object.allowUnknown context: child: referenceNumber value: - type: PU value: SIMPPU67890 key: referenceNumber label: referenceNumber '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. put: description: Allows partner to update an existing order in C.H. Robinson's Navisphere® Order Management system. operationId: Order Update tags: - Orders and Booking requestBody: description: JSON object of shipment information. required: true content: application/json: schema: $ref: '#/components/schemas/order' example: orderNumber: 1234567 customers: - customerCode: "C8283603" contacts: - name: Jeff Bezos type: Contact companyName: Amazon contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: MBOL value: SIMPMBOL67890 billTos: - customerCode: "C8283603" charges: - rate: 132.45 rateCode: '405' alternateDescription: Fuel Surcharge currencyCode: USD contacts: - name: Jeff Bezos type: Contact companyName: Amazon contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: SHID value: SIMPSHID67890 services: - serviceLevel: Standard sellMode: TL locations: - customerLocationId: W541849 type: origin name: Amazon Headquarters address: address1: 410 Terry Ave. N address2: Building 1 address3: Floor 5 address4: Room 512 city: Seattle county: King County lat: '47.622375' long: "-122.336553" stateProvinceCode: WA postalCode: '98109' country: US openDateTime: "2026-09-05T19:05:18.768Z" closeDateTime: "2026-09-05T19:05:18.768Z" scheduledOpenDateTime: "2026-09-05T19:05:18.768Z" scheduledCloseDateTime: "2026-09-05T19:05:18.768Z" scalesRequired: false hasDropTrailer: false specialInstructions: Stay hungry. Stay foolish. -Steve Jobs contacts: - name: Jeff Bezos type: Contact companyName: Amazon contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: PU value: SIMPPU67890 - customerLocationId: W541849 type: destination name: Google Headquarters address: address1: 1600 Amphitheatre Parkway address2: Building 43 address3: Floor 1 address4: Room 112 city: Mountain View county: Hennepin lat: '37.421565' long: "-122.084016" stateProvinceCode: CA postalCode: '94043' country: US openDateTime: "2026-09-06T19:05:18.770Z" closeDateTime: "2026-09-06T19:05:18.770Z" scheduledOpenDateTime: "2026-09-06T19:05:18.770Z" scheduledCloseDateTime: "2026-09-06T19:05:18.770Z" scalesRequired: false hasDropTrailer: false specialInstructions: Whatever you are, be a good one. -Abraham Lincoln contacts: - name: Sundar Pichai type: Contact companyName: Google contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: DEL value: SIMPDEL67890 items: - packagingType: Case quantity: 29 description: Widgets productCode: 123-45 freightClass: '70' weight: 40000 weightUnitOfMeasure: Pounds packagingLength: 2 packagingWidth: 2 packagingHeight: 2 packagingUnitOfMeasure: Inches equipmentLength: 48 equipmentHeight: 9 equipmentWidth: 8 equipmentUnitOfMeasure: Feet packagingVolume: 7680 packagingVolumeUnitOfMeasure: CubicFeet insuranceValue: 1000 pallets: 1 palletSpaces: 1 nationalMotorFreightClass: '50' upcNumber: '1234567890' skuNumber: 01234-001-F10-6 isStackable: false isTemperatureSensitive: true temperatureType: Dry temperatureUnit: Celsius requiredTemperatureHigh: 32 requiredTemperatureLow: 0 referenceNumbers: - type: PO value: SIMPPO67890 referenceNumbers: - type: PRO value: SIMPPRO67890 isTeam: false measurementSystem: Standard referenceNumbers: - type: CON value: "CON12321NOC" - type: JNO value: NOT A REAL ORDER!!!!!!!!!! loadValues: equipmentLength: 48 equipmentWidth: 9 trailerNum: "T1234567" onlineParties: - partyType: "CUSTOMER" partyCode: "C1" relationshipIdentifier: "456123" notes: Created through Postman Schema Test x-code-samples: - lang: Curl source: "curl -X PUT \\ \n https://sandbox-api.navisphere.com/v1/orders \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json' \\ \n -d '{ \n \t\"customers\": [{ \n \t\t\"customerCode\": \"C8283603\",\n \t\t\"contacts\": [{\n \t\t\t\"name\": \"Contact One\",\n \t\t\t\"type\": \"Contact\",\n \t\t\t\"companyName\": \"Customer One\",\n \t\t\t\"contactMethods\": [{ \n \t\t\t\t\"method\": \"Phone\",\n \t\t\t\t\"value\": \"5554678415\"\n \t\t\t}]\n \t\t}],\n\n \t\t\"referenceNumbers\": [{\n \t\t\t\"type\": \"MBOL\",\n \t\t\t\"value\": \"SIMPMBOL67890\"\n \t\t}]\n \t}],\n \t\"billTos\": [{\n \t\t\"customerCode\": \"C8283603\",\n \t\t\"charges\": [{\n \t\t\t\"rate\": 132.45,\n \t\t\t\"rateCode\": \"405\",\n \t\t\t\"alternateDescription\": \"Fuel Surcharge\"\n \t\t}],\n \t\t\"currencyCode\": \"USD\",\n \t\t\"contacts\": [{\n \t\t\t\"name\": \"Contact One\",\n \t\t\t\"type\": \"Contact\",\n \t\t\t\"companyName\": \"Customer One\",\n \t\t\t\"contactMethods\": [{ \t\t\t\t\"method\": \"Phone\",\n \t\t\t\t\"value\": \"5554678415\"\n \t\t\t}]\n \t\t}],\n \t\t\"referenceNumbers\": [{ \t\t\t\"type\": \"SHID\",\n \t\t\t\"value\": \"SIMPSHID67890\"\n \t\t}]\n \t}],\n \t\"services\": [{\n \t\t\"serviceLevel\": \"Standard\",\n \t\t\"sellMode\": \"TL\",\n \t\t\"locations\": [{\n \t\t\t\"customerLocationId\": \"W541849\",\n \t\t\t\"type\": \"origin\",\n \t\t\t\"name\": \"Origin Location\",\n \t\t\t\"address\": {\n \t\t\t\t\"address1\": \"14800 Charlson Rd\",\n \t\t\t\t\"address2\": \"Building 1\",\n \t\t\t\t\"address3\": \"Floor 2\",\n \t\t\t\t\"address4\": \"Room 212\",\n \t\t\t\t\"city\": \"Eden Prairie\",\n \t\t\t\t\"county\": \"Hennepin\",\n \t\t\t\t\"lat\": 31.717096,\n \t\t\t\t\"long\": -99.132553,\n \t\t\t\t\"stateProvinceCode\": \"MN\",\n \t\t\t\t\"postalCode\": \"55347\",\n \t\t\t\t\"country\": \"US\" \t\t\t},\n \t\t\t\"openDateTime\": \"2019-03-18T17:23:48.983Z\",\n \t\t\t\"closeDateTime\": \"2019-03-19T17:23:48.984Z\",\n \t\t\t\"scheduledOpenDateTime\": \"2019-03-18T17:23:48.983Z\",\n \t\t\t\"scheduledCloseDateTime\": \"2019-03-19T17:23:48.984Z\",\n \t\t\t\"scalesRequired\": false,\n \t\t\t\"hasDropTrailer\": false,\n \t\t\t\"specialInstructions\": \"Stay hungry. Stay foolish. -Steve Jobs\",\n \t\t\t\"contacts\": [{\n \t\t\t\t\"name\": \"Warehouse Contact\",\n \t\t\t\t\"type\": \"Contact\",\n \t\t\t\t\"companyName\": \"Warehouse One\",\n \t\t\t\t\"contactMethods\": [{\n \t\t\t\t\t\"method\": \"Phone\",\n \t\t\t\t\t\"value\": \"5554678415\" \t\t\t\t}]\n \t\t\t}],\n \t\t\t\"referenceNumbers\": [{ \n \t\t\t\t\"type\": \"PU\",\n \t\t\t\t\"value\": \"SIMPPU67890\"\n \t\t\t}]\n \t\t},{ \n \t\t\t\"customerLocationId\": \"W541849\",\n \t\t\t\"type\": \"destination\",\n \t\t\t\"name\": \"Destination Location\",\n \t\t\t\"address\": { \t\t\t\t\"address1\": \"800 Washington Avenue North\",\n \t\t\t\t\"address2\": \"Building 1\",\n \t\t\t\t\"address3\": \"Floor 5\",\n \t\t\t\t\"address4\": \"Suite 550\",\n \t\t\t\t\"city\": \"Minneapolis\",\n \t\t\t\t\"county\": \"Hennepin\",\n \t\t\t\t\"lat\": 44.989386,\n \t\t\t\t\"long\": -93.278626,\n \t\t\t\t\"stateProvinceCode\": \"MN\",\n \t\t\t\t\"postalCode\": \"55401\",\n \t\t\t\t\"country\": \"US\"\n \t\t\t},\n \t\t\t\"openDateTime\": \"2019-03-25T17:23:48.984Z\",\n \t\t\t\"closeDateTime\": \"2019-03-26T17:23:48.984Z\",\n \t\t\t\"scheduledOpenDateTime\": \"2019-03-25T17:23:48.984Z\",\n \t\t\t\"scheduledCloseDateTime\": \"2019-03-26T17:23:48.984Z\",\n \t\t\t\"scalesRequired\": false,\n \t\t\t\"hasDropTrailer\": false,\n \t\t\t\"specialInstructions\": \"Whatever you are, be a good one. -Abraham Lincoln\",\n \t\t\t\"contacts\": [{\n \t\t\t\t\"name\": \"Contact two\",\n \t\t\t\t\"type\": \"Contact\",\n \t\t\t\t\"companyName\": \"Warehouse Two\",\n \t\t\t\t\"contactMethods\": [{ \n \t\t\t\t\t\"method\": \"Phone\",\n \t\t\t\t\t\"value\": \"5554678415\"\n \t\t\t\t}]\n \t\t\t}],\n \t\t\t\"referenceNumbers\": [{\n \t\t\t\t\"type\": \"DEL\",\n \t\t\t\t\"value\": \"SIMPDEL67890\"\n \t\t\t}]\n \t\t\t}],\n \t\t\t\"items\": [{\n \t\t\t\t\"packagingType\": \"Case\",\n \t\t\t\t\"quantity\": 50,\n \t\t\t\t\"description\": \"Widgets\",\n \t\t\t\t\"productCode\": \"123-45\",\n \t\t\t\t\"freightClass\": \"70\",\n \t\t\t\t\"weight\": 45000,\n \t\t\t\t\"weightUnitOfMeasure\": \"Pounds\",\n \t\t\t\t\"packagingLength\": 2,\n \t\t\t\t\"packagingWidth\": 2,\n \t\t\t\t\"packagingHeight\": 2,\n \t\t\t\t\"packagingUnitOfMeasure\": \"Inches\",\n \t\t\t\t\"equipmentLength\": 48,\n \t\t\t\t\"equipmentHeight\": 9,\n \t\t\t\t\"equipmentWidth\": 8,\n \t\t\t\t\"equipmentUnitOfMeasure\": \"Feet\",\n \t\t\t\t\"packagingVolume\": 7680,\n \t\t\t\t\"packagingVolumeUnitOfMeasure\": \"CubicFeet\",\n \t\t\t\t\"insuranceValue\": 1000,\n \t\t\t\t\"pallets\": 1,\n \t\t\t\t\"palletSpaces\": 1,\n \t\t\t\t\"nationalMotorFreightClass\": \"50\",\n \t\t\t\t\"hazardousProperties\": {\n \t\t\t\t\t\"description\": \"Hazardous Material\",\n \t\t\t\t\t\"technicalName\": \"Technically Hazardous\",\n \t\t\t\t\t\"unNumber\": \"2796\",\n \t\t\t\t\t\"classCode\": \"8\",\n \t\t\t\t\t\"packagingGroup\": \"Group I\",\n \t\t\t\t\t\"emergencyPhone\": \"911\",\n \t\t\t\t\t\"authCode\": \"D\",\n \t\t\t\t\t\"isPlacarded\": false,\n \t\t\t\t\t\"isReportableQuantity\": false,\n \t\t\t\t\t\"isPrimaryCommodity\": false,\n \t\t\t\t\t\"isNOSCommodity\": false \t\t\t\t},\n \t\t\t\t\"upcNumber\": \"1234567890\",\n \t\t\t\t\"skuNumber\": \"01234-001-F10-6\",\n \t\t\t\t\"isStackable\": false,\n \t\t\t\t\"isTemperatureSensitive\": true,\n \t\t\t\t\"temperatureType\": \"Dry\",\n \t\t\t\t\"temperatureUnit\": \"Celsius\",\n \t\t\t\t\"requiredTemperatureHigh\": 32,\n \t\t\t\t\"requiredTemperatureLow\": 0,\n \t\t\t\t\"referenceNumbers\": [{\n \t\t\t\t\t\"type\": \"PO\",\n \t\t\t\t\t\"value\": \"SIMPPO67890\"\n \t\t\t\t}]\n \t\t\t}],\n \t\t\t\"collectOnDelivered\": [{\n \t\t\t\t\"amount\": 153.24,\n \t\t\t\t\"paymentType\": \"CC\",\n \t\t\t\t\"payableTo\": \"John Doe\",\n \t\t\t\t\"mailTo\": \"Jane Doe\",\n \t\t\t\t\"address\": {\n \t\t\t\t\t\"address1\": \"14800 Charlson Rd\",\n \t\t\t\t\t\"address2\": \"Building 1\",\n \t\t\t\t\t\"address3\": \"Floor 5\",\n \t\t\t\t\t\"address4\": \"Room 212\",\n \t\t\t\t\t\"city\": \"Eden Prairie\",\n \t\t\t\t\t\"county\": \"Hennepin\",\n \t\t\t\t\t\"lat\": 34.1548,\n \t\t\t\t\t\"long\": -84.46578,\n \t\t\t\t\t\"stateProvinceCode\": \"MN\",\n \t\t\t\t\t\"postalCode\": \"55347\",\n \t\t\t\t\t\"country\": \"US\"\n \t\t\t\t},\n \t\t\t\t\"referenceNumbers\": [{\n \t\t\t\t\t\"type\": \"MBOL\",\n \t\t\t\t\t\"value\": \"12345687\"\n \t\t\t\t}]\n \t\t\t}],\n \t\t\t\"referenceNumbers\": [{\n \t\t\t\t\"type\": \"PRO\",\n \t\t\t\t\"value\": \"SIMPPRO67890\"\n \t\t\t}],\n \t\t\t\"isTeam\": false\n \t\t}],\n \t\t\"measurementSystem\": \"Standard\",\n \t\t\"referenceNumbers\": [{\n \t\t\t\"type\": \"CON\",\n \t\t\t\"value\": \"CON12321NOC\"\n \t\t},{\n \t\t\t\"type\": \"JNO\",\n \t\t\t\"value\": \"NOT A REAL ORDER!!!!!!!!!!\"\n \t\t}],\n \t\t\"loadValues\": {\n \t\t\t\"equipmentLength\": 48,\n \t\t\t\"equipmentWidth\": 9,\n \t\t\t\"trailerNum\": \"T1234567\"\n \t\t},\n \t\t\"onlineParties\": [{\n \t\t\t\"partyType\": \"CUSTOMER\",\n \t\t\t\"partyCode\": \"C1\",\n \t\t\t\"relationshipIdentifier\": \"456123\"\n \t\t}],\n \t\t\"notes\": \"Created through Schema Test\"\n }'" - lang: Java source: "HttpResponse response = Unirest.put(\"https://sandbox-api.navisphere.com/v1/orders\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .body(\"{\n \"customers\": [\n {\n \"customerCode\": \"C8283603\",\n \"contacts\": [\n {\n \"name\": \"Contact One\",\n \"type\": \"Contact\",\n \"companyName\": \"Customer One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"MBOL\",\n \"value\": \"SIMPMBOL67890\"\n }\n ]\n }\n ],\n \"billTos\": [\n {\n \"customerCode\": \"C8283603\",\n \"charges\": [\n {\n \"rate\": 132.45,\n \"rateCode\": \"405\",\n \"alternateDescription\": \"Fuel Surcharge\"\n }\n ],\n \"currencyCode\": \"USD\",\n \"contacts\": [\n {\n \"name\": \"Contact One\",\n \"type\": \"Contact\",\n \"companyName\": \"Customer One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"SHID\",\n \"value\": \"SIMPSHID67890\"\n }\n ]\n }\n ],\n \"services\": [\n {\n \"serviceLevel\": \"Standard\",\n \"sellMode\": \"TL\",\n \"locations\": [\n {\n \"customerLocationId\": \"W541849\",\n \"type\": \"origin\",\n \"name\": \"Origin Location\",\n \"address\": {\n \"address1\": \"14800 Charlson Rd\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 2\",\n \"address4\": \"Room 212\",\n \"city\": \"Eden Prairie\",\n \"county\": \"Hennepin\",\n \"lat\": 31.717096,\n \"long\": -99.132553,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55347\",\n \"country\": \"US\"\n },\n \"openDateTime\": \"2019-03-18T17:23:48.983Z\",\n \"closeDateTime\": \"2019-03-19T17:23:48.984Z\",\n \"scheduledOpenDateTime\": \"2019-03-18T17:23:48.983Z\",\n \"scheduledCloseDateTime\": \"2019-03-19T17:23:48.984Z\",\n \"scalesRequired\": false,\n \"hasDropTrailer\": false,\n \"specialInstructions\": \"Stay hungry. Stay foolish. -Steve Jobs\",\n \"contacts\": [\n {\n \"name\": \"Warehouse Contact\",\n \"type\": \"Contact\",\n \"companyName\": \"Warehouse One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumber\": [\n {\n \"type\": \"PU\",\n \"value\": \"SIMPPU67890\"\n }\n ]\n },\n {\n \"customerLocationId\": \"W541849\",\n \"type\": \"destination\",\n \"name\": \"Destination Location\",\n \"address\": {\n \"address1\": \"800 Washington Avenue North\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 5\",\n \"address4\": \"Suite 550\",\n \"city\": \"Minneapolis\",\n \"county\": \"Hennepin\",\n \"lat\": 44.989386,\n \"long\": -93.278626,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55401\",\n \"country\": \"US\"\n },\n \"openDateTime\": \"2019-03-25T17:23:48.984Z\",\n \"closeDateTime\": \"2019-03-26T17:23:48.984Z\",\n \"scheduledOpenDateTime\": \"2019-03-25T17:23:48.984Z\",\n \"scheduledCloseDateTime\": \"2019-03-26T17:23:48.984Z\",\n \"scalesRequired\": false,\n \"hasDropTrailer\": false,\n \"specialInstructions\": \"Whatever you are, be a good one. -Abraham Lincoln\",\n \"contacts\": [\n {\n \"name\": \"Contact two\",\n \"type\": \"Contact\",\n \"companyName\": \"Warehouse Two\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"DEL\",\n \"value\": \"SIMPDEL67890\"\n }\n ]\n }\n ],\n \"items\": [\n {\n \"packagingType\": \"Case\",\n \"quantity\": 50,\n \"description\": \"Widgets\",\n \"productCode\": \"123-45\",\n \"freightClass\": \"70\",\n \"weight\": 45000,\n \"weightUnitOfMeasure\": \"Pounds\",\n \"packagingLength\": 2,\n \"packagingWidth\": 2,\n \"packagingHeight\": 2,\n \"packagingUnitOfMeasure\": \"Inches\",\n \"equipmentLength\": 48,\n \"equipmentHeight\": 9,\n \"equipmentWidth\": 8,\n \"equipmentUnitOfMeasure\": \"Feet\",\n \"packagingVolume\": 7680,\n \"packagingVolumeUnitOfMeasure\": \"CubicFeet\",\n \"insuranceValue\": 1000,\n \"pallets\": 1,\n \"palletSpaces\": 1,\n \"nationalMotorFreightClass\": \"50\",\n \"hazardousProperties\": {\n \"description\": \"Hazardous Material\",\n \"technicalName\": \"Technically Hazardous\",\n \"unNumber\": \"2796\",\n \"classCode\": \"8\",\n \"packagingGroup\": \"Group I\",\n \"emergencyPhone\": \"911\",\n \"authCode\": \"D\",\n \"isPlacarded\": false,\n \"isReportableQuantity\": false,\n \"isPrimaryCommodity\": false,\n \"isNOSCommodity\": false\n },\n \"upcNumber\": \"1234567890\",\n \"skuNumber\": \"01234-001-F10-6\",\n \"isStackable\": false,\n \"isTemperatureSensitive\": true,\n \"temperatureType\": \"Dry\",\n \"temperatureUnit\": \"Celsius\",\n \"requiredTemperatureHigh\": 32,\n \"requiredTemperatureLow\": 0,\n \"referenceNumbers\": [\n {\n \"type\": \"PO\",\n \"value\": \"SIMPPO67890\"\n }\n ]\n }\n ],\n \"collectOnDelivered\": [\n {\n \"amount\": 153.24,\n \"paymentType\": \"CC\",\n \"payableTo\": \"John Doe\",\n \"mailTo\": \"Jane Doe\",\n \"address\": {\n \"address1\": \"14800 Charlson Rd\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 5\",\n \"address4\": \"Room 212\",\n \"city\": \"Eden Prairie\",\n \"county\": \"Hennepin\",\n \"lat\": 34.1548,\n \"long\": -84.46578,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55347\",\n \"country\": \"US\"\n },\n \"referenceNumbers\": [\n {\n \"type\": \"MBOL\",\n \"value\": \"12345687\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"PRO\",\n \"value\": \"SIMPPRO67890\"\n }\n ]\n }\n ],\n \"measurementSystem\": \"Standard\",\n \"referenceNumbers\": [\n {\n \"type\": \"CON\",\n \"value\": \"CON12321NOC\"\n },\n {\n \"type\": \"JNO\",\n \"value\": \"NOT A REAL ORDER!!!!!!!!!!\"\n }\n ],\n \"loadValues\":\n {\n \"equipmentLength\": 48,\n \"equipmentWidth\": 9,\n \"trailerNum\": \"T1234567\"\n },\n \"onlineParties\": [\n {\n \"partyType\": \"CUSTOMER\",\n \"partyCode\": \"C1\",\n \"relationshipIdentifier\": \"456123\"\n }\n ],\n \"notes\": \"Created through Schema Test\"\n}\")\n .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'PUT',\n \turl: 'https://sandbox-api.navisphere.com/v1/orders',\n \theaders: \n \t{ Authorization: 'Bearer YOU TOKEN',\n \t\t'Content-Type': 'application/json' },\n \tbody: { \n \tcustomers: \n \t\t[ { customerCode: 'C8283603', \n \t\t\tcontacts: \n \t\t\t[ { name: 'Contact One',\n \t\t\t\ttype: 'Contact',\n \t\t\t\tcompanyName: 'Customer One',\n \t\t\t\tcontactMethods: [ { method: 'Phone', value: '5554678415' } ] } ],\n \t\t\treferenceNumbers: [ { type: 'MBOL', value: 'SIMPMBOL67890' } ] } ],\n \tbillTos: \n \t\t[ { customerCode: 'C8283603',\n \t\t\tcharges: \n \t\t\t[ { rate: 132.45,\n \t\t\t\trateCode: '405',\n \t\t\t\talternateDescription: 'Fuel Surcharge' } ],\n \t\t\tcurrencyCode: 'USD',\n \t\t\tcontacts: \n \t\t\t[ { name: 'Contact One',\n \t\t\t\ttype: 'Contact',\n \t\t\t\tcompanyName: 'Customer One',\n \t\t\t\tcontactMethods: [ { method: 'Phone', value: '5554678415' } ] } ],\n \t\t\treferenceNumbers: [ { type: 'SHID', value: 'SIMPSHID67890' } ] } ],\n \tservices: \n \t\t[ { serviceLevel: 'Standard',\n \t\t\tsellMode: 'TL',\n \t\t\tlocations: \n \t\t\t[ { customerLocationId: 'W541849',\n \t\t\t\ttype: 'origin',\n \t\t\t\tname: 'Origin Location',\n \t\t\t\taddress: { \n \t\t\t\t\taddress1: '14800 Charlson Rd',\n \t\t\t\t\taddress2: 'Building 1',\n \t\t\t\t\taddress3: 'Floor 2',\n \t\t\t\t\taddress4: 'Room 212',\n \t\t\t\t\tcity: 'Eden Prairie',\n \t\t\t\t\tcounty: 'Hennepin',\n \t\t\t\t\tlat: 31.717096,\n \t\t\t\t\tlong: -99.132553,\n \t\t\t\t\tstateProvinceCode: 'MN',\n \t\t\t\t\tpostalCode: '55347',\n \t\t\t\t\tcountry: 'US' },\n \t\t\t\topenDateTime: '2019-03-18T17:23:48.983Z',\n \t\t\t\tcloseDateTime: '2019-03-19T17:23:48.984Z',\n \t\t\t\tscheduledOpenDateTime: '2019-03-18T17:23:48.983Z',\n \t\t\t\tscheduledCloseDateTime: '2019-03-19T17:23:48.984Z',\n \t\t\t\tscalesRequired: false,\n \t\t\t\thasDropTrailer: false,\n \t\t\t\tspecialInstructions: 'Stay hungry. Stay foolish. -Steve Jobs',\n \t\t\t\tcontacts:[ { \n \t\t\t\t\tname: 'Warehouse Contact',\n \t\t\t\t\ttype: 'Contact',\n \t\t\t\t\tcompanyName: 'Warehouse One',\n \t\t\t\t\tcontactMethods: [ { method: 'Phone', value: '5554678415' } ] } ],\n \t\t\t\treferenceNumbers: [ { type: 'PU', value: 'SIMPPU67890' } ] },{ \n \t\t\t\tcustomerLocationId: 'W541849',\n \t\t\t\ttype: 'destination',\n \t\t\t\tname: 'Destination Location',\n \t\t\t\taddress: { \n \t\t\t\t\taddress1: '800 Washington Avenue North',\n \t\t\t\t\taddress2: 'Building 1',\n \t\t\t\t\taddress3: 'Floor 5',\n \t\t\t\t\taddress4: 'Suite 550',\n \t\t\t\t\tcity: 'Minneapolis',\n \t\t\t\t\tcounty: 'Hennepin',\n \t\t\t\t\tlat: 44.989386,\n \t\t\t\t\tlong: -93.278626,\n \t\t\t\t\tstateProvinceCode: 'MN',\n \t\t\t\t\tpostalCode: '55401',\n \t\t\t\t\tcountry: 'US' },\n \t\t\t\topenDateTime: '2019-03-25T17:23:48.984Z',\n \t\t\t\tcloseDateTime: '2019-03-26T17:23:48.984Z',\n \t\t\t\tscheduledOpenDateTime: '2019-03-25T17:23:48.984Z',\n \t\t\t\tscheduledCloseDateTime: '2019-03-26T17:23:48.984Z',\n \t\t\t\tscalesRequired: false,\n \t\t\t\thasDropTrailer: false,\n \t\t\t\tspecialInstructions: 'Whatever you are, be a good one. -Abraham Lincoln',\n \t\t\t\tcontacts: [ { \n \t\t\t\t\tname: 'Contact two',\n \t\t\t\t\ttype: 'Contact',\n \t\t\t\t\tcompanyName: 'Warehouse Two',\n \t\t\t\t\tcontactMethods: [ { method: 'Phone', value: '5554678415' } ] } ],\n \t\t\t\treferenceNumbers: [ { type: 'DEL', value: 'SIMPDEL67890' } ] } ],\n \t\t\titems: [ { \n \t\t\t\tpackagingType: 'Case',\n \t\t\t\tquantity: 50,\n \t\t\t\tdescription: 'Widgets',\n \t\t\t\tproductCode: '123-45',\n \t\t\t\tfreightClass: '70',\n \t\t\t\tweight: 45000,\n \t\t\t\tweightUnitOfMeasure: 'Pounds',\n \t\t\t\tpackagingLength: 2,\n \t\t\t\tpackagingWidth: 2,\n \t\t\t\tpackagingHeight: 2,\n \t\t\t\tpackagingUnitOfMeasure: 'Inches',\n \t\t\t\tequipmentLength: 48,\n \t\t\t\tequipmentHeight: 9,\n \t\t\t\tequipmentWidth: 8,\n \t\t\t\tequipmentUnitOfMeasure: 'Feet',\n \t\t\t\tpackagingVolume: 7680,\n \t\t\t\tpackagingVolumeUnitOfMeasure: 'CubicFeet',\n \t\t\t\tinsuranceValue: 1000,\n \t\t\t\tpallets: 1,\n \t\t\t\tpalletSpaces: 1,\n \t\t\t\tnationalMotorFreightClass: '50',\n \t\t\t\thazardousProperties: { \n \t\t\t\t\tdescription: 'Hazardous Material',\n \t\t\t\t\ttechnicalName: 'Technically Hazardous',\n \t\t\t\t\tunNumber: '2796',\n \t\t\t\t\tclassCode: '8',\n \t\t\t\t\tpackagingGroup: 'Group I',\n \t\t\t\t\temergencyPhone: '911',\n \t\t\t\t\tauthCode: 'D',\n \t\t\t\t\tisPlacarded: false,\n \t\t\t\t\tisReportableQuantity: false,\n \t\t\t\t\tisPrimaryCommodity: false,\n \t\t\t\t\tisNOSCommodity: false },\n \t\t\t\tupcNumber: '1234567890',\n \t\t\t\tskuNumber: '01234-001-F10-6',\n \t\t\t\tisStackable: false,\n \t\t\t\tisTemperatureSensitive: true,\n \t\t\t\ttemperatureType: 'Dry',\n \t\t\t\ttemperatureUnit: 'Celsius',\n \t\t\t\trequiredTemperatureHigh: 32,\n \t\t\t\trequiredTemperatureLow: 0,\n \t\t\t\treferenceNumbers: [ { type: 'PO', value: 'SIMPPO67890' } ] } ],\n \t\t\tcollectOnDelivered: [ { \n \t\t\t\tamount: 153.24,\n \t\t\t\tpaymentType: 'CC',\n \t\t\t\tpayableTo: 'John Doe',\n \t\t\t\tmailTo: 'Jane Doe',\n \t\t\t\taddress: { \n \t\t\t\t\taddress1: '14800 Charlson Rd',\n \t\t\t\t\taddress2: 'Building 1',\n \t\t\t\t\taddress3: 'Floor 5',\n \t\t\t\t\taddress4: 'Room 212',\n \t\t\t\t\tcity: 'Eden Prairie',\n \t\t\t\t\tcounty: 'Hennepin',\n \t\t\t\t\tlat: 34.1548,\n \t\t\t\t\tlong: -84.46578,\n \t\t\t\t\tstateProvinceCode: 'MN',\n \t\t\t\t\tpostalCode: '55347',\n \t\t\t\t\tcountry: 'US' },\n \t\t\t\treferenceNumbers: [ { type: 'MBOL', value: '12345687' } ] } ],\n \t\t\treferenceNumbers: [ { type: 'PRO', value: 'SIMPPRO67890' } ], \t\t\tisTeam: false } ],\n \t\tmeasurementSystem: 'Standard',\n \t\treferenceNumbers: [ { \n \t\t\ttype: 'CON', value: 'CON12321NOC' },{ \n \t\t\ttype: 'JNO', value: 'NOT A REAL ORDER!!!!!!!!!!' } ],\n \t\tloadValues:\n \t\t{ \n \t\t\tequipmentLength: 48 \n \t\t\tequipmentWidth: 9 \n \t\t\ttrailerNum: 'T1234567' \n \t\t}, \n \t\tonlineParties: [ { partyType: 'CUSTOMER', partyCode: 'C1', relationshipIdentifier: '456123' } ],\n \t\tnotes: 'Created through Schema Test' },\n \tjson: true };\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/orders\"); \n var request = new RestRequest(Method.PUT); \n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\"); \n request.AddHeader(\"Content-Type\", \"application/json\"); \n request.AddParameter(\"undefined\", \" {\n \"customers\": [\n {\n \"customerCode\": \"C8283603\",\n \"contacts\": [\n {\n \"name\": \"Contact One\",\n \"type\": \"Contact\",\n \"companyName\": \"Customer One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"MBOL\",\n \"value\": \"SIMPMBOL67890\"\n }\n ]\n }\n ],\n \"billTos\": [\n {\n \"customerCode\": \"C8283603\",\n \"charges\": [\n {\n \"rate\": 132.45,\n \"rateCode\": \"405\",\n \"alternateDescription\": \"Fuel Surcharge\"\n }\n ],\n \"currencyCode\": \"USD\",\n \"contacts\": [\n {\n \"name\": \"Contact One\",\n \"type\": \"Contact\",\n \"companyName\": \"Customer One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"SHID\",\n \"value\": \"SIMPSHID67890\"\n }\n ]\n }\n ],\n \"services\": [\n {\n \"serviceLevel\": \"Standard\",\n \"sellMode\": \"TL\",\n \"locations\": [\n {\n \"customerLocationId\": \"W541849\",\n \"type\": \"origin\",\n \"name\": \"Origin Location\",\n \"address\": {\n \"address1\": \"14800 Charlson Rd\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 2\",\n \"address4\": \"Room 212\",\n \"city\": \"Eden Prairie\",\n \"county\": \"Hennepin\",\n \"lat\": 31.717096,\n \"long\": -99.132553,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55347\",\n \"country\": \"US\"\n },\n \"openDateTime\": \"2019-03-18T17:23:48.983Z\",\n \"closeDateTime\": \"2019-03-19T17:23:48.984Z\",\n \"scheduledOpenDateTime\": \"2019-03-18T17:23:48.983Z\",\n \"scheduledCloseDateTime\": \"2019-03-19T17:23:48.984Z\",\n \"scalesRequired\": false,\n \"hasDropTrailer\": false,\n \"specialInstructions\": \"Stay hungry. Stay foolish. -Steve Jobs\",\n \"contacts\": [\n {\n \"name\": \"Warehouse Contact\",\n \"type\": \"Contact\",\n \"companyName\": \"Warehouse One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"PU\",\n \"value\": \"SIMPPU67890\"\n }\n ]\n },\n {\n \"customerLocationId\": \"W541849\",\n \"type\": \"destination\",\n \"name\": \"Destination Location\",\n \"address\": {\n \"address1\": \"800 Washington Avenue North\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 5\",\n \"address4\": \"Suite 550\",\n \"city\": \"Minneapolis\",\n \"county\": \"Hennepin\",\n \"lat\": 44.989386,\n \"long\": -93.278626,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55401\",\n \"country\": \"US\"\n },\n \"openDateTime\": \"2019-03-25T17:23:48.984Z\",\n \"closeDateTime\": \"2019-03-26T17:23:48.984Z\",\n \"scheduledOpenDateTime\": \"2019-03-25T17:23:48.984Z\",\n \"scheduledCloseDateTime\": \"2019-03-26T17:23:48.984Z\",\n \"scalesRequired\": false,\n \"hasDropTrailer\": false,\n \"specialInstructions\": \"Whatever you are, be a good one. -Abraham Lincoln\",\n \"contacts\": [\n {\n \"name\": \"Contact two\",\n \"type\": \"Contact\",\n \"companyName\": \"Warehouse Two\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"DEL\",\n \"value\": \"SIMPDEL67890\"\n }\n ]\n }\n ],\n \"items\": [\n {\n \"packagingType\": \"Case\",\n \"quantity\": 50,\n \"description\": \"Widgets\",\n \"productCode\": \"123-45\",\n \"freightClass\": \"70\",\n \"weight\": 45000,\n \"weightUnitOfMeasure\": \"Pounds\",\n \"packagingLength\": 2,\n \"packagingWidth\": 2,\n \"packagingHeight\": 2,\n \"packagingUnitOfMeasure\": \"Inches\",\n \"equipmentLength\": 48,\n \"equipmentHeight\": 9,\n \"equipmentWidth\": 8,\n \"equipmentUnitOfMeasure\": \"Feet\",\n \"packagingVolume\": 7680,\n \"packagingVolumeUnitOfMeasure\": \"CubicFeet\",\n \"insuranceValue\": 1000,\n \"pallets\": 1,\n \"palletSpaces\": 1,\n \"nationalMotorFreightClass\": \"50\",\n \"hazardousProperties\": {\n \"description\": \"Hazardous Material\",\n \"technicalName\": \"Technically Hazardous\",\n \"unNumber\": \"2796\",\n \"classCode\": \"8\",\n \"packagingGroup\": \"Group I\",\n \"emergencyPhone\": \"911\",\n \"authCode\": \"D\",\n \"isPlacarded\": false,\n \"isReportableQuantity\": false,\n \"isPrimaryCommodity\": false,\n \"isNOSCommodity\": false\n },\n \"upcNumber\": \"1234567890\",\n \"skuNumber\": \"01234-001-F10-6\",\n \"isStackable\": false,\n \"isTemperatureSensitive\": true,\n \"temperatureType\": \"Dry\",\n \"temperatureUnit\": \"Celsius\",\n \"requiredTemperatureHigh\": 32,\n \"requiredTemperatureLow\": 0,\n \"referenceNumbers\": [\n {\n \"type\": \"PO\",\n \"value\": \"SIMPPO67890\"\n }\n ]\n }\n ],\n \"collectOnDelivered\": [\n {\n \"amount\": 153.24,\n \"paymentType\": \"CC\",\n \"payableTo\": \"John Doe\",\n \"mailTo\": \"Jane Doe\",\n \"address\": {\n \"address1\": \"14800 Charlson Rd\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 5\",\n \"address4\": \"Room 212\",\n \"city\": \"Eden Prairie\",\n \"county\": \"Hennepin\",\n \"lat\": 34.1548,\n \"long\": -84.46578,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55347\",\n \"country\": \"US\"\n },\n \"referenceNumbers\": [\n {\n \"type\": \"MBOL\",\n \"value\": \"12345687\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"PRO\",\n \"value\": \"SIMPPRO67890\"\n }\n ]\n }\n ],\n \"measurementSystem\": \"Standard\",\n \"referenceNumbers\": [\n {\n \"type\": \"CON\",\n \"value\": \"CON12321NOC\"\n },\n {\n \"type\": \"JNO\",\n \"value\": \"NOT A REAL ORDER!!!!!!!!!!\"\n }\n ],\n \"loadValues\":\n {\n \"equipmentLength\": 48,\n \"equipmentWidth\": 9,\n \"trailerNum\": \"T1234567\"\n },\n \"onlineParties\":\n [{\n \"partyType\": \"CUSTOMER\",\n \"partyCode\": \"C1\",\n \"relationshipIdentifier\": \"456123\"\n }],\n \"notes\": \"Created through Schema Test\"\n}\", ParameterType.RequestBody);\n IRestResponse response = client.Execute(request);" responses: '200': description: Request successful '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' example: - message: '"referenceNumber" is not allowed' path: - services - 0 - locations - 0 - referenceNumber type: object.allowUnknown context: child: referenceNumber value: - type: PU value: SIMPPU67890 key: referenceNumber label: referenceNumber '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v1/orders/quotes: post: description: "Allows partner to create an order in C.H. Robinson's Navisphere® Order Management system using a Quote ID. See [Rating](https://developer.chrobinson.com/api-reference#tag/Rating) for more information on retrieving quotes.\n\nThe powerful quote to order process eliminates the need for time consuming double entry. Our customers only need to input information into their ERP or TMS systems once, and get their quotes and execute orders with the click of a couple of buttons." operationId: Order Create with Quote ID tags: - Orders and Booking requestBody: description: JSON array of quote to order information. required: true content: application/json: schema: $ref: '#/components/schemas/quotes' example: - quoteId: '320008172' customer: customerCode: C8283603 contacts: - name: Contact One type: Contact companyName: Customer One contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: MBOL value: Q2OMBOL54971564 billTo: contacts: - name: Contact One type: Contact companyName: Customer One contactMethods: - method: Phone value: '5554678415' referenceNumbers: - type: SHID value: Q2OSHID54971564 service: referenceNumbers: - type: PRO value: Q2OPro123456789 suggestedScac: '4695' suggestedCarrierPartyCode: T2383 origin: customerLocationId: W13246 name: Origin Location address: address1: 14800 Charlson Rd address2: Building 1 address3: Floor 5 address4: Room 212 city: Eden Prairie county: Hennepin lat: 31.717096 long: -99.132553 stateProvinceCode: MN postalCode: '55347' country: US phone: '5558675309' emailAddress: jsmith@customer1.com contactName: John Smith openDateTime: '2019-03-18T18:24:14.782Z' closeDateTime: '2019-03-18T18:24:14.782Z' specialInstructions: Notes go here referenceNumbers: - type: PU value: Q2OPro123456789 destination: customerLocationId: W13246 name: Destination Location address: address1: 800 Washington Avenue North address2: Building 1 address3: Floor 5 address4: Suite 550 city: Minneapolis county: Hennepin lat: 44.989386 long: -93.278626 stateProvinceCode: MN postalCode: '55401' country: US phone: '5558675309' emailAddress: jsmith@customer1.com contactName: John Smith openDateTime: '2019-03-19T18:24:14.782Z' closeDateTime: '2019-03-19T18:24:14.782Z' specialInstructions: Notes go here referenceNumbers: - type: DEL value: Q2OPro123456789 onlineParties: - partyType: "CUSTOMER" partyCode: "C1" relationshipIdentifier: "456123" notes: Notes go here referenceNumbers: - type: SHIPWITH value: Q2O12345687 x-code-samples: - lang: Curl source: "curl -X POST \\ \n https://sandbox-api.navisphere.com/v1/orders/quotes \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json' \\ \n -d '[{\n \t\"quoteId\": \"320008172\",\n \t\"customer\": {\n \t\t\"customerCode\": \"C8283603\",\n \t\t\"contacts\": [{\n \t\t\t\"name\": \"Contact One\",\n \t\t\t\"type\": \"Contact\",\n \t\t\t\"companyName\": \"Customer One\",\n \t\t\t\"contactMethods\": [{ \n \t\t\t\t\"method\": \"Phone\",\n \t\t\t\t\"value\": \"5554678415\"\n \t\t\t}]\n \t\t}],\n \t\t\"referenceNumbers\": [{\n \t\t\t\"type\": \"MBOL\",\n \t\t\t\"value\": \"Q2OMBOL54971564\"\n \t\t}]\n \t},\n \t\"billTo\": {\n \t\t\"contacts\": [{\n \t\t\t\"name\": \"Contact One\",\n \t\t\t\"type\": \"Contact\",\n \t\t\t\"companyName\": \"Customer One\",\n \t\t\t\"contactMethods\": [{\n \t\t\t\t\"method\": \"Phone\",\n \t\t\t\t\"value\": \"5554678415\"\n \t\t\t}]\n \t\t}],\n \t\t\"referenceNumbers\": [{\n \t\t\t\t\"type\": \"SHID\",\n \t\t\t\t\"value\": \"Q2OSHID54971564\"\n \t\t}]\n \t},\n \t\"service\": {\n \t\t\"referenceNumbers\": [{\n \t\t\t\"type\": \"PRO\",\n \t\t\t\"value\": \"Q2OPro123456789\"\n \t\t]\n \t},\n \t\"origin\": {\n \t\t\"customerLocationId\": \"W13246\",\n \t\t\"locationName\": \"Origin Location\",\n \t\t\"address\": {\n \t\t\t\"address1\": \"14800 Charlson Rd\",\n \t\t\t\"address2\": \"Building 1\",\n \t\t\t\"address3\": \"Floor 5\",\n \t\t\t\"address4\": \"Room 212\",\n \t\t\t\"city\": \"Eden Prairie\",\n \t\t\t\"county\": \"Hennepin\",\n \t\t\t\"lat\": 31.717096,\n \t\t\t\"long\": -99.132553,\n \t\t\t\"stateProvinceCode\": \"MN\",\n \t\t\t\"postalCode\": \"55347\",\n \t\t\t\"country\": \"US\"\n \t\t},\n \t\t\"phone\": \"5558675309\",\n \t\t\"emailAddress\": \"jsmith@customer1.com\",\n \t\t\"contactName\": \"John Smith\",\n \t\t\"requestedShipDateOpen\": \"2019-03-18T18:24:14.782Z\",\n \t\t\"requestedShipDateClose\": \"2019-03-18T18:24:14.782Z\",\n \t\t\"specialInstructions\": \"Notes go here\"\n \t},\n \t\"destination\": {\n \t\t\"customerLocationId\": \"W13246\",\n \t\t\"locationName\": \"Destination Location\",\n \t\t\"address\": {\n \t\t\t\"address1\": \"800 Washington Avenue North\",\n \t\t\t\"address2\": \"Building 1\",\n \t\t\t\"address3\": \"Floor 5\",\n \t\t\t\"address4\": \"Suite 550\",\n \t\t\t\"city\": \"Minneapolis\",\n \t\t\t\"county\": \"Hennepin\",\n \t\t\t\"lat\": 44.989386,\n \t\t\t\"long\": -93.278626,\n \t\t\t\"stateProvinceCode\": \"MN\",\n \t\t\t\"postalCode\": \"55401\",\n \t\t\t\"country\": \"US\"\n \t\t},\n \t\t\"phone\": \"5558675309\",\n \t\t\"emailAddress\": \"jsmith@customer1.com\",\n \t\t\"contactName\": \"John Smith\",\n \t\t\"requestedShipDateOpen\": \"2019-03-19T18:24:14.782Z\",\n \t\t\"requestedShipDateClose\": \"2019-03-19T18:24:14.782Z\",\n \t\t\"specialInstructions\": \"Notes go here\"\n \t},\n \t\"onlineParties\": [{\n \t\t\"partyType\": \"CUSTOMER\",\n \t\t\"partyCode\": \"C1\",\n \t\t\"relationshipIdentifier\": \"456123\"\n \t}],\n \t\"notes\": \"Notes go here\",\n \t\"referenceNumbers\": [{\n \t\t\"type\": \"SHIPWITH\",\n \t\t\"value\": \"Q2O12345687\"\n \t}]\n }]'" - lang: Java source: "HttpResponse response = Unirest.post(\"https://sandbox-api.navisphere.com/v1/orders/quotes\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .body(\"[\n {\n \"quoteId\": \"320008172\",\n \"customer\": {\n \"customerCode\": \"C8283603\",\n \"contacts\": [\n {\n \"name\": \"Contact One\",\n \"type\": \"Contact\",\n \"companyName\": \"Customer One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"MBOL\",\n \"value\": \"Q2OMBOL54971564\"\n }\n ]\n },\n \"billTo\": {\n \"contacts\": [\n {\n \"name\": \"Contact One\",\n \"type\": \"Contact\",\n \"companyName\": \"Customer One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"SHID\",\n \"value\": \"Q2OSHID54971564\"\n }\n ]\n },\n \"service\": {\n \"referenceNumbers\": [\n {\n \"type\": \"PRO\",\n \"value\": \"Q2OPro123456789\"\n }\n ]\n },\n \"origin\": {\n \"customerLocationId\": \"W13246\",\n \"locationName\": \"Origin Location\",\n \"address\": {\n \"address1\": \"14800 Charlson Rd\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 5\",\n \"address4\": \"Room 212\",\n \"city\": \"Eden Prairie\",\n \"county\": \"Hennepin\",\n \"lat\": 31.717096,\n \"long\": -99.132553,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55347\",\n \"country\": \"US\"\n },\n \"phone\": \"5558675309\",\n \"emailAddress\": \"jsmith@customer1.com\",\n \"contactName\": \"John Smith\",\n \"requestedShipDateOpen\": \"2019-03-18T18:24:14.782Z\",\n \"requestedShipDateClose\": \"2019-03-18T18:24:14.782Z\",\n \"specialInstructions\": \"Notes go here\"\n },\n \"destination\": {\n \"customerLocationId\": \"W13246\",\n \"locationName\": \"Destination Location\",\n \"address\": {\n \"address1\": \"800 Washington Avenue North\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 5\",\n \"address4\": \"Suite 550\",\n \"city\": \"Minneapolis\",\n \"county\": \"Hennepin\",\n \"lat\": 44.989386,\n \"long\": -93.278626,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55401\",\n \"country\": \"US\"\n },\n \"phone\": \"5558675309\",\n \"emailAddress\": \"jsmith@customer1.com\",\n \"contactName\": \"John Smith\",\n \"requestedShipDateOpen\": \"2019-03-19T18:24:14.782Z\",\n \"requestedShipDateClose\": \"2019-03-19T18:24:14.782Z\",\n \"specialInstructions\": \"Notes go here\"\n },\n \"onlineParties\": [\n {\n \"partyType\": \"CUSTOMER\",\n \"partyCode\": \"C1\",\n \"relationshipIdentifier\": \"456123\"\n }\n ],\n \"notes\": \"Notes go here\",\n \"referenceNumbers\": [\n {\n \"type\": \"SHIPWITH\",\n \"value\": \"Q2O12345687\"\n }\n ]\n }\n]\")\n .asString();" - lang: NodeJS source: " var request = require(\"request\");\n\n var options = { method: 'POST',\n \turl: 'https://sandbox-api.navisphere.com/v1/orders/quotes',\n \theaders: \n \t{ Authorization: 'Bearer YOU TOKEN',\n \t'Content-Type': 'application/json' },\n \tbody: [ { \n \t\tquoteId: '320008172',\n \t\tcustomer: { \n \t\t\tcustomerCode: 'C8283603',\n \t\t\tcontacts: [ { \n \t\t\t\tname: 'Contact One',\n \t\t\t\ttype: 'Contact',\n \t\t\t\tcompanyName: 'Customer One',\n \t\t\t\tcontactMethods: [ { method: 'Phone', value: '5554678415' } ] } ],\n \t\t\treferenceNumbers: [ { type: 'MBOL', value: 'Q2OMBOL54971564' } ] },\n \t\tbillTo: { \n \t\t\tcontacts: [ { name: 'Contact One',\n \t\t\t\ttype: 'Contact',\n \t\t\t\tcompanyName: 'Customer One',\n \t\t\t\tcontactMethods: [ { method: 'Phone', value: '5554678415' } ] } ],\n \t\t\treferenceNumbers: [ { type: 'SHID', value: 'Q2OSHID54971564' } ] \n \t\t},\n \t\tservice: { referenceNumbers: [ { type: 'PRO', value: 'Q2OPro123456789' } ] },\n \t\torigin: { \n \t\t\tcustomerLocationId: 'W13246',\n \t\t\tlocationName: 'Origin Location',\n \t\t\taddress: {\n \t\t\t\taddress1: '14800 Charlson Rd',\n \t\t\t\taddress2: 'Building 1',\n \t\t\t\taddress3: 'Floor 5',\n \t\t\t\taddress4: 'Room 212',\n \t\t\t\tcity: 'Eden Prairie',\n \t\t\t\tcounty: 'Hennepin',\n \t\t\t\tlat: 31.717096,\n \t\t\t\tlong: -99.132553,\n \t\t\t\tstateProvinceCode: 'MN',\n \t\t\t\tpostalCode: '55347',\n \t\t\t\tcountry: 'US' },\n \t\t\tphone: '5558675309',\n \t\t\temailAddress: 'jsmith@customer1.com',\n \t\t\tcontactName: 'John Smith',\n \t\t\trequestedShipDateOpen: '2019-03-18T18:24:14.782Z',\n \t\t\trequestedShipDateClose: '2019-03-18T18:24:14.782Z',\n \t\t\tspecialInstructions: 'Notes go here' },\n \t\tdestination: { \n \t\t\tcustomerLocationId: 'W13246',\n \t\t\tlocationName: 'Destination Location',\n \t\t\taddress: { \n \t\t\t\taddress1: '800 Washington Avenue North',\n \t\t\t\taddress2: 'Building 1',\n \t\t\t\taddress3: 'Floor 5',\n \t\t\t\taddress4: 'Suite 550',\n \t\t\t\tcity: 'Minneapolis',\n \t\t\t\tcounty: 'Hennepin',\n \t\t\t\tlat: 44.989386,\n \t\t\t\tlong: -93.278626,\n \t\t\t\tstateProvinceCode: 'MN',\n \t\t\t\tpostalCode: '55401',\n \t\t\t\tcountry: 'US' },\n \t\t\tphone: '5558675309',\n \t\t\temailAddress: 'jsmith@customer1.com',\n \t\t\tcontactName: 'John Smith',\n \t\t\trequestedShipDateOpen: '2019-03-19T18:24:14.782Z',\n \t\t\trequestedShipDateClose: '2019-03-19T18:24:14.782Z',\n \t\t\tspecialInstructions: 'Notes go here' },\n \t\tonlineParties: [ { partyType: 'CUSTOMER', partyCode: 'C1', relationshipIdentifier: '456123' } ],\n \t\tnotes: 'Notes go here',\n \t\treferenceNumbers: [ { type: 'SHIPWITH', value: 'Q2O12345687' } ] } ],\n \tjson: true };\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/orders/quotes\");\n var request = new RestRequest(Method.POST);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n request.AddParameter(\"undefined\", \"[\n {\n \"quoteId\": \"320008172\",\n \"customer\": {\n \"customerCode\": \"C8283603\",\n \"contacts\": [\n {\n \"name\": \"Contact One\",\n \"type\": \"Contact\",\n \"companyName\": \"Customer One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"MBOL\",\n \"value\": \"Q2OMBOL54971564\"\n }\n ]\n },\n \"billTo\": {\n \"contacts\": [\n {\n \"name\": \"Contact One\",\n \"type\": \"Contact\",\n \"companyName\": \"Customer One\",\n \"contactMethods\": [\n {\n \"method\": \"Phone\",\n \"value\": \"5554678415\"\n }\n ]\n }\n ],\n \"referenceNumbers\": [\n {\n \"type\": \"SHID\",\n \"value\": \"Q2OSHID54971564\"\n }\n ]\n },\n \"service\": {\n \"referenceNumbers\": [\n {\n \"type\": \"PRO\",\n \"value\": \"Q2OPro123456789\"\n }\n ]\n },\n \"origin\": {\n \"customerLocationId\": \"W13246\",\n \"locationName\": \"Origin Location\",\n \"address\": {\n \"address1\": \"14800 Charlson Rd\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 5\",\n \"address4\": \"Room 212\",\n \"city\": \"Eden Prairie\",\n \"county\": \"Hennepin\",\n \"lat\": 31.717096,\n \"long\": -99.132553,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55347\",\n \"country\": \"US\"\n },\n \"phone\": \"5558675309\",\n \"emailAddress\": \"jsmith@customer1.com\",\n \"contactName\": \"John Smith\",\n \"requestedShipDateOpen\": \"2019-03-18T18:24:14.782Z\",\n \"requestedShipDateClose\": \"2019-03-18T18:24:14.782Z\",\n \"specialInstructions\": \"Notes go here\"\n },\n \"destination\": {\n \"customerLocationId\": \"W13246\",\n \"locationName\": \"Destination Location\",\n \"address\": {\n \"address1\": \"800 Washington Avenue North\",\n \"address2\": \"Building 1\",\n \"address3\": \"Floor 5\",\n \"address4\": \"Suite 550\",\n \"city\": \"Minneapolis\",\n \"county\": \"Hennepin\",\n \"lat\": 44.989386,\n \"long\": -93.278626,\n \"stateProvinceCode\": \"MN\",\n \"postalCode\": \"55401\",\n \"country\": \"US\"\n },\n \"phone\": \"5558675309\",\n \"emailAddress\": \"jsmith@customer1.com\",\n \"contactName\": \"John Smith\",\n \"requestedShipDateOpen\": \"2019-03-19T18:24:14.782Z\",\n \"requestedShipDateClose\": \"2019-03-19T18:24:14.782Z\",\n \"specialInstructions\": \"Notes go here\"\n },\n \"onlineParties\":\n [{\n \"partyType\": \"CUSTOMER\",\n \"partyCode\": \"C1\",\n \"relationshipIdentifier\": \"456123\"\n }], \n \"notes\": \"Notes go here\",\n \"referenceNumbers\": [\n {\n \"type\": \"SHIPWITH\",\n \"value\": \"Q2O12345687\"\n }\n ]\n }\n]\", ParameterType.RequestBody);\n IRestResponse response = client.Execute(request);" responses: '201': description: Request successful content: application/json: schema: $ref: '#/components/schemas/quoteOrderResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v1/orders/{orderNumber}: delete: description: Allows partner to delete an existing order in C.H. Robinson's Navisphere® Order Management system. operationId: Order Delete tags: - Orders and Booking parameters: - name: orderNumber in: path description: The order number required: true schema: type: integer x-code-samples: - lang: Curl source: "curl -X DELETE \\ \n https://sandbox-api.navisphere.com/v1/orders/123456 \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json'" - lang: Java source: "HttpResponse response = Unirest.delete(\"https://sandbox-api.navisphere.com/v1/orders/123456\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'DELETE',\n \turl: 'https://sandbox-api.navisphere.com/v1/orders/123456',\n \theaders: \n \t{ Authorization: 'Bearer YOU TOKEN', \n \t'Content-Type': 'application/json' } }; \n \n request(options, function (error, response, body) { \n \tif (error) throw new Error(error); \n \n \tconsole.log(body); \n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/orders/123456\");\n var request = new RestRequest(Method.DELETE);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n IRestResponse response = client.Execute(request);" responses: '200': description: Request successful '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' example: message: '"value" must be an object' path: [] type: object.base context: value: label: value '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v1/gfbookings: servers: - url: https://test-api.navisphereconnect.com description: Test environment. - url: https://api.navisphereconnect.com description: Production environment. post: description: "Allows partner to send a Global Forwarding Booking request to CH Robinson's Navisphere system" x-beta: true operationId: Booking Create tags: - Orders and Booking requestBody: description: JSON object of shipment information. required: true content: application/json: schema: $ref: '#/components/schemas/gfBooking' examples: Payload: value: customerReferenceNumber: "20260507" customerCode: "C8283603" sellMode: "Ocean" incoTerms: "DAP" incoTermsNamedLocation: "New York City" serviceLevel: "DD" freightTerms: "PP" shipperReadyByDateTime: "2026-03-10T00:00:00" parties: - customerPartyId: "EAPITest" customerCode: "C8283603" type: "Shipper" name: "Fly Me to the Moon" address: city: "Hamburg" country: "DE" locations: - customerLocationId: "AR5PL" type: "Pickup" openDateTime: "2026-03-10T00:00:00" referenceNumbers: - type: "DEL" value: "US38" containers: - containerId: 1 type: "40HC" quantity: 1 commodityItems: - containerId: 1 packagingType: "PKG" quantity: 100, pallets: 10, grossWeight: 1, grossWeightUnitOfMeasure: "Kilograms" description: "Medical Equipment" packagesDimensions: - stackable: "No" responses: '200': description: Request successful '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' example: message: '"value" must be an object' path: [] type: object.base context: value: label: value '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. put: description: "Allows partner to send a Global Forwarding Booking request to CH Robinson's Navisphere system" x-beta: true operationId: Booking Update tags: - Orders and Booking requestBody: description: JSON object of shipment information. required: true content: application/json: schema: $ref: '#/components/schemas/gfBooking' examples: Payload: value: customerReferenceNumber: "20260507" customerCode: "C8283603" sellMode: "Ocean" incoTerms: "DAP" incoTermsNamedLocation: "New York City" serviceLevel: "DD" freightTerms: "PP" shipperReadyByDateTime: "2026-03-10T00:00:00" parties: - customerPartyId: "EAPITest" customerCode: "C8283603" type: "Shipper" name: "Fly Me to the Moon" address: city: "Hamburg" country: "DE" locations: - customerLocationId: "AR5PL" type: "Pickup" openDateTime: "2026-03-10T00:00:00" referenceNumbers: - type: "DEL" value: "US38" containers: - containerId: 1 type: "40HC" quantity: 1 commodityItems: - containerId: 1 packagingType: "PKG" quantity: 100, pallets: 10, grossWeight: 1, grossWeightUnitOfMeasure: "Kilograms" description: "Medical Equipment" packagesDimensions: - stackable: "No" responses: '200': description: Request successful '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' example: message: '"value" must be an object' path: [] type: object.base context: value: label: value '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v1/gfbookings?{customerReferenceNumber}&{customerCode}: delete: description: "Allows partner to send a Global Forwarding Booking request to CH Robinson's Navisphere system" x-beta: true operationId: Booking Delete tags: - Orders and Booking parameters: [ { "name": "CustomerReferenceNumber", "in": "query", "description": "Indicates the customer's primary reference number.", "schema": { "type": "string" } }, { "name": "CustomerCode", "in": "query", "description": "Indicates the customer's code.", "schema": { "type": "string" } } ] responses: '200': description: Request successful '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' example: message: '"value" must be an object' path: [] type: object.base context: value: label: value '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. #---Events----------------------------------------------------------------------------------------------- /REPLACE_ME_WITH_YOUR_CALLBACK_URL: servers: - url: https://yourserver.com description: partner defined endpoint post: security: - bearerAuth: [] description: | C.H. Robinson provides a callback solution for our customers. In a Callback integration type (also known as a Webhook or an HTTP Push API), users set up their own API and ask C.H. Robinson to call it whenever an order or shipment update occurs. The callback product provides the following features: - Pushes individual real-time event messages from the Navisphere system to the receiving system for all active transactions. - Allows the partner to choose from a list of event types to receive. - Minimizes outbound calls to CHR systems. **Requirements:** - All that is needed is a URL and an authorization methodology, and C.H. Robinson takes care of the rest. - The URL needs to be a RESTful API that supports `Content-Type: application/json`. **Supported Authorization Strategies:** - Basic Auth (username/password). - OAuth 1.0 - OAuth 2.0 - Api_key - No Auth x-beta: false operationId: Events Callback tags: - Events requestBody: description: JSON object of Load Detail message. required: true content: application/json: schema: $ref: '#/components/schemas/eventResponse' responses: '2XX': description: Your server returns this code if it accepts the callback content: text/plain: schema: type: string example: OK /v2/events: get: security: - bearerAuth: [] description: | For customers that cannot integrate via callbacks, C.H. Robinson also provides an Event Retrieval solution. This retrieval product provides the following features: - Updates from Navisphere are made available in real-time. - Provides available data for all desired transactions, even those in the past, available as one call or one per transaction. - Retrieval intervals are controlled by the partner. - Allows the partner to choose from a list of event types to receive. Compared to the Callback solution, this product has the following weaknesses: - Shipment updates are only as real-time as the interval to call CH Robinson. - Some calls will use unnecessary resources when a call yields no new updates. **Note:** Values are case sensitive, for example, customerReferenceNumber will return different results for MN compared to mn. operationId: Event Retrieval tags: - Events parameters: - in: query name: from required: false schema: type: string format: date-time description: Starting date/time of event search. example: "2019-04-20T20:30:00.0000000Z" - in: query name: to required: false schema: type: string format: date-time description: Ending date/time of event search. example: "2019-04-27T20:30:00.0000000Z" - in: query name: loadNumber required: false schema: type: string description: C.H. Robinson defined shipment number. example: 293045309 - in: query name: orderNumber required: false schema: type: string description: C.H. Robinson defined order number. example: 79308056 - in: query name: billToReferenceNumber required: false schema: type: string description: "Customer bill to reference number. Typically this is the customer's order number. The following special characters are allowed: - _ , . : ; | # * ^ & ! ~ ` /" example: 2120147 - in: query name: customerReferenceNumber required: false schema: type: string description: "Customer reference number. The following special characters are allowed: - _ , . : ; | # * ^ & ! ~ ` /" example: 14411 - in: query name: navisphereTrackingNumber required: false schema: type: string description: C.H. Robinson online tracking reference number. example: "YT6RHXA2PD6PY" - in: query name: eventType required: false schema: type: string description: | Identify specific event(s) you want returned. To select multiple events use a comma-delimited string. If empty, will default to all events.
Possible Event Types: (click to expand)
Order Event:
ORDER CREATED, ORDER REJECTED, ORDER UPDATED, ORDER CANCELED, ORDER COMPLETED Load Event:
LOAD CREATED, LOAD BOOKED, LOAD CANCELLED, PRO NUMBER ADDED Stop Event:
CARRIER ARRIVED, CARRIER DEPARTED, LOAD PICKED UP, LOAD DELIVERED Appointment Event:
APPOINTMENT UPDATED In Transit Event:
IN TRANSIT, IN TRANSIT TO ORIGIN Package In Transit Event:
PACKAGE IN TRANSIT, PACKAGE PICKED UP, PACKAGE DELIVERED Global Forwarding Event:
Generic events (click to expand) SHIPMENT CREATED, SHIPMENT BOOKED, SHIPMENT CANCELLED, CONTAINER CREATED, CONTAINER CANCELLED, CONTAINER UPDATED
Estimated Dates (click to expand) SHIPMENT ESTIMATED DELIVERY DATE CHANGED, ESTIMATED DELIVERY DATE CHANGED, ESTIMATED TIME OF VESSEL DEPARTURE CHANGED, ESTIMATED TIME OF VESSEL ARRIVAL CHANGED, ESTIMATED TIME OF VESSEL ARRIVAL/DEPARTURE CHANGED, ESTIMATED TIME OF FLIGHT DEPARTURE CHANGED, ESTIMATED TIME OF FLIGHT ARRIVAL CHANGED, ESTIMATED TIME OF FLIGHT ARRIVAL/DEPARTURE CHANGED, ESTIMATED ARRIVAL TO DESTINATION RAIL CHANGED
Actual Dates (click to expand)
Pick up warehouse: ARRIVED AT PICKUP, CARGO PICKED UP
Origin ramp: ARRIVED AT ORIGIN RAMP, DEPARTED FROM ORIGIN RAMP
Origin terminal: ARRIVED AT ORIGIN TERMINAL, DEPARTED FROM ORIGIN TERMINAL
Origin port/airport:
Ocean: IN GATE AT ORIGIN PORT, VESSEL DEPARTED FROM ORIGIN PORT
Air: IN GATE AT ORIGIN AIRPORT, FLIGHT DEPARTED FROM ORIGIN AIRPORT
Intermediary port/airport:
Ocean: VESSEL ARRIVED AT INTERMEDIARY PORT, VESSEL DEPARTED FROM INTERMEDIARY PORT
Air: FLIGHT ARRIVED AT INTERMEDIARY AIRPORT, FLIGHT DEPARTED FROM INTERMEDIARY AIRPORT
Destination port/airport:
Ocean: VESSEL ARRIVED AT DESTINATION PORT, OUT GATE FROM DESTINATION PORT
Air: FLIGHT ARRIVED AT DESTINATION AIRPORT, DEPARTED FROM DESTINATION AIRPORT
Destination terminal: ARRIVED AT DESTINATION TERMINAL, DEPARTED FROM DESTINATION TERMINAL
Destination ramp: ARRIVED AT DESTINATION RAMP, DEPARTED FROM DESTINATION RAMP
Drop warehouse: ARRIVED AT FINAL DESTINATION, CARGO DELIVERED EMPTY CONTAINER RETURNED
Customs: CUSTOMS PENDING, CUSTOMS CANCELLED, CUSTOMS NOT RELEASED, CUSTOMS INTENSIVE EXAM, CUSTOMS ADMISSIBLE, CUSTOMS DOCUMENT REQUIRED, CUSTOMS REQUIRES BROKER REVIEW, PGA RELEASED, CUSTOMS RELEASED
Catch-All: SHIPMENT UPDATED
example: "LOAD BOOKED,LOAD PICKED UP,LOAD DELIVERED" - in: query name: skip required: false schema: type: integer description: Identify how many results the call will skip. example: 1 - in: query name: take required: false schema: type: integer minimum: 1 maximum: 1000 default: 500 description: Identify how many results the call will retrieve. example: 250 x-code-samples: - lang: Curl source: "curl -X GET \\ \n 'https://sandbox-api.navisphere.com/v2/events?loadNumber=20015434520' \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json'" - lang: Java source: "HttpResponse response = Unirest.get(\"https://sandbox-api.navisphere.com/v2/events?loadNumber=20015434520\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .asString();" - lang: NodeJS source: " var request = require(\"request\");\n\n var options = { method: 'GET',\n url: 'https://sandbox-api.navisphere.com/v2/events',\n qs: { loadNumber: '20015434520' },\n headers: { \n \tAuthorization: 'Bearer YOU TOKEN',\n \t'Content-Type': 'application/json' \n }};\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v2/events?loadNumber=20015434520\");\n var request = new RestRequest(Method.GET);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n IRestResponse response = client.Execute(request);" responses: '200': description: Event Response content: application/json: schema: $ref: '#/components/schemas/eventResponses' example: totalCount: 13 results: - customer: C8283603 eventTime: '2022-08-11T17:44:14.162Z' customerReferenceNumber: billToReferenceNumber: Reference 123 event: eventType: ORDER CREATED referenceNumbers: - type: CITTN value: Reference 123 - type: CON value: Reference 123 - type: ORDTRK value: XM86H2B2RT4 orderDetail: - navisphereTrackingNumber: XM86H2B2RT4 navisphereTrackingLink: https://trn-online.chrobinson.com/tracking/#/?trackingNumber=XM86H2B2RT4 orderNumber: 123456789 condition: Active services: - condition: Active mode: LessThanTruckLoad description: LTL Transportation serviceLevel: Standard locations: - chrLocationId: W123456 customerLocationId: W123456 type: Pick style: Warehouse name: Test Pick address: addressLine1: 123 Test Pick Drive addressLine2: '' city: Chicago stateProvinceCode: postalCode: '60605' country: US latitude: 41.862169 longitude: -87.616946 referenceNumbers: - chrLocationId: W654321 customerLocationId: W654321 type: Drop style: Warehouse name: Test Drop address: addressLine1: 123 Test Drop Street addressLine2: '' city: Minneapolis stateProvinceCode: postalCode: '32218' country: US latitude: 44.972965 longitude: -93.258926 referenceNumbers: items: - quantity: 1 packagingType: KIT description: Widgets productCode: '123456' freightClass: '85' pluNumber: skuNumber: upcNumber: insuranceValue: minWeight: minWeightUnitOfMeasure: maxWeight: 230 maxWeightUnitOfMeasure: Pounds length: lengthUnitOfMeasure: height: heightUnitOfMeasure: width: widthUnitOfMeasure: volume: volumeUnitOfMeasure: pallets: 1 palletSpaces: 2 trailerLengthUsed: 3 trailerLengthUsedUnitOfMeasure: Feet referenceNumbers: isHazardous: true hazardousProperties: authCode: D cargoAircraftLimitation: Cargo limitation classCode: 8 description: Lithium Ion Batteries emergencyPhone: 911 emergencyResponseGuidePage: page 56 exemptionNotes: Some exemption notes flashpoint: 500 flashpointTemperatureUnitOfMeasure: Celsius isEnvironmentallyHazardous: true isNOSCommodity: true isPlacarded: true isPrimaryCommodity: true isReportableQuantity: false marinePollutantCategory: MP packingGroup: I passengerLimitation: passenger limitation specialProvisions: special provisions subsidiaryHazmatClasses: subcode technicalName: Lithium Ion Batteries unNumber: UN2796 vesselStowageCategory: A - quantity: 1 packagingType: KIT description: Widgets productCode: '123456' freightClass: '85' pluNumber: skuNumber: upcNumber: insuranceValue: minWeight: minWeightUnitOfMeasure: maxWeight: 230 maxWeightUnitOfMeasure: Pounds length: lengthUnitOfMeasure: height: heightUnitOfMeasure: width: widthUnitOfMeasure: volume: volumeUnitOfMeasure: pallets: palletSpaces: trailerLengthUsed: 0 trailerLengthUsedUnitOfMeasure: Feet referenceNumbers: isHazardous: true hazardousProperties: authCode: D cargoAircraftLimitation: Cargo limitation classCode: 8 description: Lithium Ion Batteries emergencyPhone: 911 emergencyResponseGuidePage: page 56 exemptionNotes: Some exemption notes flashpoint: 500 flashpointTemperatureUnitOfMeasure: Celsius isEnvironmentallyHazardous: true isNOSCommodity: true isPlacarded: true isPrimaryCommodity: true isReportableQuantity: false marinePollutantCategory: MP packingGroup: I passengerLimitation: passenger limitation specialProvisions: special provisions subsidiaryHazmatClasses: subcode technicalName: Lithium Ion Batteries unNumber: UN2796 vesselStowageCategory: A loadNumbers: [] time: '2022-08-11T17:44:45.233Z' - customer: C8283603 eventTime: '2022-08-12T18:18:26.575Z' customerReferenceNumber: billToReferenceNumber: Reference 123 event: eventType: ORDER UPDATED referenceNumbers: - type: CITTN value: Reference 123 - type: ORDTRK value: XM86H2B2RT4 - type: CON value: Reference 123 orderDetail: - navisphereTrackingNumber: XM86H2B2RT4 navisphereTrackingLink: https://trn-online.chrobinson.com/tracking/#/?trackingNumber=XM86H2B2RT4 orderNumber: 123456789 condition: Active services: - condition: Active mode: LessThanTruckLoad description: LTL Transportation serviceLevel: Standard locations: - chrLocationId: W123456 customerLocationId: W123456 type: Pick style: Warehouse name: Test Pick address: addressLine1: 123 Test Pick Drive addressLine2: city: Chicago stateProvinceCode: postalCode: '60605' country: US latitude: 41.862169 longitude: -87.616946 referenceNumbers: - type: PU value: Reference 123 - chrLocationId: W654321 customerLocationId: W654321 type: Drop style: Warehouse name: Test Drop address: addressLine1: 123 Test Drop Street addressLine2: city: Minneapolis stateProvinceCode: postalCode: '32218' country: US latitude: 44.972965 longitude: -93.258926 referenceNumbers: - type: DEL value: Reference 123 items: - quantity: 1 packagingType: KIT description: Widgets productCode: '123456' freightClass: '85' pluNumber: skuNumber: upcNumber: insuranceValue: minWeight: minWeightUnitOfMeasure: maxWeight: 230 maxWeightUnitOfMeasure: Pounds length: lengthUnitOfMeasure: height: heightUnitOfMeasure: width: widthUnitOfMeasure: volume: volumeUnitOfMeasure: pallets: 1 palletSpaces: 2 trailerLengthUsed: 3 trailerLengthUsedUnitOfMeasure: Feet referenceNumbers: - type: PO value: Reference 123 isHazardous: true hazardousProperties: authCode: D cargoAircraftLimitation: Cargo limitation classCode: 8 description: Lithium Ion Batteries emergencyPhone: 911 emergencyResponseGuidePage: page 56 exemptionNotes: Some exemption notes flashpoint: 500 flashpointTemperatureUnitOfMeasure: Celsius isEnvironmentallyHazardous: true isNOSCommodity: true isPlacarded: true isPrimaryCommodity: true isReportableQuantity: false marinePollutantCategory: MP packingGroup: I passengerLimitation: passenger limitation specialProvisions: special provisions subsidiaryHazmatClasses: subcode technicalName: Lithium Ion Batteries unNumber: UN2796 vesselStowageCategory: A - quantity: 1 packagingType: KIT description: Widgets productCode: '123456' freightClass: '85' pluNumber: skuNumber: upcNumber: insuranceValue: minWeight: minWeightUnitOfMeasure: maxWeight: 230 maxWeightUnitOfMeasure: Pounds length: lengthUnitOfMeasure: height: heightUnitOfMeasure: width: widthUnitOfMeasure: volume: volumeUnitOfMeasure: pallets: palletSpaces: trailerLengthUsed: 0 trailerLengthUsedUnitOfMeasure: Feet referenceNumbers: - type: PO value: Reference 123 isHazardous: true hazardousProperties: authCode: D cargoAircraftLimitation: Cargo limitation classCode: 8 description: Lithium Ion Batteries emergencyPhone: 911 emergencyResponseGuidePage: page 56 exemptionNotes: Some exemption notes flashpoint: 500 flashpointTemperatureUnitOfMeasure: Celsius isEnvironmentallyHazardous: true isNOSCommodity: true isPlacarded: true isPrimaryCommodity: true isReportableQuantity: false marinePollutantCategory: MP packingGroup: I passengerLimitation: passenger limitation specialProvisions: special provisions subsidiaryHazmatClasses: subcode technicalName: Lithium Ion Batteries unNumber: UN2796 vesselStowageCategory: A loadNumbers: - 987654321 time: '2022-08-12T18:18:57.143Z' - customer: C8283603 eventTime: '2022-08-12T18:00:28.072Z' customerReferenceNumber: billToReferenceNumber: Reference 123 event: eventType: ORDER CANCELED referenceNumbers: - type: CITTN value: Reference 123 - type: ORDTRK value: XM86H2B2RT4 - type: CON value: Reference 123 orderDetail: - navisphereTrackingNumber: XM86H2B2RT4 navisphereTrackingLink: https://trn-online.chrobinson.com/tracking/#/?trackingNumber=XM86H2B2RT4 orderNumber: 123456789 condition: Canceled services: - condition: Canceled mode: LessThanTruckLoad description: LTL Transportation serviceLevel: Standard locations: - chrLocationId: W123456 customerLocationId: W123456 type: Pick style: Warehouse name: Test Pick address: addressLine1: 123 Test Pick Drive addressLine2: city: Chicago stateProvinceCode: postalCode: '60605' country: US latitude: 41.862169 longitude: -87.616946 referenceNumbers: - type: PU value: Reference 123 - chrLocationId: W654321 customerLocationId: W654321 type: Drop style: Warehouse name: Test Drop address: addressLine1: 123 Test Drop Street addressLine2: '' city: Minneapolis stateProvinceCode: postalCode: '32218' country: US latitude: 44.972965 longitude: -93.258926 referenceNumbers: - type: DEL value: Reference 123 items: - quantity: 1 packagingType: KIT description: Widgets productCode: '123456' freightClass: '85' pluNumber: skuNumber: upcNumber: insuranceValue: minWeight: minWeightUnitOfMeasure: maxWeight: 230 maxWeightUnitOfMeasure: Pounds length: lengthUnitOfMeasure: height: heightUnitOfMeasure: width: widthUnitOfMeasure: volume: volumeUnitOfMeasure: pallets: 1 palletSpaces: 2 trailerLengthUsed: 3 trailerLengthUsedUnitOfMeasure: Feet referenceNumbers: - type: PO value: Reference 123 isHazardous: true hazardousProperties: authCode: D cargoAircraftLimitation: Cargo limitation classCode: 8 description: Lithium Ion Batteries emergencyPhone: 911 emergencyResponseGuidePage: page 56 exemptionNotes: Some exemption notes flashpoint: 500 flashpointTemperatureUnitOfMeasure: Celsius isEnvironmentallyHazardous: true isNOSCommodity: true isPlacarded: true isPrimaryCommodity: true isReportableQuantity: false marinePollutantCategory: MP packingGroup: I passengerLimitation: passenger limitation specialProvisions: special provisions subsidiaryHazmatClasses: subcode technicalName: Lithium Ion Batteries unNumber: UN2796 vesselStowageCategory: A - quantity: 1 packagingType: KIT description: Widgets productCode: '123456' freightClass: '85' pluNumber: skuNumber: upcNumber: insuranceValue: minWeight: minWeightUnitOfMeasure: maxWeight: 230 maxWeightUnitOfMeasure: Pounds length: lengthUnitOfMeasure: height: heightUnitOfMeasure: width: widthUnitOfMeasure: volume: volumeUnitOfMeasure: pallets: palletSpaces: trailerLengthUsed: 0 trailerLengthUsedUnitOfMeasure: Feet referenceNumbers: - type: PO value: Reference 123 isHazardous: true hazardousProperties: authCode: D cargoAircraftLimitation: Cargo limitation classCode: 8 description: Lithium Ion Batteries emergencyPhone: 911 emergencyResponseGuidePage: page 56 exemptionNotes: Some exemption notes flashpoint: 500 flashpointTemperatureUnitOfMeasure: Celsius isEnvironmentallyHazardous: true isNOSCommodity: true isPlacarded: true isPrimaryCommodity: true isReportableQuantity: false marinePollutantCategory: MP packingGroup: I passengerLimitation: passenger limitation specialProvisions: special provisions subsidiaryHazmatClasses: subcode technicalName: Lithium Ion Batteries unNumber: UN2796 vesselStowageCategory: A loadNumbers: [] time: '2022-08-12T18:00:58.320Z' - customer: C8283603 eventTime: '2022-08-12T20:43:34.231Z' customerReferenceNumber: Reference 123 billToReferenceNumber: Reference 123 event: eventType: ORDER REJECTED referenceNumbers: - type: CITTN value: Reference 123 - type: SCAC value: RBTW - type: CRID value: '0' - type: GRGI value: Reference 123 - type: MBOL value: Reference 123 - type: ORDTRK value: XM86H2B2RT4 - type: CON value: Reference 123 orderDetail: - navisphereTrackingNumber: XM86H2B2RT4 navisphereTrackingLink: https://trn-online.chrobinson.com/tracking/#/?trackingNumber=XM86H2B2RT4 orderNumber: 123456789 condition: Rejected services: - condition: Rejected mode: Van description: Truckload Transportation serviceLevel: Standard locations: - chrLocationId: W123456 customerLocationId: W123456 type: Pick style: Warehouse name: Test Pick address: addressLine1: 123 Test Pick Drive addressLine2: '' city: Chicago stateProvinceCode: postalCode: '60605' country: US latitude: 41.862169 longitude: -87.616946 referenceNumbers: - type: SREF value: Reference 123 - type: CRID value: Reference 123 - type: PO value: Reference 123 - type: PU value: Reference 123 - chrLocationId: W654321 customerLocationId: W654321 type: Drop style: Warehouse name: Test Drop address: addressLine1: 3123 Test Drop Street addressLine2: '' city: Minneapolis stateProvinceCode: postalCode: '32218' country: US latitude: 44.972965 longitude: -93.258926 referenceNumbers: - type: SREF value: Reference 123 - type: CRID value: Reference 123 - type: PO value: Reference 123 - type: DEL value: Reference 123 items: - quantity: 200 packagingType: PLT description: Widgets productCode: MISC freightClass: Empty pluNumber: skuNumber: '123' upcNumber: insuranceValue: minWeight: 19986 minWeightUnitOfMeasure: Pounds maxWeight: 19986 maxWeightUnitOfMeasure: Pounds length: lengthUnitOfMeasure: height: heightUnitOfMeasure: width: widthUnitOfMeasure: volume: volumeUnitOfMeasure: pallets: palletSpaces: trailerLengthUsed: 48 trailerLengthUsedUnitOfMeasure: Feet referenceNumbers: - type: PO value: Reference 123 isHazardous: true hazardousProperties: authCode: D cargoAircraftLimitation: Cargo limitation classCode: 8 description: Lithium Ion Batteries emergencyPhone: 911 emergencyResponseGuidePage: page 56 exemptionNotes: Some exemption notes flashpoint: 500 flashpointTemperatureUnitOfMeasure: Celsius isEnvironmentallyHazardous: true isNOSCommodity: true isPlacarded: true isPrimaryCommodity: true isReportableQuantity: false marinePollutantCategory: MP packingGroup: I passengerLimitation: passenger limitation specialProvisions: special provisions subsidiaryHazmatClasses: subcode technicalName: Lithium Ion Batteries unNumber: UN2796 vesselStowageCategory: A loadNumbers: [] time: '2022-08-12T20:44:05.822Z' - customer: C8283603 eventTime: '2022-08-12T20:09:23.833Z' customerReferenceNumber: Reference 123 billToReferenceNumber: Reference 123 event: eventType: ORDER COMPLETED referenceNumbers: - type: CITTN value: Reference 123 - type: SCAC value: RBTW - type: CRID value: '0' - type: GRGI value: Reference 123 - type: MBOL value: Reference 123 - type: ORDTRK value: XM86H2B2RT4 - type: CON value: Reference 123 orderDetail: - navisphereTrackingNumber: XM86H2B2RT4 navisphereTrackingLink: https://trn-online.chrobinson.com/tracking/#/?trackingNumber=XM86H2B2RT4 orderNumber: 123456789 condition: FinanciallyLocked services: - condition: FinanciallyLocked mode: TemperatureControlled description: Produce Truckload Temp Controlled Transportation serviceLevel: Standard locations: - chrLocationId: W123456 customerLocationId: W123456 type: Pick style: Warehouse name: Test Pick address: addressLine1: 123 Test Pick Drive addressLine2: city: Chicago stateProvinceCode: postalCode: '60605' country: US latitude: 41.862169 longitude: -87.616946 referenceNumbers: - type: SREF value: Reference 123 - type: CRID value: Reference 123 - type: PU value: Reference 123 - chrLocationId: W654321 customerLocationId: W654321 type: Drop style: Warehouse name: Test Drop address: addressLine1: 123 Test Drop Street addressLine2: city: Minneapolis stateProvinceCode: postalCode: '32218' country: US latitude: 44.972965 longitude: -93.258926 referenceNumbers: - type: SREF value: Reference 123 - type: CRID value: Reference 123 items: - quantity: 9 packagingType: PLT description: Widgets productCode: MISC freightClass: Empty pluNumber: skuNumber: upcNumber: insuranceValue: minWeight: 40000 minWeightUnitOfMeasure: Pounds maxWeight: 40000 maxWeightUnitOfMeasure: Pounds length: lengthUnitOfMeasure: height: heightUnitOfMeasure: width: widthUnitOfMeasure: volume: volumeUnitOfMeasure: pallets: palletSpaces: trailerLengthUsed: 48 trailerLengthUsedUnitOfMeasure: Feet referenceNumbers: - type: PO value: Reference 123 isHazardous: true hazardousProperties: authCode: D cargoAircraftLimitation: Cargo limitation classCode: 8 description: Lithium Ion Batteries emergencyPhone: 911 emergencyResponseGuidePage: page 56 exemptionNotes: Some exemption notes flashpoint: 500 flashpointTemperatureUnitOfMeasure: Celsius isEnvironmentallyHazardous: true isNOSCommodity: true isPlacarded: true isPrimaryCommodity: true isReportableQuantity: false marinePollutantCategory: MP packingGroup: I passengerLimitation: passenger limitation specialProvisions: special provisions subsidiaryHazmatClasses: subcode technicalName: Lithium Ion Batteries unNumber: UN2796 vesselStowageCategory: A loadNumbers: - 987654321 time: '2022-08-12T20:09:56.739Z' - customer: C8283603 eventTime: '2022-08-12T20:17:29.470Z' customerReferenceNumber: Reference 123 billToReferenceNumber: Reference 123 event: eventType: LOAD CREATED orderDetails: - navisphereTrackingNumber: XM86H2B2RT4 navisphereTrackingLink: https://trn-online.chrobinson.com/tracking/#/?trackingNumber=XM86H2B2RT4 orderNumber: 123456789 customerOrderReferenceNumber: Reference 123 referenceNumbers: - type: CITTN value: Reference 123 - type: SCAC value: RBTW - type: CRID value: '0' - type: GRGI value: Reference 123 - type: MBOL value: Reference 123 - type: ORDTRK value: XM86H2B2RT4 - type: CON value: Reference 123 ordersPlannedOnLoad: - orderNumber: 123456789 loadNumber: 987654321 equipmentType: Van mode: serviceOffering: Produce Truckload Temp Controlled Transportation readyByDate: '2022-08-13' pickupByDate: '2022-08-13' deliveryAvailableByDate: '2022-08-14' deliveryByDate: '2022-08-14' billTos: - customerCode: C8283603 customerName: Test Customer Name currencyCode: USD invoiceMethod: CL milesBilled: 62 exchangeRate: 1 charges: - rate: 725 rateCode: '400' quantity: 1 alternateDescription: Line Haul chargeType: Actual Charge - rate: 0.48 rateCode: '405' quantity: 55 alternateDescription: 405 - Fuel Surcharge chargeType: Actual Charge contacts: - name: '' type: companyName: '' contactMethods: - method: Email value: test@test.com referenceNumbers: - name: test type: companyName: '' contactMethods: - method: Phone value: '1234567890' - method: Email value: test@test.com referenceNumbers: referenceNumbers: - type: SCAC value: RBTW - type: CRID value: '0' - type: GRGI value: Reference 123 - type: SPRN value: Reference 123 customers: - customerCode: C8283603 customerName: Test Customer Name referenceNumbers: - type: OrderID value: Reference 123 - type: SHID value: Reference 123 contacts: - name: test type: Contact companyName: contactMethods: [] referenceNumbers: carrier: name: carrierCode: scac: proNumber: driverName: driverPhone: secondDriverName: sealNumber: licensePlate: tractorNumber: trailerNumber: dotNumber: locations: - chrLocationId: W123456 customerLocationId: type: Pick style: N stopSequenceNumber: 0 sequenceNumber: 0 name: Test Pick address: addressLine1: 123 Test Pick Drive addressLine2: city: Chicago stateProvinceCode: IL postalCode: '60605' country: US latitude: 41.862169 longitude: -87.616946 pickUpNumber: Reference 123 deliveryNumber: locationContact: name: TEST phoneNumber: "(123) 456-7890" email: referenceNumbers: - type: CRID value: Reference 123 - type: PO value: Reference 123 - type: PU value: Reference 123 - type: SREF value: Reference 123 appointmentNumber: scheduledOpenDateTime: scheduledCloseDateTime: scheduledEnteredDate: arrivalDateTime: departureDateTime: isDropTrailerNeeded: false scheduledWith: etaDateTime: - chrLocationId: W654321 customerLocationId: type: Drop style: N stopSequenceNumber: 1 sequenceNumber: 1 name: Test Drop address: addressLine1: 123 Test Drop Street addressLine2: city: Chicago stateProvinceCode: IL postalCode: '32218' country: US latitude: 44.972965 longitude: -93.258926 pickUpNumber: deliveryNumber: Reference 123 locationContact: name: Main Office phoneNumber: "(888) 888-8888" email: test.test@test.com referenceNumbers: - type: CRID value: Reference 123 - type: DEL value: Reference 123 - type: PO value: Reference 123 - type: SREF value: Reference 123 appointmentNumber: scheduledOpenDateTime: scheduledCloseDateTime: scheduledEnteredDate: arrivalDateTime: departureDateTime: isDropTrailerNeeded: false scheduledWith: etaDateTime: items: - packagingType: PLT description: Widgets productCode: MISC freightClass: insuranceValue: 99999.99999984796 primaryReferenceNumber: poNumber: '123456789' skuNumber: '1' pluNumber: actualQuantity: 1444 actualWeight: 37537.99999999967 actualWeightUnitOfMeasure: Pounds actualPallets: actualVolume: 3128 actualVolumeUnitOfMeasure: Cubic Feet actualPackagingLength: actualPackagingHeight: actualPackagingWidth: actualPackagingUnitOfMeasure: Inches referenceNumbers: - type: OrderItemId value: Reference 123 associatedStop: pickSequenceNumber: 0 dropSequenceNumber: 1 expectedPallets: expectedQuantity: 1444 expectedWeight: 37537.99999999967 expectedWeightUnitOfMeasure: Standard expectedPackagingLength: expectedPackagingHeight: expectedPackagingWidth: expectedPackagingUnitOfMeasure: Inches expectedVolume: expectedVolumeUnitOfMeasure: packages: [] time: '2022-08-12T20:17:55.503Z' - customer: C8283603 eventTime: '2022-08-12T20:46:00.000Z' customerReferenceNumber: Reference 123 billToReferenceNumber: Reference 123 event: eventType: LOAD BOOKED orderDetails: - navisphereTrackingNumber: XM86H2B2RT4 navisphereTrackingLink: https://trn-online.chrobinson.com/tracking/#/?trackingNumber=XM86H2B2RT4 orderNumber: 123456789 customerOrderReferenceNumber: Reference 123 referenceNumbers: - type: CITTN value: Reference 123 - type: SCAC value: RBTW - type: CRID value: '0' - type: GRGI value: Reference 123 - type: MBOL value: Reference 123 - type: ORDTRK value: XM86H2B2RT4 - type: CON value: Reference 123 ordersPlannedOnLoad: - orderNumber: 123456789 loadNumber: 987654321 equipmentType: Van mode: Truckload serviceOffering: Truckload Transportation readyByDate: '2022-08-18' pickupByDate: '2022-08-18' deliveryAvailableByDate: '2022-08-23' deliveryByDate: '2022-08-23' billTos: - customerCode: C8283603 customerName: Test Customer Name currencyCode: USD invoiceMethod: CL milesBilled: 2386.9999999995084 exchangeRate: 1 charges: - rate: 0.42 rateCode: '405' quantity: 2405 alternateDescription: 405 - Fuel Surcharge chargeType: Actual Charge - rate: 4756.02 rateCode: '400' quantity: 1 alternateDescription: Line Haul chargeType: Actual Charge contacts: - name: '' type: companyName: '' contactMethods: - method: Email value: test@test.com referenceNumbers: - name: test type: companyName: '' contactMethods: - method: Phone value: '9999999999' - method: Email value: test.test@test.com referenceNumbers: referenceNumbers: - type: SCAC value: RBTW - type: CRID value: '0' - type: GRGI value: Reference 123 - type: SPRN value: Reference 123 - type: SHIPREF value: Reference 123 - type: MBOL value: Reference 123 - type: SHID value: Reference 123 customers: - customerCode: C8283603 customerName: Test Customer Name referenceNumbers: - type: OrderID value: Reference 123 - type: SHID value: Reference 123 contacts: - name: test type: Contact companyName: contactMethods: [] referenceNumbers: carrier: name: Test Carrier carrierCode: T12345678 scac: RBTW proNumber: driverName: driverPhone: secondDriverName: sealNumber: licensePlate: tractorNumber: trailerNumber: dotNumber: '1234567' locations: - chrLocationId: W654321 customerLocationId: type: Drop style: N stopSequenceNumber: 1 sequenceNumber: 0 name: Test Drop address: addressLine1: 123 Test Drop Street addressLine2: city: Minneapolis stateProvinceCode: MN postalCode: '32218' country: US latitude: 44.972965 longitude: -93.258926 pickUpNumber: deliveryNumber: Reference 123 locationContact: name: Shipping phoneNumber: '8888888888' email: referenceNumbers: - type: CRID value: Reference 123 - type: DEL value: Reference 123 - type: PO value: Reference 123 - type: SREF value: Reference 123 appointmentNumber: '123456789' scheduledOpenDateTime: '2022-08-23T09:00:00.000Z' scheduledCloseDateTime: '2022-08-23T09:00:00.000Z' scheduledEnteredDate: '2022-08-12T23:25:00.000Z' arrivalDateTime: departureDateTime: isDropTrailerNeeded: false scheduledWith: '123456789' etaDateTime: '2022-08-23T08:00:00.000Z' - chrLocationId: W123456 customerLocationId: type: Pick style: N stopSequenceNumber: 0 sequenceNumber: 1 name: Test Pick address: addressLine1: 123 Test Pick Drive addressLine2: city: Chicago stateProvinceCode: IL postalCode: '60605' country: US latitude: 41.862169 longitude: -87.616946 pickUpNumber: Reference 123 deliveryNumber: locationContact: name: Shipping phoneNumber: '8888888888' email: referenceNumbers: - type: CRID value: Reference 123 - type: PO value: Reference 123 - type: PU value: Reference 123 - type: SREF value: Reference 123 appointmentNumber: scheduledOpenDateTime: '2022-08-18T18:00:00.000Z' scheduledCloseDateTime: '2022-08-18T18:00:00.000Z' scheduledEnteredDate: '2022-08-13T02:14:00.000Z' arrivalDateTime: departureDateTime: isDropTrailerNeeded: false scheduledWith: Shipping etaDateTime: '2022-08-18T18:00:00.000Z' items: - packagingType: PLT description: Widgets productCode: MISC freightClass: insuranceValue: 99999.99999984796 primaryReferenceNumber: poNumber: '123456789' skuNumber: '123' pluNumber: actualQuantity: 294 actualWeight: 11760 actualWeightUnitOfMeasure: Pounds actualPallets: actualVolume: 2990.9999999995084 actualVolumeUnitOfMeasure: Cubic Feet actualPackagingLength: actualPackagingHeight: actualPackagingWidth: actualPackagingUnitOfMeasure: Inches referenceNumbers: - type: OrderItemId value: Reference 123 associatedStop: pickSequenceNumber: 0 dropSequenceNumber: 1 expectedPallets: expectedQuantity: 294 expectedWeight: 11760 expectedWeightUnitOfMeasure: Standard expectedPackagingLength: expectedPackagingHeight: expectedPackagingWidth: expectedPackagingUnitOfMeasure: Inches expectedVolume: expectedVolumeUnitOfMeasure: packages: [] time: '2022-08-12T20:47:01.946Z' - customer: C8283603 eventTime: '2022-08-12T20:49:56.207Z' customerReferenceNumber: Reference 123 billToReferenceNumber: Reference 123 event: eventType: LOAD CANCELLED orderDetails: - navisphereTrackingNumber: XM86H2B2RT4 navisphereTrackingLink: https://trn-online.chrobinson.com/tracking/#/?trackingNumber=XM86H2B2RT4 orderNumber: 123456789 customerOrderReferenceNumber: Reference 123 referenceNumbers: - type: CITTN value: Reference 123 - type: SCAC value: RBTW - type: CRID value: '0' - type: GRGI value: Reference 123 - type: MBOL value: Reference 123 - type: ORDTRK value: XM86H2B2RT4 - type: CON value: Reference 123 ordersPlannedOnLoad: - orderNumber: 123456789 loadNumber: 987654321 equipmentType: Reefer mode: serviceOffering: Produce Truckload Temp Controlled Transportation readyByDate: '2022-08-11' pickupByDate: '2022-08-11' deliveryAvailableByDate: '2022-08-13' deliveryByDate: '2022-08-13' billTos: - customerCode: C8283603 customerName: Test Customer Name currencyCode: USD invoiceMethod: CL milesBilled: 958.9999999995085 exchangeRate: 1 charges: - rate: 3.5 rateCode: '400' quantity: 951 alternateDescription: Line Haul chargeType: Actual Charge - rate: 453.54 rateCode: '405' quantity: 1 alternateDescription: 405 - Fuel Surcharge chargeType: Actual Charge contacts: - name: '' type: companyName: '' contactMethods: - method: Email value: test@test.com referenceNumbers: - name: test type: companyName: '' contactMethods: - method: Phone value: '1234567890' - method: Email value: test@test.com referenceNumbers: referenceNumbers: - type: SCAC value: RBTW - type: CRID value: '0' - type: GRGI value: Reference 123 - type: SPRN value: Reference 123 - type: SHIPREF value: Reference 123 - type: MBOL value: Reference 123 - type: SHID value: Reference 123 customers: - customerCode: C8283603 customerName: Test Customer Name referenceNumbers: - type: OrderID value: Reference 123 - type: SHID value: Reference 123 contacts: - name: test type: Contact companyName: contactMethods: [] referenceNumbers: carrier: name: carrierCode: scac: proNumber: driverName: driverPhone: secondDriverName: sealNumber: licensePlate: tractorNumber: trailerNumber: dotNumber: locations: - chrLocationId: W654321 customerLocationId: type: Drop style: N stopSequenceNumber: 1 sequenceNumber: 0 name: Test Drop address: addressLine1: 123 Test Drop Street addressLine2: city: Minneapolis stateProvinceCode: MN postalCode: '32218' country: US latitude: 44.972965 longitude: -93.258926 pickUpNumber: deliveryNumber: locationContact: name: Receiving phoneNumber: "(888) 888-8888" email: referenceNumbers: - type: CRID value: Reference 123 - type: SREF value: Reference 123 appointmentNumber: scheduledOpenDateTime: scheduledCloseDateTime: scheduledEnteredDate: '2022-08-05T19:49:00.000Z' arrivalDateTime: departureDateTime: isDropTrailerNeeded: false scheduledWith: etaDateTime: - chrLocationId: W123456 customerLocationId: type: Pick style: N stopSequenceNumber: 0 sequenceNumber: 1 name: Test Pick address: addressLine1: 123 Test Pick Drive addressLine2: city: Chicago stateProvinceCode: IL postalCode: '60605' country: US latitude: 41.862169 longitude: -87.616946 pickUpNumber: Reference 123 deliveryNumber: locationContact: name: test phoneNumber: '8888888888' email: test.test@test.com referenceNumbers: - type: CRID value: Reference 123 - type: PU value: Reference 123 - type: SREF value: Reference 123 appointmentNumber: scheduledOpenDateTime: '2022-08-11T19:00:00.000Z' scheduledCloseDateTime: '2022-08-11T19:00:00.000Z' scheduledEnteredDate: arrivalDateTime: '2022-08-11T18:49:00.000Z' departureDateTime: '2022-08-11T21:48:00.000Z' isDropTrailerNeeded: false scheduledWith: LoadBuild etaDateTime: items: - packagingType: PLT description: Widgets productCode: MISC freightClass: insuranceValue: 99999.99999984796 primaryReferenceNumber: poNumber: '9999999999' skuNumber: pluNumber: actualQuantity: 9 actualWeight: 40000 actualWeightUnitOfMeasure: Pounds actualPallets: actualVolume: 1500 actualVolumeUnitOfMeasure: Cubic Feet actualPackagingLength: actualPackagingHeight: actualPackagingWidth: actualPackagingUnitOfMeasure: Inches referenceNumbers: - type: OrderItemId value: Reference 123 associatedStop: pickSequenceNumber: 0 dropSequenceNumber: 1 expectedPallets: expectedQuantity: 9 expectedWeight: 40000 expectedWeightUnitOfMeasure: Standard expectedPackagingLength: expectedPackagingHeight: expectedPackagingWidth: expectedPackagingUnitOfMeasure: Inches expectedVolume: expectedVolumeUnitOfMeasure: packages: [] time: '2022-08-12T20:50:00.689Z' - customer: C8283603 eventTime: '2022-08-12T20:49:00.000Z' customerReferenceNumber: Reference 123 billToReferenceNumber: Reference 123 event: eventType: CARRIER ARRIVED orderDetails: - navisphereTrackingNumber: XM86H2B2RT4 navisphereTrackingLink: https://trn-online.chrobinson.com/tracking/#/?trackingNumber=XM86H2B2RT4 orderNumber: 123456789 customerOrderReferenceNumber: Reference 123 referenceNumbers: - type: CITTN value: Reference 123 - type: SCAC value: RBTW - type: CRID value: '0' - type: GRGI value: Reference 123 - type: MBOL value: Reference 123 - type: ORDTRK value: XM86H2B2RT4 - type: CON value: Reference 123 loadNumber: 987654321 carrier: name: Test Carrier carrierCode: T1234567 scac: RBTW proNumber: driverName: driverPhone: '8888888888' secondDriverName: sealNumber: licensePlate: tractorNumber: '123' trailerNumber: '123' dotNumber: '1234567' location: chrLocationId: W123456 customerLocationId: type: Pick style: N stopSequenceNumber: 0 sequenceNumber: 0 name: Test Pick address: addressLine1: 123 Test Pick Drive addressLine2: city: Chicago stateProvinceCode: IL postalCode: '60605' country: US latitude: 41.862169 longitude: -87.616946 pickUpNumber: deliveryNumber: locationContact: name: Receiving Appt phoneNumber: '8888888888' email: referenceNumbers: - type: CRID value: Reference 123 - type: PU value: Reference 123 - type: SREF value: Reference 123 isOrderStop: true loadStops: - stopType: Pick stopStyle: N stopSequenceNumber: 0 warehouseCode: W123456 - stopType: Drop stopStyle: N stopSequenceNumber: 1 warehouseCode: W543210 items: - packagingType: PLT description: Widgets productCode: MISC freightClass: insuranceValue: 99999.99999984796 primaryReferenceNumber: poNumber: '9999999999' skuNumber: pluNumber: actualQuantity: 9 actualWeight: 40000 actualWeightUnitOfMeasure: Pounds actualPallets: actualVolume: 3000 actualVolumeUnitOfMeasure: Cubic Feet actualPackagingLength: actualPackagingHeight: actualPackagingWidth: actualPackagingUnitOfMeasure: Inches referenceNumbers: - type: OrderItemId value: Reference 123 associatedStop: pickSequenceNumber: dropSequenceNumber: packages: [] time: '2022-08-12T20:48:35.790Z' - customer: C8283603 eventTime: '2022-08-12T20:14:00.000Z' customerReferenceNumber: Reference 123 billToReferenceNumber: Reference 123 event: eventType: CARRIER DEPARTED orderDetails: - navisphereTrackingNumber: XM86H2B2RT4 navisphereTrackingLink: https://trn-online.chrobinson.com/tracking/#/?trackingNumber=XM86H2B2RT4 orderNumber: 123456789 customerOrderReferenceNumber: Reference 123 referenceNumbers: - type: CITTN value: Reference 123 - type: SCAC value: RBTW - type: CRID value: '0' - type: GRGI value: Reference 123 - type: MBOL value: Reference 123 - type: ORDTRK value: XM86H2B2RT4 - type: CON value: Reference 123 loadNumber: 987654321 carrier: name: Test Carrier carrierCode: T1234567 scac: RBTW proNumber: driverName: Test name driverPhone: "+8888888888" secondDriverName: sealNumber: licensePlate: tractorNumber: Truck 123 trailerNumber: '123' dotNumber: '1234567' location: chrLocationId: W123456 customerLocationId: type: Pick style: N stopSequenceNumber: 0 sequenceNumber: 2 name: Test Pick address: addressLine1: 123 Test Pick Drive addressLine2: city: Chicago stateProvinceCode: IL postalCode: '60605' country: US latitude: 41.862169 longitude: -87.616946 pickUpNumber: deliveryNumber: locationContact: name: test phoneNumber: '88888888888' email: referenceNumbers: - type: CRID value: Reference 123 - type: PO value: Reference 123 items: - packagingType: PLT description: Widgets productCode: MISC freightClass: insuranceValue: 25000 primaryReferenceNumber: poNumber: '1234567890' skuNumber: '1' pluNumber: actualQuantity: 224 actualWeight: 3096 actualWeightUnitOfMeasure: Pounds actualPallets: actualVolume: 269 actualVolumeUnitOfMeasure: Cubic Feet actualPackagingLength: actualPackagingHeight: actualPackagingWidth: actualPackagingUnitOfMeasure: Inches referenceNumbers: - type: OrderItemId value: Reference 123 associatedStop: pickSequenceNumber: dropSequenceNumber: - packagingType: PLT description: Widgets productCode: MISC freightClass: insuranceValue: 25000 primaryReferenceNumber: poNumber: '1234567890' skuNumber: '2' pluNumber: actualQuantity: 592 actualWeight: 7488 actualWeightUnitOfMeasure: Pounds actualPallets: actualVolume: 672.9999999998362 actualVolumeUnitOfMeasure: Cubic Feet actualPackagingLength: actualPackagingHeight: actualPackagingWidth: actualPackagingUnitOfMeasure: Inches referenceNumbers: - type: OrderItemId value: Reference 123 associatedStop: pickSequenceNumber: dropSequenceNumber: packages: [] time: '2022-08-12T20:14:18.310Z' - customer: C8283603 eventTime: '2022-08-12T20:51:03.883Z' customerReferenceNumber: Reference 123 billToReferenceNumber: Reference 123 event: eventType: APPOINTMENT UPDATED orderDetails: - navisphereTrackingNumber: XM86H2B2RT4 navisphereTrackingLink: https://trn-online.chrobinson.com/tracking/#/?trackingNumber=XM86H2B2RT4 orderNumber: 123456789 customerOrderReferenceNumber: Reference 123 referenceNumbers: - type: CITTN value: Reference 123 - type: SCAC value: RBTW - type: CRID value: '0' - type: GRGI value: Reference 123 - type: MBOL value: Reference 123 - type: ORDTRK value: XM86H2B2RT4 - type: CON value: Reference 123 loadNumber: 987654321 carrier: name: carrierCode: scac: proNumber: driverName: driverPhone: secondDriverName: sealNumber: licensePlate: tractorNumber: trailerNumber: dotNumber: location: chrLocationId: W123456 customerLocationId: type: Pick style: N stopSequenceNumber: 0 sequenceNumber: 1 name: Test Pick address: addressLine1: 123 Test Pick Drive addressLine2: city: Chicago stateProvinceCode: IL postalCode: '60605' country: US latitude: 41.862169 longitude: -87.616946 pickUpNumber: deliveryNumber: locationContact: name: test phoneNumber: '1111111111' email: test@test.com; test@test.com referenceNumbers: - type: CRID value: Reference 123 - type: PO value: Reference 123 - type: PU value: Reference 123 - type: SREF value: Reference 123 appointment: scheduledOpenDateTimeUTC: '2022-08-16T16:00:00.000Z' scheduledCloseDateTimeUTC: '2022-08-16T16:00:00.000Z' changeReason: '00' scheduledCompany: test scheduledWithName: test time: '2022-08-12T20:51:10.771Z' - customer: C8283603 eventTime: '2022-08-12T20:55:22.967Z' customerReferenceNumber: Reference 123 billToReferenceNumber: Reference 123 event: eventType: IN TRANSIT orderDetails: - navisphereTrackingNumber: XM86H2B2RT4 navisphereTrackingLink: https://trn-online.chrobinson.com/tracking/#/?trackingNumber=XM86H2B2RT4 orderNumber: 123456789 customerOrderReferenceNumber: Reference 123 referenceNumbers: - type: CITTN value: Reference 123 - type: SCAC value: RBTW - type: CRID value: '0' - type: GRGI value: Reference 123 - type: MBOL value: Reference 123 - type: ORDTRK value: XM86H2B2RT4 - type: CON value: Reference 123 loadNumber: 987654321 carrier: name: Test Carrier carrierCode: T1234567 scac: RBTW proNumber: driverName: test driverPhone: "+8888888888" secondDriverName: sealNumber: licensePlate: tractorNumber: '123456' trailerNumber: '123456' dotNumber: '123546' location: city: Seward stateProvinceCode: country: latitude: 40.82175829999872 longitude: -97.0626068 deliveryEta: '2022-08-13T15:00:00.000Z' nextStop: eta: '2022-08-15T23:49:00Z' stopId: '1' stopType: D city: TACOMA state: WA loadStops: - stopType: Pick stopStyle: N stopSequenceNumber: 0 warehouseCode: W123456 - stopType: Drop stopStyle: N stopSequenceNumber: 1 warehouseCode: W543210 notes: time: '2022-08-12T20:55:35.315Z' - customer: C7471956 event: agentReferenceNumber: null airShipment: null consignee: name: Sample Distributors, Inc. customer: name: Example Corporation customerReferenceNumber: PO#PARTS123 customs: auCustoms: n10: null nzCustoms: n10: null customsEntry: null estimatedCargoReadyDate: currentValue: "2024-06-10" hasChanged: false previousValue: "2024-06-10" estimatedDeliverByDate: currentValue: "2024-07-10" hasChanged: false previousValue: "2024-07-10" eventType: CARGO DELIVERED freightTerms: Collect incoLocation: SHANGHAI incoTerms: Free On-Board Vessel mode: Ocean oceanShipment: actualVesselArrivalDate: currentValue: "2024-07-01T09:30:00.0000000-07:00" hasChanged: false previousValue: "2024-07-01T09:30:00.0000000-07:00" actualVesselDepartureDate: currentValue: "2024-06-19T14:45:00.0000000+08:00" hasChanged: false previousValue: "2024-06-19T14:45:00.0000000+08:00" containers: - actualDeliveryDate: currentValue: "2024-07-09T13:25:00.0000000-05:00" hasChanged: false previousValue: "2024-07-09T13:25:00.0000000-05:00" actualPickupDate: currentValue: "2024-06-19T10:15:00.0000000+08:00" hasChanged: false previousValue: "2024-06-19T10:15:00.0000000+08:00" containerNumber: MEDU8365429 containerType: 20FT emptyPickupDate: currentValue: null hasChanged: false previousValue: null emptyReturnDate: currentValue: "2024-07-12T16:30:00.0000000-07:00" hasChanged: false previousValue: "2024-07-12T16:30:00.0000000-07:00" estimatedDeliveryDate: currentValue: "2024-07-09T11:30:00.0000000-05:00" hasChanged: false previousValue: "2024-07-09T11:30:00.0000000-05:00" estimatedPickupDate: currentValue: "2024-06-17T08:00:00.0000000+08:00" hasChanged: false previousValue: "2024-06-17T08:00:00.0000000+08:00" innerPacks: - unitOfMeasure: "" value: 0 isAffectedByEvent: false lastFreeDay: currentValue: null hasChanged: false previousValue: null lastFreeDayForEmptyReturn: currentValue: null hasChanged: false previousValue: null outerPacks: - unitOfMeasure: Package value: 25 purchaseOrderNumbers: [] requestedDeliveryDate: currentValue: null hasChanged: false previousValue: null requestedPickupDate: currentValue: null hasChanged: false previousValue: null sealNumber: S2457831 stops: - actualArrivalDate: currentValue: "2024-06-14T09:30:00.0000000+08:00" hasChanged: false previousValue: "2024-06-14T09:30:00.0000000+08:00" actualDepartureDate: currentValue: "2024-06-19T14:45:00.0000000+08:00" hasChanged: false previousValue: "2024-06-19T14:45:00.0000000+08:00" address: address1: SHANGHAI PORT address2: null city: SHANGHAI country: CN postalCode: "200000" stateProvinceCode: CN estimatedArrivalDate: currentValue: "2024-06-17T08:00:00.0000000+08:00" hasChanged: false previousValue: "2024-06-17T08:00:00.0000000+08:00" locationCode: "57041" name: Port Shanghai sequenceNumber: 0 stopType: Origin Port unLocode: CNSHA - actualArrivalDate: currentValue: "2024-07-01T09:30:00.0000000-07:00" hasChanged: false previousValue: "2024-07-01T09:30:00.0000000-07:00" actualDepartureDate: currentValue: "2024-07-01T16:45:00.0000000-07:00" hasChanged: false previousValue: "2024-07-01T16:45:00.0000000-07:00" address: address1: Seattle address2: null city: Seattle country: US postalCode: "98101" stateProvinceCode: WA estimatedArrivalDate: currentValue: "2024-07-01T08:15:00.0000000-07:00" hasChanged: false previousValue: "2024-07-01T08:15:00.0000000-07:00" locationCode: "3592" name: Port of Seattle sequenceNumber: 1 stopType: Destination Port unLocode: USSEA - actualArrivalDate: currentValue: "2024-07-02T10:20:00.0000000-07:00" hasChanged: false previousValue: "2024-07-02T10:20:00.0000000-07:00" actualDepartureDate: currentValue: "2024-07-02T18:30:00.0000000-07:00" hasChanged: false previousValue: "2024-07-02T18:30:00.0000000-07:00" address: address1: Seattle address2: null city: SEATTLE country: US postalCode: "98108" stateProvinceCode: WA estimatedArrivalDate: currentValue: "2024-07-02T09:00:00.0000000-07:00" hasChanged: false previousValue: "2024-07-02T09:00:00.0000000-07:00" locationCode: "" name: Seattle Ramp sequenceNumber: 2 stopType: Destination Ramp unLocode: USSEA - actualArrivalDate: currentValue: "2024-07-07T14:28:00.0000000-05:00" hasChanged: false previousValue: "2024-07-07T14:28:00.0000000-05:00" actualDepartureDate: currentValue: "2024-07-09T08:45:00.0000000-05:00" hasChanged: false previousValue: "2024-07-09T08:45:00.0000000-05:00" address: address1: 4500 RAILYARD AVENUE address2: null city: CHICAGO country: US postalCode: "60632" stateProvinceCode: IL estimatedArrivalDate: currentValue: "2024-07-07T12:30:00.0000000-05:00" hasChanged: false previousValue: "2024-07-07T12:30:00.0000000-05:00" locationCode: "" name: Generic Rail Depot - T378 sequenceNumber: 3 stopType: Destination Ramp unLocode: USCHI - actualArrivalDate: currentValue: "2024-07-09T13:25:00.0000000-05:00" hasChanged: false previousValue: "2024-07-09T13:25:00.0000000-05:00" actualDepartureDate: currentValue: "2024-07-09T17:45:00.0000000-05:00" hasChanged: false previousValue: "2024-07-09T17:45:00.0000000-05:00" address: address1: 1275 Industrial Boulevard address2: null city: NAPERVILLE country: US postalCode: 60563 stateProvinceCode: IL estimatedArrivalDate: currentValue: "2024-07-09T13:30:00.0000000-05:00" hasChanged: false previousValue: "2024-07-09T13:30:00.0000000-05:00" locationCode: "" name: Generic Manufacturing LLC sequenceNumber: 4 stopType: Drop Location unLocode: USORD totalGrossWeight: kilograms: 18750 pounds: 41337.00 totalNetWeight: kilograms: 17800 pounds: 39242.00 totalVolume: cubicFeet: 635.66 cubicMeters: 18 - actualDeliveryDate: currentValue: "2024-07-09T13:45:00.0000000-05:00" hasChanged: false previousValue: "2024-07-09T13:45:00.0000000-05:00" actualPickupDate: currentValue: "2024-06-19T10:25:00.0000000+08:00" hasChanged: false previousValue: "2024-06-19T10:25:00.0000000+08:00" containerNumber: MEDU8367751 containerType: 20FT emptyPickupDate: currentValue: null hasChanged: false previousValue: null emptyReturnDate: currentValue: "2024-07-12T16:30:00.0000000-07:00" hasChanged: false previousValue: "2024-07-12T16:30:00.0000000-07:00" estimatedDeliveryDate: currentValue: "2024-07-09T11:30:00.0000000-05:00" hasChanged: false previousValue: "2024-07-09T11:30:00.0000000-05:00" estimatedPickupDate: currentValue: "2024-06-17T08:00:00.0000000+08:00" hasChanged: false previousValue: "2024-06-17T08:00:00.0000000+08:00" innerPacks: - unitOfMeasure: "" value: 0 isAffectedByEvent: false lastFreeDay: currentValue: null hasChanged: false previousValue: null lastFreeDayForEmptyReturn: currentValue: null hasChanged: false previousValue: null outerPacks: - unitOfMeasure: Package value: 25 purchaseOrderNumbers: [] requestedDeliveryDate: currentValue: null hasChanged: false previousValue: null requestedPickupDate: currentValue: null hasChanged: false previousValue: null sealNumber: S2458903 stops: - actualArrivalDate: currentValue: "2024-06-14T09:30:00.0000000+08:00" hasChanged: false previousValue: "2024-06-14T09:30:00.0000000+08:00" actualDepartureDate: currentValue: "2024-06-19T14:45:00.0000000+08:00" hasChanged: false previousValue: "2024-06-19T14:45:00.0000000+08:00" address: address1: SHANGHAI PORT address2: null city: SHANGHAI country: CN postalCode: "200000" stateProvinceCode: CN estimatedArrivalDate: currentValue: "2024-06-17T08:00:00.0000000+08:00" hasChanged: false previousValue: "2024-06-17T08:00:00.0000000+08:00" locationCode: "57041" name: Port Shanghai sequenceNumber: 0 stopType: Origin Port unLocode: CNSHA - actualArrivalDate: currentValue: "2024-07-01T09:30:00.0000000-07:00" hasChanged: false previousValue: "2024-07-01T09:30:00.0000000-07:00" actualDepartureDate: currentValue: "2024-07-01T16:45:00.0000000-07:00" hasChanged: false previousValue: "2024-07-01T16:45:00.0000000-07:00" address: address1: Seattle address2: null city: Seattle country: US postalCode: "98101" stateProvinceCode: WA estimatedArrivalDate: currentValue: "2024-07-01T08:15:00.0000000-07:00" hasChanged: false previousValue: "2024-07-01T08:15:00.0000000-07:00" locationCode: "3592" name: Port of Seattle sequenceNumber: 1 stopType: Destination Port unLocode: USSEA - actualArrivalDate: currentValue: "2024-07-02T10:20:00.0000000-07:00" hasChanged: false previousValue: "2024-07-02T10:20:00.0000000-07:00" actualDepartureDate: currentValue: "2024-07-02T18:30:00.0000000-07:00" hasChanged: false previousValue: "2024-07-02T18:30:00.0000000-07:00" address: address1: Seattle address2: null city: SEATTLE country: US postalCode: "98108" stateProvinceCode: WA estimatedArrivalDate: currentValue: "2024-07-02T09:00:00.0000000-07:00" hasChanged: false previousValue: "2024-07-02T09:00:00.0000000-07:00" locationCode: "" name: Seattle Ramp sequenceNumber: 2 stopType: Destination Ramp unLocode: USSEA - actualArrivalDate: currentValue: "2024-07-07T14:28:00.0000000-05:00" hasChanged: false previousValue: "2024-07-07T14:28:00.0000000-05:00" actualDepartureDate: currentValue: "2024-07-09T08:45:00.0000000-05:00" hasChanged: false previousValue: "2024-07-09T08:45:00.0000000-05:00" address: address1: 4500 RAILYARD AVENUE address2: null city: CHICAGO country: US postalCode: "60632" stateProvinceCode: IL estimatedArrivalDate: currentValue: "2024-07-07T12:30:00.0000000-05:00" hasChanged: false previousValue: "2024-07-07T12:30:00.0000000-05:00" locationCode: "" name: Generic Rail Depot - T378 sequenceNumber: 3 stopType: Destination Ramp unLocode: USCHI - actualArrivalDate: currentValue: "2024-07-09T13:25:00.0000000-05:00" hasChanged: false previousValue: "2024-07-09T13:25:00.0000000-05:00" actualDepartureDate: currentValue: "2024-07-09T17:45:00.0000000-05:00" hasChanged: false previousValue: "2024-07-09T17:45:00.0000000-05:00" address: address1: 1275 Industrial Boulevard address2: null city: NAPERVILLE country: US postalCode: 60563 stateProvinceCode: IL estimatedArrivalDate: currentValue: "2024-07-09T13:30:00.0000000-05:00" hasChanged: false previousValue: "2024-07-09T13:30:00.0000000-05:00" locationCode: "" name: Generic Manufacturing LLC sequenceNumber: 4 stopType: Drop Location unLocode: USORD totalGrossWeight: kilograms: 12500 pounds: 27558.00 totalNetWeight: kilograms: 11700 pounds: 25794.00 totalVolume: cubicFeet: 388.10 cubicMeters: 11 estimatedVesselArrivalDate: currentValue: "2024-07-01T08:15:00.0000000-07:00" hasChanged: false previousValue: "2024-07-01T08:15:00.0000000-07:00" estimatedVesselDepartureDate: currentValue: "2024-06-19T14:45:00.0000000+08:00" hasChanged: false previousValue: "2024-06-19T14:45:00.0000000+08:00" houseBillNumber: 608724931SHA masterBillNumber: MSCUPTA3475128 oceanMainlineCarrier: bookingNumber: PTA3475128 carrierName: Standard Shipping Inc. carrierScac: null vesselImo: "9521230" vesselName: STANDARD ATLANTIC voyageNumber: 0PJKLT purchaseOrderNumbers: [] serviceLevel: Origin Ramp to Destination Ramp servicesProvidedByChr: - Non-Vessel Operating Common Carrier shipmentCreatedDate: "2024-05-18T10:15:00.0000000Z" shipmentNumber: "608724931" shipmentType: FCL shipper: name: Standard Supply International Ltd status: Delivered eventTime: '2024-07-10T15:30:22.967Z' time: '2024-07-10T15:30:22.967Z' - customer: C658943 event: agentReferenceNumber: null airShipment: actualDeliveryDate: currentValue: "2023-07-15T16:32:00.0000000-04:00" hasChanged: true previousValue: "2023-07-15T00:00:00.0000000-04:00" actualFlightArrivalAtDestinationAirport: currentValue: "2023-07-12T10:45:00.0000000-04:00" hasChanged: false previousValue: "2023-07-12T10:45:00.0000000-04:00" actualFlightDepartureFromOriginAirport: currentValue: "2023-07-10T08:20:00.0000000+02:00" hasChanged: false previousValue: "2023-07-10T08:20:00.0000000+02:00" actualPickupDate: currentValue: "2023-07-09T15:30:00.0000000+02:00" hasChanged: false previousValue: "2023-07-09T15:30:00.0000000+02:00" airMainlineCarrier: bookingNumber: 724-53402891 carrierName: Standard Air Freight carrierScac: null flights: - flightNumber: "582" fromAirport: actualDepartureDate: currentValue: "2023-07-10T08:20:00.0000000+02:00" hasChanged: false previousValue: "2023-07-10T08:20:00.0000000+02:00" address: address1: null address2: null city: Munich country: DE postalCode: null stateProvinceCode: DE estimatedDepartureDate: currentValue: "2023-07-10T08:20:00.0000000+02:00" hasChanged: false previousValue: "2023-07-10T08:20:00.0000000+02:00" locationCode: "23890" name: Munich International Airport unLocode: DEMUC sequence: 0 toAirport: actualArrivalDate: currentValue: "2023-07-10T10:05:00.0000000+01:00" hasChanged: false previousValue: "2023-07-10T10:05:00.0000000+01:00" address: address1: null address2: null city: London country: GB postalCode: null stateProvinceCode: GB estimatedArrivalDate: currentValue: "2023-07-10T10:05:00.0000000+01:00" hasChanged: false previousValue: "2023-07-10T10:05:00.0000000+01:00" locationCode: "45712" name: Heathrow Airport unLocode: GBLHR - flightNumber: "076" fromAirport: actualDepartureDate: currentValue: "2023-07-11T22:15:00.0000000+01:00" hasChanged: false previousValue: "2023-07-11T22:15:00.0000000+01:00" address: address1: null address2: null city: London country: GB postalCode: null stateProvinceCode: GB estimatedDepartureDate: currentValue: "2023-07-11T22:15:00.0000000+01:00" hasChanged: false previousValue: "2023-07-11T22:15:00.0000000+01:00" locationCode: "45712" name: Heathrow Airport unLocode: GBLHR sequence: 1 toAirport: actualArrivalDate: currentValue: "2023-07-12T10:45:00.0000000-04:00" hasChanged: false previousValue: "2023-07-12T10:45:00.0000000-04:00" address: address1: 6000 North Terminal Parkway address2: null city: ATLANTA country: US postalCode: "30320" stateProvinceCode: GA estimatedArrivalDate: currentValue: "2023-07-12T10:45:00.0000000-04:00" hasChanged: false previousValue: "2023-07-12T10:45:00.0000000-04:00" locationCode: "4731" name: HARTSFIELD-JACKSON INTL AIRPORT unLocode: USATL chargeableWeight: kilograms: 875.5 pounds: 1930.2 estimatedDeliveryDate: currentValue: "2023-07-17T00:00:00.0000000-04:00" hasChanged: false previousValue: "2023-07-17T00:00:00.0000000-04:00" estimatedFlightArrivalAtDestinationAirport: currentValue: "2023-07-12T10:45:00.0000000-04:00" hasChanged: false previousValue: "2023-07-12T10:45:00.0000000-04:00" estimatedFlightDepartureFromOriginAirport: currentValue: "2023-07-10T08:20:00.0000000+02:00" hasChanged: false previousValue: "2023-07-10T08:20:00.0000000+02:00" estimatedPickupDate: currentValue: null hasChanged: false previousValue: null houseAirwayBillNumber: 724-39457621MUC innerPacks: - unitOfMeasure: "" value: 0 masterAirwayBillNumber: 724-53402891 outerPacks: - unitOfMeasure: "" value: 0 requestedDeliveryDate: currentValue: null hasChanged: false previousValue: null requestedPickupDate: currentValue: null hasChanged: false previousValue: null stops: - actualArrivalDate: currentValue: "2023-07-09T10:15:00.0000000+02:00" hasChanged: false previousValue: "2023-07-09T10:15:00.0000000+02:00" actualDepartureDate: currentValue: "2023-07-09T15:30:00.0000000+02:00" hasChanged: false previousValue: "2023-07-09T15:30:00.0000000+02:00" address: address1: FLUGHAFENSTRASSE 35 address2: null city: MUNICH country: DE postalCode: "85356" stateProvinceCode: DE estimatedArrivalDate: currentValue: null hasChanged: false previousValue: null locationCode: "" name: MUNICH AIRPORT CARGO FACILITY sequenceNumber: 0 stopType: Origin Terminal unLocode: DEMUC - actualArrivalDate: currentValue: "2023-07-09T15:30:00.0000000+02:00" hasChanged: false previousValue: "2023-07-09T15:30:00.0000000+02:00" actualDepartureDate: currentValue: "2023-07-10T08:20:00.0000000+02:00" hasChanged: false previousValue: "2023-07-10T08:20:00.0000000+02:00" address: address1: null address2: null city: Munich country: DE postalCode: null stateProvinceCode: DE estimatedArrivalDate: currentValue: null hasChanged: false previousValue: null locationCode: "23890" name: Munich International Airport sequenceNumber: 1 stopType: Origin Airport unLocode: DEMUC - actualArrivalDate: currentValue: "2023-07-10T10:05:00.0000000+01:00" hasChanged: false previousValue: "2023-07-10T10:05:00.0000000+01:00" actualDepartureDate: currentValue: "2023-07-11T22:15:00.0000000+01:00" hasChanged: false previousValue: "2023-07-11T22:15:00.0000000+01:00" address: address1: null address2: null city: London country: GB postalCode: null stateProvinceCode: GB estimatedArrivalDate: currentValue: "2023-07-10T10:05:00.0000000+01:00" hasChanged: false previousValue: "2023-07-10T10:05:00.0000000+01:00" locationCode: "45712" name: Heathrow Airport sequenceNumber: 2 stopType: Intermediary Airport unLocode: GBLHR - actualArrivalDate: currentValue: "2023-07-12T10:45:00.0000000-04:00" hasChanged: false previousValue: "2023-07-12T10:45:00.0000000-04:00" actualDepartureDate: currentValue: "2023-07-12T14:30:00.0000000-04:00" hasChanged: false previousValue: "2023-07-12T14:30:00.0000000-04:00" address: address1: 6000 North Terminal Parkway address2: null city: ATLANTA country: US postalCode: "30320" stateProvinceCode: GA estimatedArrivalDate: currentValue: "2023-07-12T10:45:00.0000000-04:00" hasChanged: false previousValue: "2023-07-12T10:45:00.0000000-04:00" locationCode: "4731" name: HARTSFIELD-JACKSON INTL AIRPORT unLocode: USATL - actualArrivalDate: currentValue: "2023-07-12T15:20:00.0000000-04:00" hasChanged: false previousValue: "2023-07-12T15:20:00.0000000-04:00" actualDepartureDate: currentValue: "2023-07-15T09:15:00.0000000-04:00" hasChanged: false previousValue: "2023-07-15T09:15:00.0000000-04:00" address: address1: 4800 Aviation Parkway address2: null city: Atlanta country: US postalCode: "30337" stateProvinceCode: GA estimatedArrivalDate: currentValue: "2023-07-13T00:00:00.0000000-04:00" hasChanged: false previousValue: "2023-07-13T00:00:00.0000000-04:00" locationCode: "" name: ATL-CARGO WAREHOUSE (G359) sequenceNumber: 4 stopType: Destination Terminal unLocode: USATL - actualArrivalDate: currentValue: "2023-07-15T16:30:00.0000000-04:00" hasChanged: true previousValue: "2023-07-15T00:00:00.0000000-04:00" actualDepartureDate: currentValue: "2023-07-15T16:32:00.0000000-04:00" hasChanged: true previousValue: "2023-07-15T00:00:00.0000000-04:00" address: address1: 3400 Industrial Parkway address2: null city: MARIETTA country: US postalCode: "30066" stateProvinceCode: GA estimatedArrivalDate: currentValue: "2023-07-17T00:00:00.0000000-04:00" hasChanged: false previousValue: "2023-07-17T00:00:00.0000000-04:00" locationCode: "" name: Generic Manufacturing Inc sequenceNumber: 5 stopType: Drop Location unLocode: USATL totalVolume: cubicFeet: 72.6 cubicMeters: 2.056 totalWeight: kilograms: 875.5 pounds: 1930.0 consignee: name: Generic Manufacturing Inc. customer: name: Sample Industrial Ltd customerReferenceNumber: GIP MT129 customs: auCustoms: n10: null nzCustoms: n10: null customsEntry: null estimatedCargoReadyDate: currentValue: "2023-07-05" hasChanged: false previousValue: "2023-07-05" estimatedDeliverByDate: currentValue: "2023-07-17" hasChanged: true previousValue: "2023-07-15" eventType: CARGO DELIVERED freightTerms: Collect incoLocation: "" incoTerms: Ex-Works mode: Air oceanShipment: null purchaseOrderNumbers: [] serviceLevel: Origin Terminal to Destination Terminal servicesProvidedByChr: - Air House shipmentCreatedDate: "2023-07-05T08:30:00.0000000Z" shipmentNumber: "724395621" shipmentType: FCL shipper: name: Example Engineering GmbH status: Delivered eventTime: '2024-07-10T15:30:22.967Z' time: '2024-07-10T15:30:22.967Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact you C.H. Robinson Rep. #---Financials------------------------------------------------------------------------------------------- /v1/financials/payments: get: description: Allows partners access to the payment processing status of an invoice. operationId: Payment Status Retrieval tags: - Financials parameters: - name: shipmentNumber in: query description: C.H. Robinson defined shipment (load) number. required: true schema: type: integer example: 123456789 - name: scac in: query description: Standard carrier alpha code. required: false schema: type: string example: RBTW - name: carrierCode in: query description: C.H. Robinson defined code for a given carrier. required: false schema: type: string example: T451674 x-code-samples: - lang: Curl source: "curl -X GET \\ \n 'https://sandbox-api.navisphere.com/v1/financials/payments?shipmentNumber=123456789' \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json'" - lang: Java source: "HttpResponse response = Unirest.get(\"https://sandbox-api.navisphere.com/v1/financials/payments?shipmentNumber=123456789\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .asString();" - lang: NodeJS source: " var request = require(\"request\");\n\n var options = { method: 'GET',\n \turl: 'https://sandbox-api.navisphere.com/v1/financials/payments',\n \tqs: { shipmentNumber: '123456789' },\n \theaders: \n \t{ Authorization: 'Bearer YOU TOKEN',\n \t'Content-Type': 'application/json' } };\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/financials/payments?shipmentNumber=123456789\"); \n var request = new RestRequest(Method.GET);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n IRestResponse response = client.Execute(request);" responses: '200': description: Request successful content: application/json: schema: $ref: '#/components/schemas/payments' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v1/financials/invoiceSummaries: get: description: Allows partner to retrieve list summary of their invoices. operationId: Invoice Summary Retrieval tags: - Financials parameters: - name: customerCode in: query description: C.H. Robinson defined customer code. required: true schema: type: string example: C123456 - name: orderNumber in: query description: C.H. Robinson defined order number. required: false schema: type: integer example: 8231546 - name: loadNumber in: query description: C.H. Robinson defined shipment number. required: false schema: type: integer example: 213512468 - name: startDate in: query description: Starting date/time of event search that utilizes printDate as the source. required: false schema: type: string example: "2019-04-20T20:30:00.0000000Z" - name: endDate in: query description: Ending date/time of event search that utilizes printDate as the source. **If you use startDate, then endDate is required.** required: false schema: type: string example: "2019-04-27T20:30:00.0000000Z" - name: take in: query description: Identify how many results the call will retrieve. required: false schema: type: integer default: 10 example: 25 - name: skip in: query description: Identify how many results the call will skip. required: false schema: type: integer example: 1 x-code-samples: - lang: Curl source: "curl -X GET \\ \n 'https://sandbox-api.navisphere.com/v1/financials/invoiceSummaries?customerCode=C123456' \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json'" - lang: Java source: "HttpResponse response = Unirest.get(\"https://sandbox-api.navisphere.com/v1/financials/invoiceSummaries?customerCode=C123456\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .asString();" - lang: NodeJS source: " var request = require(\"request\");\n\n var options = { method: 'GET',\n \turl: 'https://sandbox-api.navisphere.com/v1/financials/invoiceSummaries',\n \tqs: { customerCode: 'C123456' },\n \theaders: \n \t{ Authorization: 'Bearer YOU TOKEN',\n \t'Content-Type': 'application/json' } };\n\n request(options, function (error, response, body) {\n \tf (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/financials/invoiceSummaries?customerCode=C123456\");\n var request = new RestRequest(Method.GET);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n IRestResponse response = client.Execute(request);" responses: '200': description: Request successful content: application/json: schema: $ref: '#/components/schemas/invoiceSummaries' example: invoiceSummaries: - currencyCode: USD customerCode: C1313307 dueDate: '2019-08-05T05:00:00.000Z' invoiceAmount: 158.77 invoiceBalance: 158.77 invoiceDate: '2019-06-07T19:34:37.777Z' invoiceNumber: 6101050076 invoiceShipments: - branchCode: 0290 chrOrderNumber: 81986238 currencyCode: USD customerReferenceNumber: '55921' invoiceAmount: 158.77 invoiceBalance: 158.77 loadNumber: 296565499 receivedAmount: 0 salesRep: SCAGMIC receivedAmount: 0 releasedDate: '2019-06-07T20:01:00.000Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v1/financials/invoiceSummaries/{invoiceNumber}: get: description: Allows partner to retrieve specifics of an invoice. operationId: Invoice Retrieval tags: - Financials parameters: - name: invoiceNumber in: path description: Invoice number. Invoice number is retrieved from the invoiceSummaries call. required: true schema: type: integer example: 51421684 x-code-samples: - lang: Curl source: "curl -X GET \\ \n https://sandbox-api.navisphere.com/v1/financials/invoiceSummaries/51421684 \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json'" - lang: Java source: "HttpResponse response = Unirest.get(\"https://sandbox-api.navisphere.com/v1/financials/invoiceSummaries/51421684\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'GET',\n \turl: 'https://sandbox-api.navisphere.com/v1/financials/invoiceSummaries/51421684',\n \theaders: \n \t{ Authorization: 'Bearer YOU TOKEN',\n \t'Content-Type': 'application/json' } };\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });\n" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/financials/invoiceSummaries/51421684\");\n var request = new RestRequest(Method.GET);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n IRestResponse response = client.Execute(request);" responses: '200': description: Request successful content: application/json: schema: $ref: '#/components/schemas/invoiceSummary' example: currencyCode: USD customerCode: C1313307 dueDate: '2019-08-05T05:00:00.000Z' invoiceAmount: 158.77 invoiceBalance: 158.77 invoiceDate: '2019-06-07T19:34:37.777Z' invoiceNumber: 6101050076 invoiceShipments: - branchCode: 0290 chrOrderNumber: 81986238 currencyCode: USD customerReferenceNumber: '55921' invoiceAmount: 158.77 invoiceBalance: 158.77 loadNumber: 296565499 receivedAmount: 0 salesRep: SCAGMIC invoiceRates: - balance: 26.34 notes: 405 - Fuel Surcharge totalRateAmount: 26.34 rateCode: '405' ratePerUnit: 26.3375 rateType: Flat - Fla units: 1 - balance: 132.43 notes: 400 - Line Haul totalRateAmount: 132.43 rateCode: '400' ratePerUnit: 132.434 rateType: Flat - Fla units: 1 receivedAmount: 0 releasedDate: '2019-06-07T20:01:00.000Z' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. #---Documents-------------------------------------------------------------------------------------------- /v1/documents/generateBols: get: description: Allows partner to generate the blank order-level BOL for the load. A load can have many orders, and this BOL would reflect the individual order details. This route is intended to be called once the customer retrieves the `LOAD BOOKED` event from the Events product. This route produces the original "Generated BOL Retrieval" that provides a BOL for a single order on any shipment. operationId: GENERATED BOL RETRIEVAL - Order Level tags: - Documents parameters: - name: loadNumber in: query description: The load number that the BOL is associated with. required: true schema: type: integer - name: customerCode in: query description: The customer code that is linked to the load number. required: true schema: type: string - name: orderNumber in: query description: The order number that the load is associated with. required: true schema: type: integer - name: showItemNotes in: query description: Show item notes on the BOL. schema: type: boolean default: false x-code-samples: - lang: Curl source: "curl -X GET \\ \n https://sandbox-api.navisphere.com/v1/documents/generateBols?loadNumber=1234567&customerCode=C123456&orderNumber=123456 \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json'" - lang: Java source: "HttpResponse response = Unirest.get(\"https://sandbox-api.navisphere.com/v1/documents/generateBols?loadNumber=1234567&customerCode=C123456&orderNumber=123456\") \n .header(\"Content-Type\", \"application/json\") \n .header(\"Authorization\", \"Bearer YOU TOKEN\") \n .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'GET', \n url: 'https://sandbox-api.navisphere.com/v1/documents/generateBols?loadNumber=1234567&customerCode=C123456&orderNumber=123456',\n headers: { \n \tAuthorization: 'Bearer YOU TOKEN',\n \t'Content-Type': 'application/json'\n }};\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/documents/generateBols?loadNumber=1234567&customerCode=C123456&orderNumber=123456\"); \n var request = new RestRequest(Method.GET);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n IRestResponse response = client.Execute(request);" responses: '201': description: Request successful content: application/pdf: schema: type: string format: binary '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v1/documents/generateLoadBols: get: description: Allows partner to generate the blank load-level BOL for the shipment. This BOL would reflect load details. A load can have many orders. The load-level BOL may also contain API-retrieved end-carrier pro number and barcode, useful in LTL operations, tracking, and billing. This route is intended to be called once the customer retrieves the `LOAD BOOKED` or `PRO NUMBER ADDED` event from the Events product. operationId: GENERATED BOL RETRIEVAL - Load Level tags: - Documents parameters: - name: loadNumber in: query description: The load number that the BOL is associated with. required: true schema: type: integer - name: customerCode in: query description: The customer code that is linked to the load number. required: true schema: type: string - name: orderNumber in: query description: The order number that the load is associated with. required: true schema: type: integer - name: showItemNotes in: query description: Show item notes on the BOL. schema: type: boolean default: false - name: barcodeType in: query description: Show the barcode in different format types. schema: default: UNKNOWN enum: - UNKNOWN - CODE39 - CODE128 type: string - name: barcodeIdentifier in: query description: What the barcode will have as an Identifier. schema: type: string default: UNKNOWN enum: - UNKNOWN - LoadNumber - ProNumber - BillToReferenceNumber - name: showBarcode in: query description: Show barcode on the BOL. schema: type: boolean default: false - name: responseFileType in: query description: Defines the desired BOL file type. ZIP format is required if multiple documents are expected. PDF format is only capable of returning a single BOL page, and will error if there are multiple documents. It is recommended to set responseFileType to ZIP at all times if multi-stop is a possibility. schema: type: string default: application/pdf enum: - application/pdf - application/zip x-code-samples: - lang: Curl source: "curl -X GET \\ \n https://sandbox-api.navisphere.com/v1/documents/generateLoadBols?loadNumber=1234567&customerCode=C123456&orderNumber=123456 \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json'" - lang: Java source: "HttpResponse response = Unirest.get(\"https://sandbox-api.navisphere.com/v1/documents/generateLoadBols?loadNumber=1234567&customerCode=C123456&orderNumber=123456\") \n .header(\"Content-Type\", \"application/json\") \n .header(\"Authorization\", \"Bearer YOU TOKEN\") \n .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'GET', \n url: 'https://sandbox-api.navisphere.com/v1/documents/generateLoadBols?loadNumber=1234567&customerCode=C123456&orderNumber=123456',\n headers: { \n \tAuthorization: 'Bearer YOU TOKEN',\n \t'Content-Type': 'application/json'\n }};\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/documents/generateLoadBols?loadNumber=1234567&customerCode=C123456&orderNumber=123456\"); \n var request = new RestRequest(Method.GET);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n IRestResponse response = client.Execute(request);" responses: '201': description: Request successful content: application/pdf: schema: type: string format: binary '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v1/documents/invoices/{invoiceNumber}: get: description: Allows partner to retrieve PDF document of an invoice. operationId: Invoice Document Retrieval tags: - Documents parameters: - name: invoiceNumber in: path description: The invoice number tied to the PDF. invoiceNumber is retrieved using the invoice calls in our financials product. required: true schema: type: integer x-code-samples: - lang: Curl source: "curl -X GET \\ \n https://sandbox-api.navisphere.com/v1/documents/invoices/12345 \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json'" - lang: Java source: "HttpResponse response = Unirest.get(\"https://sandbox-api.navisphere.com/v1/documents/invoices/12345\") \n .header(\"Content-Type\", \"application/json\") \n .header(\"Authorization\", \"Bearer YOU TOKEN\") \n .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'GET', \n url: 'https://sandbox-api.navisphere.com/v1/documents/invoices/12345',\n headers: { \n \tAuthorization: 'Bearer YOU TOKEN',\n \t'Content-Type': 'application/json'\n }};\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/documents/invoices/12345\"); \n var request = new RestRequest(Method.GET);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n IRestResponse response = client.Execute(request);" responses: '200': description: Request successful content: application/pdf: schema: type: string format: binary '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v1/documents/retrieveDocumentIds: get: description: Allows partner to retrieve list of document IDs. operationId: Load Document ID Retrieval tags: - Documents parameters: - name: loadNumber in: query description: C.H. Robinson load number. required: true schema: type: integer - name: documentTypes in: query description: "Identifies the document type that is being requested. If querying more than one document type, list needs to be comma-separated. Below are the most common documents to pull \n\n`BOL` - Bill of Lading, `POD` - Proof of Delivery, `LUMPER` - Lumper Receipt \n\nFor a detailed description of all enumerated codes please find them here." required: true schema: type: array items: enum: - ACCESSOR - AG - AGT_PRE - AS_CONFRM - AWBLABEL - BAD - BANKINGLC - BLINSTRUCT - BOL - BOOKADVICE - BOOKCONF - BOOKORDER - BROK_AN - CANADAA8A - CARARRNOT - CARBOOKNOT - CARGOREL - CARNOTIF - CARRPTHBL - CARRPTHBLR - CARSELFBIL - CBP28 - CBP29 - CBP301SEB - CBP3229 - CBP3299 - CBP3311 - CBP3461 - CBP349 - CBP3499 - CBP4811 - CBP5106 - CBP5297 - CBP7501 - CBP7512 - CBP7514 - CBP7551 - CBPADCVD - CBPCarnet - CBPCW - CBPMRK - CBPPEA - CBPPROTEST - CLAIM - CLN_CER - COA - COMDOCS - COMM_INV - CONFIRM - COO - COURTNOTE - CREDIT - CROSSTOWN - CUSFRTAV - CUST_AN - CUST_OTHER - CUST_PRE - CUSTDO - CUSTOMS - CUSTRATEAG - DAIRDALRT - DAIRPRDET - DAIRWAYBIL - DANGERCHK - DAWB - DE_ExportA - DE_ExportV - DE_Ocean - DE_OceanAB - DE_OceanAK - DE_OceanAT - DE_OceanGP - DE_OceanHZ - DE_OceanKN - DE_OceanKS - DE_OceanVN - DEDUCT - DELIVERY - DELORDER - DEMMURAGE - DESTCUST - DOCKRCPT - DRAFTHBL - DRAFTHBLR - EMLCOOR - EVENTNOTE - EXPHBL - EXPHBLR - EXPSHIPINV - FCONFIRM - FCR - FCRA - FF_BOL - FUMC - HAWB - HAZMAT - HAZMATDEC - IMPSHIPINV - INSDOCS - INSPC - INTL_10PLY - INTL_ACN - INTL_ARASL - INTL_BOL - INTL_BVA - INTL_CMR - INTL_POD - INTLOTHINV - INTLREL - INVOICE - ISFDOC - J1 - LINESREP - LUMPER - MANIFEST - MAWB - MBL - MBL_PROOF - MBL_RATE - MBL_UNRATE - MRN - MSDS - NA_INLAND - NONEHBL - NONEHBLR - NONNEGHBL - NONNEGHBLR - ODOMETER - OGA - ORGHBL - ORGHBLR - ORIGINCUST - OTHER - OVERDIM - PACK_LIST - PALLETS - PARCELLBL - PICKUP - PIXOS_EP - PO - POD - PROINV - PTT - PUORDER - RATEFILING - RCARD - RHC - SA_BACKUP - SACARINV - SEAWYHBL - SEAWYHBLR - SED - SELFBILL - SHIP - SHIPINST - SHIPINV - SQUOTE - SRNDRHBL - SRNDRHBLR - STATACCT - TELXHBL - TELXHBLR - TENDER - THERMO - TSACCSF - TSAKNOWN - TSAUNKNOWN - UNDET - WAYBILL - WHSE_OSD - WOODPACK - WT - name: from in: query description: Starting date/time of document search. required: false schema: type: string format: date-time - name: to in: query description: Ending date/time of document search. required: false schema: type: string format: date-time x-code-samples: - lang: Curl source: "curl -X GET \\ \n https://sandbox-api.navisphere.com/v1/documents/retrieveDocumentIds?loadNumber=315545893&documentTypes=BOL,POD,LUMPER \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json'" - lang: Java source: "HttpResponse response = Unirest.get(\"https://sandbox-api.navisphere.com/v1/documents/retrieveDocumentIds?loadNumber=315545893&documentTypes=BOL,POD,LUMPER\") \n .header(\"Content-Type\", \"application/json\") \n .header(\"Authorization\", \"Bearer YOU TOKEN\") \n .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'GET', \n url: 'https://sandbox-api.navisphere.com/v1/documents/retrieveDocumentIds?loadNumber=315545893&documentTypes=BOL,POD,LUMPER',\n headers: { \n \tAuthorization: 'Bearer YOU TOKEN',\n \t'Content-Type': 'application/json'\n }};\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/documents/retrieveDocumentIds?loadNumber=315545893&documentTypes=BOL,POD,LUMPER\"); \n var request = new RestRequest(Method.GET);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n IRestResponse response = client.Execute(request);" responses: '200': description: Request successful content: application/json: schema: $ref: '#/components/schemas/documentIdResults' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v1/documents/{documentId}: get: description: Allows partner to retrieve BOLs, PODs, and Lumper receipts. operationId: Load Document Retrieval tags: - Documents parameters: - name: documentId in: path description: The document ID that links to image. documentId is retrieved using our retrieveDocumentIds route. required: true schema: type: integer x-code-samples: - lang: Curl source: "curl -X GET \\ \n https://sandbox-api.navisphere.com/v1/documents/862077900 \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json'" - lang: Java source: "HttpResponse response = Unirest.get(\"https://sandbox-api.navisphere.com/v1/documents/862077900\") \n .header(\"Content-Type\", \"application/json\") \n .header(\"Authorization\", \"Bearer YOU TOKEN\") \n .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'GET', \n url: 'https://sandbox-api.navisphere.com/v1/documents/862077900',\n headers: { \n \tAuthorization: 'Bearer YOU TOKEN',\n \t'Content-Type': 'application/json'\n }};\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/documents/862077900\"); \n var request = new RestRequest(Method.GET);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n IRestResponse response = client.Execute(request);" responses: '200': description: Request successful. **Multiple file formats that can be returned.** content: image/*: schema: type: string format: binary application/pdf: schema: type: string format: binary '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /events/LoadDocuments/here: servers: - url: https://yourserver.com description: partner defined endpoint for documents post: security: - bearerAuth: [] description: This is the endpoint where load documents can be pushed. x-beta: true operationId: Load Documents Callback tags: - Documents requestBody: description: JSON object of Load Detail message. required: true content: application/json: schema: $ref: '#/components/schemas/loadDocumentCallback' responses: '200': description: OK content: text/plain: schema: type: string /v1/documents/{loadNumber}: post: description: Both base64 and binary can be accepted by making a selection in the dropdown next to "Request Body Schema". Binary is form-data, base64 is application/json. operationId: Carrier Document Upload x-tryit: false tags: - Documents parameters: - name: loadNumber in: path description: The C.H. Robinson load number the document will be tied too. required: true schema: type: integer requestBody: description: "File upload." required: true content: multipart/form-data: schema: type: object required: - file - docType properties: file: type: string description: "Max file size is 40 MB." format: binary docType: $ref: '#/components/schemas/docTypeEnum' application/json: schema: type: object required: - fileName - mimeType - data - docType properties: fileName: type: string description: "Name of the file." mimeType: type: string description: "MIME type of the file." enum: - application/pdf - image/tiff - image/jpeg - image/png - image/gif - image/bmp data: type: string description: "Base64 encoded file data. Max file size is 40 MB." docType: $ref: '#/components/schemas/docTypeEnum' x-code-samples: - lang: Curl source: "curl -X POST \\ \n 'https://sandbox-api.navisphere.com/v1/documents/20015434520' \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: multipart/form-data'" - lang: Java source: "HttpResponse response = Unirest.post(\"https://sandbox-api.navisphere.com/v1/documents/20015434520\")\n .header(\"Content-Type\", \"multipart/form-data\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .asString();" - lang: NodeJS source: " const request = require(\"request\");\n const fs = require(\"fs\"); \n\n var options = { method: 'POST',\n url: 'https://sandbox-api.navisphere.com/v1/documents/20015434520',\n headers: { \n \tAuthorization: 'Bearer YOU TOKEN',\n \tContent-Type: 'multipart/form-data' \n }, \n formData: { \tdocType: 'BOL'\n \tfile: fs.createReadStream(\"/Users/guest/Desktop/test.png\"); \n }};\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/documents/20015434520\");\n var request = new RestRequest(Method.POST);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"multipart/form-data\");\n IRestResponse response = client.Execute(request);" responses: '201': description: Request successful '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. #---Shipments-------------------------------------------------------------------------------------------- /v2/shipments/available/searches: post: description: Allows partner to retrieve list summary of shipments available for transportation. operationId: Available Shipment Search tags: - Shipments requestBody: description: Returns a list of available shipments. required: true content: application/json: schema: $ref: '#/components/schemas/availableShipmentsSearchV2' examples: RequestByRadius: value: pageIndex: 0 pageSize: 100 regionCode: NA modes: - V - R originRadiusSearch: coordinate: lat: 37.775 lon: -122.41833 radius: value: 1000 unitOfMeasure: Standard destinationRadiusSearch: coordinate: lat: 37.775 lon: -122.41833 radius: value: 1000 unitOfMeasure: Standard loadDistanceRange: unitOfMeasure: Standard min: 0 max: 5000 loadWeightRange: unitOfMeasure: Standard min: 0 max: 48000 equipmentLengthRange: unitOfMeasure: Standard min: 0 max: 53 availableForPickUpByDateRange: min: '2021-06-29' max: '2021-06-30' teamLoad: true stfLoad: true hazMatLoad: true tankerLoad: true chemicalSolutionLoad: true highValueLoad: true sortCriteria: field: LoadNumber direction: ascending RequestByStates: value: pageIndex: 0 pageSize: 100 regionCode: NA excludedModes: - B origins: - countryCode: US stateCodes: - CA - MN - GA - IA destinations: - countryCode: US stateCodes: - CA - MN - GA - IA loadDistanceRange: unitOfMeasure: Standard min: 0 max: 5000 loadWeightRange: unitOfMeasure: Standard min: 0 max: 48000 equipmentLengthRange: unitOfMeasure: Standard min: 0 max: 53 availableForPickUpByDateRange: min: '2021-06-29' max: '2021-06-30' teamLoad: true stfLoad: true hazMatLoad: true tankerLoad: true chemicalSolutionLoad: true highValueLoad: true sortCriteria: field: LoadNumber direction: ascending responses: '200': description: The available shipments content: application/json: schema: $ref: '#/components/schemas/availableShipmentsResponseV2' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v1/shipments/{loadNumber}/offers: post: description: "Allows carrier to submit an offer on a load found through the Available Shipment search if load has associated availableLoadCost(s)." x-beta: true operationId: Load Offer tags: - Shipments parameters: - in: path name: loadNumber schema: type: integer required: true requestBody: description: JSON object of offer request. required: true content: application/json: schema: $ref: '#/components/schemas/loadOffer' example: carrierCode: T100 offerPrice: 500 offerNote: Note goes here currencyCode: USD availableLoadCost: 600 responses: 202: description: Request successful content: application/json: schema: $ref: '#/components/schemas/offerAcknowledgment' 400: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' example: - message: '"referenceNumber" is not allowed' path: - referenceNumber type: object.allowUnknown context: child: referenceNumber value: - type: MBOL value: MBOL12345 key: referenceNumber label: referenceNumber 401: description: Unauthorized content: application/json: schema: type: array items: $ref: '#/components/schemas/error401' 403: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' 404: description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' 422: description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/error422' 500: description: Internal Server Error. Please contact your C.H. Robinson Rep. /offerResponse/callback/here: servers: - url: https://yourserver.com description: partner defined endpoint post: security: - bearerAuth: [] description: This is the endpoint on your server where we will send the offer response for loads you have made offers on. x-beta: true operationId: Offer Response Callback tags: - Shipments requestBody: description: JSON object of Offer Response message. required: true content: application/json: schema: $ref: '#/components/schemas/offerResponse' responses: '2XX': description: Your server returns this code if it accepts the callback content: text/plain: schema: type: string example: OK /v1/shipments/books: post: description: "Allows carrier to book a load found through the Available Shipment search if load has associated availableLoadCost(s)." operationId: Load Book tags: - Shipments requestBody: description: JSON object of booking request. required: true content: application/json: schema: $ref: '#/components/schemas/loadBookV2' example: loadNumber: 102888682 carrierCode: T100 emptyDateTime: '2021-08-11T16:43:18.574Z' emptyLocation: city: Kansas City state: MO country: US zip: '64155' availableLoadCosts: - type: Flat code: '400' description: Line Haul currencyCode: USD sourceCostPerUnit: 100.95 units: 1 rateConfirmation: email: test@chrobinson.com name: Test User responses: 202: description: Request successful 400: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' example: - message: '"referenceNumber" is not allowed' path: - referenceNumber type: object.allowUnknown context: child: referenceNumber value: - type: MBOL value: MBOL12345 key: referenceNumber label: referenceNumber 401: description: Unauthorized content: application/json: schema: type: array items: $ref: '#/components/schemas/error401' 403: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' 404: description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' 422: description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/error422' 500: description: Internal Server Error. Please contact your C.H. Robinson Rep. /shipmentDetails/callback/here: servers: - url: https://yourserver.com description: partner defined endpoint post: security: - bearerAuth: [] description: This is the endpoint on your server where we will send the shipment details for loads you have booked. x-beta: true operationId: Shipment Details Callback tags: - Shipments requestBody: description: JSON object of Load Detail message. required: true content: application/json: schema: $ref: '#/components/schemas/shipmentDetail' responses: '2XX': description: Your server returns this code if it accepts the callback content: text/plain: schema: type: string example: OK /v1/shipments/milestones: post: description: "Allows carrier, vendor, or other updating entity to update C.H. Robinson on any shipment." operationId: Milestone Updates tags: - Shipments requestBody: description: JSON object of mileston Update. required: true content: application/json: schema: $ref: '#/components/schemas/milestone' example: eventCode: X3 shipmentIdentifier: shipmentNumber: '123456789' shipperBillToId: '123456789' proNumber: PRO512461 trackingNumber: 1Z1245132579423 containerNumber: HBJ51423 dateTime: eventDateTime: '2019-06-05T18:36:13.131Z' estimatedTimeOfArrival: '2019-06-05T18:36:13.131Z' appointmentWindow: openDateTime: '2019-06-05T18:36:13.131Z' closeDateTime: '2019-06-05T18:36:13.131Z' carrier: name: Test Carrier dotNumber: Test mcNumber: MC Number scac: RBTW temperature: 32 temperatureUnitOfMeasure: Fahrenheit vehicleDetail: tractorNumber: '375' trailerNumber: PV5346 licensePlate: MCV246 licensePlateState: MN vin: 1HGBH41JXMN109186 contactInformation: driverName: Red Barkley driverPhone: '5556129457' secondDriverName: Lincoln Hawk secondDriverPhone: '5554843167' dispatchName: Kylo Ren dispatchPhone: '5558675309' location: type: drop stopSequenceNumber: 2 sequenceNumber: 1 name: Bulk Goods Warehouse locationId: W4875164 address: address1: 14800 Charlson Rd address2: Building 1 city: Eden Prairie latitude: 44.820538 longitude: -93.464427 stateProvinceCode: MN postalCode: '55347' country: US items: - itemId: '123456' weight: 45 weightUnitOfMeasure: Pounds quantity: 12 pallets: 1 supplementalInformation: reasonCode: '1' notes: Truck broke its axle x-code-samples: - lang: Curl source: "curl -X POST \\ \n 'https://sandbox-api.navisphere.com/v1/shipments/milestones' \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json' \n -d '{ \t\"eventCode\": \"X3\",\n \t\"shipmentIdentifier\": {\n \t\t\"shipmentNumber\": \"123456789\",\n \t\t\"shipperBillToId\": \"123456789\",\n \t\t\"proNumber\": \"PRO512461\",\n \t\t\"trackingNumber\": \"1Z1245132579423\",\n \t\t\"containerNumber\": \"HBJ51423\" \n \t\ }, \n \t\"dateTime\": {\n \t\t\"eventDateTime\": \"2019-06-05T18:36:13.131Z\",\n \t\t\"estimatedTimeOfArrival\": \"2019-06-05T18:36:13.131Z\",\n \t\t\"appointmentWindow\": {\n \t\t\t\"openDateTime\": \"2019-06-05T18:36:13.131Z\",\n \t\t\t\"closeDateTime\": \"2019-06-05T18:36:13.131Z\"\n \t\t\ } \n \t\ }, \n \t\"carrier\": {\n \t\t\"name\": \"Test Carrier\",\n \t\t\"dotNumber\": \"Test\",\n \t\t\"scac\": \"RBTW\",\n \t\t\"temperature\": 32,\n \t\t\"temperatureUnitOfMeasure\": \"Fahrenheit\",\n \t\t\"vehicleDetail\": {\n \t\t\t\"tractorNumber\": \"375\",\n \t\t\t\"trailerNumber\": \"PV5346\",\n \t\t\t\"licensePlate\": \"MCV246\",\n \t\t\t\"licensePlateState\": \"MN\",\n \t\t\t\"vin\": \"1HGBH41JXMN109186\",\n \t\t\t\"contactInformation\": {\n \t\t\t\t\"driverName\": \"Red Barkley\",\n \t\t\t\t\"driverPhone\": \"5556129457\",\n \t\t\t\t\"secondDriverName\": \"Lincoln Hawk\",\n \t\t\t\t\"secondDriverPhone\": \"5554843167\",\n \t\t\t\t\"dispatchName\": \"Kylo Ren\",\n \t\t\t\t\"dispatchPhone\": \"5558675309\"\n \t\t\t\ } \n \t\t\ } \n \t\ }, \n \t\"location\": {\n \t\t\"type\": \"drop\",\n \t\t\"stopSequenceNumber\": 2,\n \t\t\"sequenceNumber\": 1,\n \t\t\"name\": \"Bulk Goods Warehouse\",\n \t\t\"locationId\": \"W4875164\",\n \t\t\"address\": {\n \t\t\t\"address1\": \"14800 Charlson Rd\",\n \t\t\t\"address2\": \"Building 1\",\n \t\t\t\"city\": \"Eden Prairie\",\n \t\t\t\"latitude\": 44.820538,\n \t\t\t\"longitude\": -93.464427,\n \t\t\t\"stateProvinceCode\": \"MN\",\n \t\t\t\"postalCode\": \"55347\",\n \t\t\t\"country\": \"US\"\n \t\t\ } \n \t\ }, \n \t\"items\": [{\n \t\t\"itemId\": \"123456\",\n \t\t\"weight\": 45,\n \t\t\"weightUnitOfMeasure\": \"Pounds\",\n \t\t\"quantity\": 12,\n \t\t\"pallets\": 1\n \t\ }], \n \t\"supplementalInformation\": {\n \t\t\"reasonCode\": \"1\",\n \t\t\"notes\": \"Truck broke its axle\"\n \t\ } \n }'" - lang: Java source: "HttpResponse response = Unirest.post(\"https://sandbox-api.navisphere.com/v1/shipments/milestones\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .body(\"{\n \t\"eventCode\": \"X3\",\n \t\"shipmentIdentifier\": {\n \t\t\"shipmentNumber\": \"123456789\",\n \t\t\"shipperBillToId\": \"123456789\",\n \t\t\"proNumber\": \"PRO512461\",\n \t\t\"trackingNumber\": \"1Z1245132579423\",\n \t\t\"containerNumber\": \"HBJ51423\" \n \t\ }, \n \t\"dateTime\": {\n \t\t\"eventDateTime\": \"2019-06-05T18:36:13.131Z\",\n \t\t\"estimatedTimeOfArrival\": \"2019-06-05T18:36:13.131Z\",\n \t\t\"appointmentWindow\": {\n \t\t\t\"openDateTime\": \"2019-06-05T18:36:13.131Z\",\n \t\t\t\"closeDateTime\": \"2019-06-05T18:36:13.131Z\"\n \t\t\ } \n \t\ }, \n \t\"carrier\": {\n \t\t\"name\": \"Test Carrier\",\n \t\t\"dotNumber\": \"Test\",\n \t\t\"scac\": \"RBTW\",\n \t\t\"temperature\": 32,\n \t\t\"temperatureUnitOfMeasure\": \"Fahrenheit\",\n \t\t\"vehicleDetail\": {\n \t\t\t\"tractorNumber\": \"375\",\n \t\t\t\"trailerNumber\": \"PV5346\",\n \t\t\t\"licensePlate\": \"MCV246\",\n \t\t\t\"licensePlateState\": \"MN\",\n \t\t\t\"vin\": \"1HGBH41JXMN109186\",\n \t\t\t\"contactInformation\": {\n \t\t\t\t\"driverName\": \"Red Barkley\",\n \t\t\t\t\"driverPhone\": \"5556129457\",\n \t\t\t\t\"secondDriverName\": \"Lincoln Hawk\",\n \t\t\t\t\"secondDriverPhone\": \"5554843167\",\n \t\t\t\t\"dispatchName\": \"Kylo Ren\",\n \t\t\t\t\"dispatchPhone\": \"5558675309\"\n \t\t\t\ } \n \t\t\ } \n \t\ }, \n \t\"location\": {\n \t\t\"type\": \"drop\",\n \t\t\"stopSequenceNumber\": 2,\n \t\t\"sequenceNumber\": 1,\n \t\t\"name\": \"Bulk Goods Warehouse\",\n \t\t\"locationId\": \"W4875164\",\n \t\t\"address\": {\n \t\t\t\"address1\": \"14800 Charlson Rd\",\n \t\t\t\"address2\": \"Building 1\",\n \t\t\t\"city\": \"Eden Prairie\",\n \t\t\t\"latitude\": 44.820538,\n \t\t\t\"longitude\": -93.464427,\n \t\t\t\"stateProvinceCode\": \"MN\",\n \t\t\t\"postalCode\": \"55347\",\n \t\t\t\"country\": \"US\"\n \t\t\ } \n \t\ }, \n \t\"items\": [{\n \t\t\"itemId\": \"123456\",\n \t\t\"weight\": 45,\n \t\t\"weightUnitOfMeasure\": \"Pounds\",\n \t\t\"quantity\": 12,\n \t\t\"pallets\": 1\n \t\ }], \n \t\"supplementalInformation\": {\n \t\t\"reasonCode\": \"1\",\n \t\t\"notes\": \"Truck broke its axle\"\n \t\ } \n } \") .asString();" - lang: NodeJS source: " var request = require(\"request\");\n\n var options = { method: 'POST',\n url: 'https://sandbox-api.navisphere.com/v1/shipments/milestones',\n headers: { \n \tAuthorization: 'Bearer YOU TOKEN',\n \t'Content-Type': 'application/json'} \n body: { \n \t\"eventCode\": \"X3\",\n \t\"shipmentIdentifier\": {\n \t\t\"shipmentNumber\": \"123456789\",\n \t\t\"shipperBillToId\": \"123456789\",\n \t\t\"proNumber\": \"PRO512461\",\n \t\t\"trackingNumber\": \"1Z1245132579423\",\n \t\t\"containerNumber\": \"HBJ51423\" \n \t\ }, \n \t\"dateTime\": {\n \t\t\"eventDateTime\": \"2019-06-05T18:36:13.131Z\",\n \t\t\"estimatedTimeOfArrival\": \"2019-06-05T18:36:13.131Z\",\n \t\t\"appointmentWindow\": {\n \t\t\t\"openDateTime\": \"2019-06-05T18:36:13.131Z\",\n \t\t\t\"closeDateTime\": \"2019-06-05T18:36:13.131Z\"\n \t\t\ } \n \t\ }, \n \t\"carrier\": {\n \t\t\"name\": \"Test Carrier\",\n \t\t\"dotNumber\": \"Test\",\n \t\t\"scac\": \"RBTW\",\n \t\t\"temperature\": 32,\n \t\t\"temperatureUnitOfMeasure\": \"Fahrenheit\",\n \t\t\"vehicleDetail\": {\n \t\t\t\"tractorNumber\": \"375\",\n \t\t\t\"trailerNumber\": \"PV5346\",\n \t\t\t\"licensePlate\": \"MCV246\",\n \t\t\t\"licensePlateState\": \"MN\",\n \t\t\t\"vin\": \"1HGBH41JXMN109186\",\n \t\t\t\"contactInformation\": {\n \t\t\t\t\"driverName\": \"Red Barkley\",\n \t\t\t\t\"driverPhone\": \"5556129457\",\n \t\t\t\t\"secondDriverName\": \"Lincoln Hawk\",\n \t\t\t\t\"secondDriverPhone\": \"5554843167\",\n \t\t\t\t\"dispatchName\": \"Kylo Ren\",\n \t\t\t\t\"dispatchPhone\": \"5558675309\"\n \t\t\t\ } \n \t\t\ } \n \t\ }, \n \t\"location\": {\n \t\t\"type\": \"drop\",\n \t\t\"stopSequenceNumber\": 2,\n \t\t\"sequenceNumber\": 1,\n \t\t\"name\": \"Bulk Goods Warehouse\",\n \t\t\"locationId\": \"W4875164\",\n \t\t\"address\": {\n \t\t\t\"address1\": \"14800 Charlson Rd\",\n \t\t\t\"address2\": \"Building 1\",\n \t\t\t\"city\": \"Eden Prairie\",\n \t\t\t\"latitude\": 44.820538,\n \t\t\t\"longitude\": -93.464427,\n \t\t\t\"stateProvinceCode\": \"MN\",\n \t\t\t\"postalCode\": \"55347\",\n \t\t\t\"country\": \"US\"\n \t\t\ } \n \t\ }, \n \t\"items\": [{\n \t\t\"itemId\": \"123456\",\n \t\t\"weight\": 45,\n \t\t\"weightUnitOfMeasure\": \"Pounds\",\n \t\t\"quantity\": 12,\n \t\t\"pallets\": 1\n \t\ }], \n \t\"supplementalInformation\": {\n \t\t\"reasonCode\": \"1\",\n \t\t\"notes\": \"Truck broke its axle\"\n \t\ } \n }};\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/shipments/milestones\");\n var request = new RestRequest(Method.POST);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n request.AddParameter(\"undefined\", \"{ \t\"eventCode\": \"X3\",\n \t\"shipmentIdentifier\": {\n \t\t\"shipmentNumber\": \"123456789\",\n \t\t\"shipperBillToId\": \"123456789\",\n \t\t\"proNumber\": \"PRO512461\",\n \t\t\"trackingNumber\": \"1Z1245132579423\",\n \t\t\"containerNumber\": \"HBJ51423\" \n \t\ }, \n \t\"dateTime\": {\n \t\t\"eventDateTime\": \"2019-06-05T18:36:13.131Z\",\n \t\t\"estimatedTimeOfArrival\": \"2019-06-05T18:36:13.131Z\",\n \t\t\"appointmentWindow\": {\n \t\t\t\"openDateTime\": \"2019-06-05T18:36:13.131Z\",\n \t\t\t\"closeDateTime\": \"2019-06-05T18:36:13.131Z\"\n \t\t\ } \n \t\ }, \n \t\"carrier\": {\n \t\t\"name\": \"Test Carrier\",\n \t\t\"dotNumber\": \"Test\",\n \t\t\"scac\": \"RBTW\",\n \t\t\"temperature\": 32,\n \t\t\"temperatureUnitOfMeasure\": \"Fahrenheit\",\n \t\t\"vehicleDetail\": {\n \t\t\t\"tractorNumber\": \"375\",\n \t\t\t\"trailerNumber\": \"PV5346\",\n \t\t\t\"licensePlate\": \"MCV246\",\n \t\t\t\"licensePlateState\": \"MN\",\n \t\t\t\"vin\": \"1HGBH41JXMN109186\",\n \t\t\t\"contactInformation\": {\n \t\t\t\t\"driverName\": \"Red Barkley\",\n \t\t\t\t\"driverPhone\": \"5556129457\",\n \t\t\t\t\"secondDriverName\": \"Lincoln Hawk\",\n \t\t\t\t\"secondDriverPhone\": \"5554843167\",\n \t\t\t\t\"dispatchName\": \"Kylo Ren\",\n \t\t\t\t\"dispatchPhone\": \"5558675309\"\n \t\t\t\ } \n \t\t\ } \n \t\ }, \n \t\"location\": {\n \t\t\"type\": \"drop\",\n \t\t\"stopSequenceNumber\": 2,\n \t\t\"sequenceNumber\": 1,\n \t\t\"name\": \"Bulk Goods Warehouse\",\n \t\t\"locationId\": \"W4875164\",\n \t\t\"address\": {\n \t\t\t\"address1\": \"14800 Charlson Rd\",\n \t\t\t\"address2\": \"Building 1\",\n \t\t\t\"city\": \"Eden Prairie\",\n \t\t\t\"latitude\": 44.820538,\n \t\t\t\"longitude\": -93.464427,\n \t\t\t\"stateProvinceCode\": \"MN\",\n \t\t\t\"postalCode\": \"55347\",\n \t\t\t\"country\": \"US\"\n \t\t\ } \n \t\ }, \n \t\"items\": [{\n \t\t\"itemId\": \"123456\",\n \t\t\"weight\": 45,\n \t\t\"weightUnitOfMeasure\": \"Pounds\",\n \t\t\"quantity\": 12,\n \t\t\"pallets\": 1\n \t\ }], \n \t\"supplementalInformation\": {\n \t\t\"reasonCode\": \"1\",\n \t\t\"notes\": \"Truck broke its axle\"\n \t\ } \n }\") IRestResponse response = client.Execute(request);" responses: 201: description: Request successful 400: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' example: - message: '"referenceNumber" is not allowed' path: - referenceNumber type: object.allowUnknown context: child: referenceNumber value: - type: MBOL value: MBOL12345 key: referenceNumber label: referenceNumber 401: description: Unauthorized content: application/json: schema: type: array items: $ref: '#/components/schemas/error401' 403: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' 404: description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' 500: description: Internal Server Error. Please contact your C.H. Robinson Rep. #---PurchaseOrder---------------------------------------------------------------------------------------- #/v1/purchaseorders: # post: # description: "Allows partner to create a purchase order in C.H. Robinson's Navisphere® PO Management system." # operationId: Purchase Order Create # tags: # - Purchase Orders # requestBody: # description: JSON object of a Purchase Order order. # required: true # content: # application/json: # schema: # $ref: '#/components/schemas/purchaseOrder' # example: # customerCode: C4106146 # customerCreatedDate: '2019-04-15T20:30:00.0000000Z' # customerName: Domino's Equipment & Supply # customerPONumber: '9191' # customerContact: # name: Contact One # contactMethods: # - method: Phone # value: '5554678415' # incoLocation: MPLS # incoTerms: EXW # purchaseOrderItems: # - customerPoLineNumber: sd156130 # poLineItemValue: '2000' # productName: Pizza Table square # freightTerms: CL # cpsiaTestRequired: 'true' # cpsiaTestPassed: 'true' # innerPackInsuranceValue: '1000' # innerPackType: BALE # innerPackQty: '10' # innerPackOriginalQty: '5' # innerPackHeight: '2' # innerPackLength: '5' # innerPackWidth: '7' # innerPackUnitOfMeasure: Inches # innerPackWeight: '100' # innerPackWeightUnitOfMeasure: pounds # outerPackHeight: '20' # outerPackLength: '10' # outerPackWidth: '5' # outerPackWeight: '150' # outerPackUnitOfMeasure: Inches # outerPackWeightUnitOfMeasure: Pounds # supplier: # supplierName: Advance Tabco # address: # address1: 6 Industrial Dr # city: Dyer # stateProvinceCode: TN # postalCode: '38330' # country: US # contact: # name: Contact One # contactMethods: # - method: Phone # value: '5554678415' # outerPackType: PLT # outerPackStuffingQty: '1' # partNumber: part20 # productCode: ery789 # sku: 5685-555 # requestedBookingDate: '2019-04-20T20:30:00.0000000Z' # requestedPickupDate: '2019-04-25T20:30:00.0000000Z' # requestedDeliveryDate: '2019-04-30T20:30:00.0000000Z' # locations: # - name: Domino's Pizza LLC # address: # address1: 5216 W. MOHAVE # city: PHOENIX # stateProvinceCode: AZ # postalCode: '85043' # country: US # stopType: PICK # stopSequence: '1' # relatedParties: # - partyName: Test # partyId: 12345 # contact: # name: Contact One # contactMethods: # - method: Phone # value: '5554678415' # - name: DOMINO'S PIZZA # address: # address1: 7385 RADIO RD # address2: SUITE 102 # city: Naples # stateProvinceCode: FL # postalCode: '34104' # country: US # stopType: DROP # stopSequence: '2' # relatedParties: # - partyName: Test # partyId: 12345 # contact: # name: Contact One # contactMethods: # - method: Phone # value: '5554678415' # x-code-samples: # - lang: Curl # source: "curl -X POST \\ \n # 'https://sandbox-api.navisphere.com/v1/purchaseorders' \\ \n # -H 'Authorization: Bearer YOU TOKEN' \\ \n # -H 'Content-Type: application/json' \n # -d '{\n # \t\"customerCode\": \"C4106146\",\n # \t\"customerCreatedDate\": \"2019-04-15T20:30:00.0000000Z\",\n # \t\"customerName\": \"Domino's Equipment & Supply\",\n # \t\"customerPONumber\": \"9191\",\n # \t\"customerContact\": {\n # \t\t\"name\": \"Contact One\",\n # \t\t\"contactMethods\": [{\n # \t\t\t\"method\": \"Phone\",\n # \t\t\t\"value\": \"5554678415\"\n # \t\t }] \n # \t\ } \n # \t\"incoLocation\": \"MPLS\",\n # \t\"incoTerms\": \"EXW\",\n # \t\"purchaseOrderItems\": [{\n # \t\t\"customerPoLineNumber\": \"sd156130\",\n # \t\t\"poLineItemValue\": \"2000\",\n # \t\t\"productName\": \"Pizza Table square\",\n # \t\t\"freightTerms\": \"CL\",\n # \t\t\"cpsiaTestRequired\": \"true\",\n # \t\t\"cpsiaTestPassed\": \"true\",\n # \t\t\"innerPackInsuranceValue\": \"1000\",\n # \t\t\"innerPackType\": \"BALE\",\n # \t\t\"innerPackQty\": \"10\",\n # \t\t\"innerPackOriginalQty\": \"5\",\n # \t\t\"innerPackHeight\": \"2\",\n # \t\t\"innerPackLength\": \"5\",\n # \t\t\"innerPackWidth\": \"7\",\n # \t\t\"innerPackUnitOfMeasure\": \"Inches\",\n # \t\t\"innerPackWeight\": \"100\",\n # \t\t\"innerPackWeightUnitOfMeasure\": \"pounds\",\n # \t\t\"outerPackHeight\": \"20\",\n # \t\t\"outerPackLength\": \"10\",\n # \t\t\"outerPackWidth\": \"5\",\n # \t\t\"outerPackWeight\": \"150\",\n # \t\t\"outerPackUnitOfMeasure\": \"Inches\",\n # \t\t\"outerPackWeightUnitOfMeasure\": \"Pounds\",\n # \t\t\"supplier\": {\n # \t\t\t\"supplierName\": \"Advance Tabco\",\n # \t\t\t\"address\": { \n # \t\t\t\t\"address1\": \"6 Industrial Dr\",\n # \t\t\t\t\"city\": \"Dyer\",\n # \t\t\t\t\"stateProvinceCode\": \"TN\",\n # \t\t\t\t\"postalCode\": \"38330\",\n # \t\t\t\t\"country\": \"US\"\n # \t\t\t }, \n # \t\t\t\"contact\": { \n # \t\t\t\t\"name\": \"Contact One\",\n # \t\t\t\t\"contactMethods\": [{ \n # \t\t\t\t\t\"method\": \"Phone\",\n # \t\t\t\t\t\"value\": \"5554678415\"\n # \t\t\t\t\ }] \n # \t\t\t\ } \n # \t\t\ }, \n # \t\t\"outerPackType\": \"PLT\",\n # \t\t\"outerPackStuffingQty\": \"1\",\n # \t\t\"partNumber\": \"part20\",\n # \t\t\"productCode\": \"ery789\",\n # \t\t\"sku\": \"5685-555\",\n # \t\t\"requestedBookingDate\": \"2019-04-20T20:30:00.0000000Z\",\n # \t\t\"requestedPickupDate\": \"2019-04-25T20:30:00.0000000Z\",\n # \t\t\"requestedDeliveryDate\": \"2019-04-30T20:30:00.0000000Z\",\n # \t\t\"locations\": [{ \n # \t\t\t\"name\": \"Domino's Pizza LLC\",\n # \t\t\t\"address\": { \n # \t\t\t\t\"address1\": \"5216 W. MOHAVE\",\n # \t\t\t\t\"city\": \"PHOENIX\",\n # \t\t\t\t\"stateProvinceCode\": \"AZ\",\n # \t\t\t\t\"postalCode\": \"85043\",\n # \t\t\t\t\"country\": \"US\",\n # \t\t\t\ }, \n # \t\t\t\"stopType\": \"PICK\",\n # \t\t\t\"stopSequence\": \"1\",\n # \t\t\t\"relatedParties\": [{ \n # \t\t\t\t\"partyName\": \"Test\",\n # \t\t\t\t\"partyId\": 12345,\n # \t\t\t\ }], \n # \t\t\t\"contact\": { \n # \t\t\t\t\"name\": \"Contact One\",\n # \t\t\t\t\"contactMethods\": [{ \n # \t\t\t\t\t\"method\": \"Phone\",\n # \t\t\t\t\t\"value\": \"5554678415\"\n # \t\t\t\t\ }] \n # \t\t\t\ } \n # \t\t\ }, \n # \t\t\ { \n # \t\t\t\"name\": \"DOMINO'S PIZZA\",\n # \t\t\t\"address\": { \n # \t\t\t\t\"address1\": \"7385 RADIO RD\",\n # \t\t\t\t\"address2\": \"SUITE 102\",\n # \t\t\t\t\"city\": \"Naples\",\n # \t\t\t\t\"stateProvinceCode\": \"FL\",\n # \t\t\t\t\"postalCode\": \"34104\",\n # \t\t\t\t\"country\": \"US\",\n # \t\t\t\ }, \n # \t\t\t\"stopType\": \"DROP\",\n # \t\t\t\"stopSequence\": \"2\",\n # \t\t\t\"relatedParties\": [{ \n # \t\t\t\t\"partyName\": \"Test\",\n # \t\t\t\t\"partyId\": 12345,\n # \t\t\t\ }], \n # \t\t\t\"contact\": { \n # \t\t\t\t\"name\": \"Contact One\",\n # \t\t\t\t\"contactMethods\": [{ \n # \t\t\t\t\t\"method\": \"Phone\",\n # \t\t\t\t\t\"value\": \"5554678415\"\n # \t\t\t\t\ }] \n # \t\t\t\ } \n # \t\t\ }] \n # \t\ }] \n # }" # - lang: Java # source: "HttpResponse response = Unirest.post(\"https://sandbox-api.navisphere.com/v1/purchaseorders\")\n # .header(\"Content-Type\", \"application/json\")\n # .header(\"Authorization\", \"Bearer YOU TOKEN\")\n # .body(\"{\n # \t\"customerCode\": \"C4106146\",\n # \t\"customerCreatedDate\": \"2019-04-15T20:30:00.0000000Z\",\n # \t\"customerName\": \"Domino's Equipment & Supply\",\n # \t\"customerPONumber\": \"9191\",\n # \t\"customerContact\": {\n # \t\t\"name\": \"Contact One\",\n # \t\t\"contactMethods\": [{\n # \t\t\t\"method\": \"Phone\",\n # \t\t\t\"value\": \"5554678415\"\n # \t\t }] \n # \t\ } \n # \t\"incoLocation\": \"MPLS\",\n # \t\"incoTerms\": \"EXW\",\n # \t\"purchaseOrderItems\": [{\n # \t\t\"customerPoLineNumber\": \"sd156130\",\n # \t\t\"poLineItemValue\": \"2000\",\n # \t\t\"productName\": \"Pizza Table square\",\n # \t\t\"freightTerms\": \"CL\",\n # \t\t\"cpsiaTestRequired\": \"true\",\n # \t\t\"cpsiaTestPassed\": \"true\",\n # \t\t\"innerPackInsuranceValue\": \"1000\",\n # \t\t\"innerPackType\": \"BALE\",\n # \t\t\"innerPackQty\": \"10\",\n # \t\t\"innerPackOriginalQty\": \"5\",\n # \t\t\"innerPackHeight\": \"2\",\n # \t\t\"innerPackLength\": \"5\",\n # \t\t\"innerPackWidth\": \"7\",\n # \t\t\"innerPackUnitOfMeasure\": \"Inches\",\n # \t\t\"innerPackWeight\": \"100\",\n # \t\t\"innerPackWeightUnitOfMeasure\": \"pounds\",\n # \t\t\"outerPackHeight\": \"20\",\n # \t\t\"outerPackLength\": \"10\",\n # \t\t\"outerPackWidth\": \"5\",\n # \t\t\"outerPackWeight\": \"150\",\n # \t\t\"outerPackUnitOfMeasure\": \"Inches\",\n # \t\t\"outerPackWeightUnitOfMeasure\": \"Pounds\",\n # \t\t\"supplier\": {\n # \t\t\t\"supplierName\": \"Advance Tabco\",\n # \t\t\t\"address\": { \n # \t\t\t\t\"address1\": \"6 Industrial Dr\",\n # \t\t\t\t\"city\": \"Dyer\",\n # \t\t\t\t\"stateProvinceCode\": \"TN\",\n # \t\t\t\t\"postalCode\": \"38330\",\n # \t\t\t\t\"country\": \"US\"\n # \t\t\t }, \n # \t\t\t\"contact\": { \n # \t\t\t\t\"name\": \"Contact One\",\n # \t\t\t\t\"contactMethods\": [{ \n # \t\t\t\t\t\"method\": \"Phone\",\n # \t\t\t\t\t\"value\": \"5554678415\"\n # \t\t\t\t\ }] \n # \t\t\t\ } \n # \t\t\ }, \n # \t\t\"outerPackType\": \"PLT\",\n # \t\t\"outerPackStuffingQty\": \"1\",\n # \t\t\"partNumber\": \"part20\",\n # \t\t\"productCode\": \"ery789\",\n # \t\t\"sku\": \"5685-555\",\n # \t\t\"requestedBookingDate\": \"2019-04-20T20:30:00.0000000Z\",\n # \t\t\"requestedPickupDate\": \"2019-04-25T20:30:00.0000000Z\",\n # \t\t\"requestedDeliveryDate\": \"2019-04-30T20:30:00.0000000Z\",\n # \t\t\"locations\": [{ \n # \t\t\t\"name\": \"Domino's Pizza LLC\",\n # \t\t\t\"address\": { \n # \t\t\t\t\"address1\": \"5216 W. MOHAVE\",\n # \t\t\t\t\"city\": \"PHOENIX\",\n # \t\t\t\t\"stateProvinceCode\": \"AZ\",\n # \t\t\t\t\"postalCode\": \"85043\",\n # \t\t\t\t\"country\": \"US\",\n # \t\t\t\ }, \n # \t\t\t\"stopType\": \"PICK\",\n # \t\t\t\"stopSequence\": \"1\",\n # \t\t\t\"relatedParties\": [{ \n # \t\t\t\t\"partyName\": \"Test\",\n # \t\t\t\t\"partyId\": 12345,\n # \t\t\t\ }], \n # \t\t\t\"contact\": { \n # \t\t\t\t\"name\": \"Contact One\",\n # \t\t\t\t\"contactMethods\": [{ \n # \t\t\t\t\t\"method\": \"Phone\",\n # \t\t\t\t\t\"value\": \"5554678415\"\n # \t\t\t\t\ }] \n # \t\t\t\ } \n # \t\t\ }, \n # \t\t\ { \n # \t\t\t\"name\": \"DOMINO'S PIZZA\",\n # \t\t\t\"address\": { \n # \t\t\t\t\"address1\": \"7385 RADIO RD\",\n # \t\t\t\t\"address2\": \"SUITE 102\",\n # \t\t\t\t\"city\": \"Naples\",\n # \t\t\t\t\"stateProvinceCode\": \"FL\",\n # \t\t\t\t\"postalCode\": \"34104\",\n # \t\t\t\t\"country\": \"US\",\n # \t\t\t\ }, \n # \t\t\t\"stopType\": \"DROP\",\n # \t\t\t\"stopSequence\": \"2\",\n # \t\t\t\"relatedParties\": [{ \n # \t\t\t\t\"partyName\": \"Test\",\n # \t\t\t\t\"partyId\": 12345,\n # \t\t\t\ }], \n # \t\t\t\"contact\": { \n # \t\t\t\t\"name\": \"Contact One\",\n # \t\t\t\t\"contactMethods\": [{ \n # \t\t\t\t\t\"method\": \"Phone\",\n # \t\t\t\t\t\"value\": \"5554678415\"\n # \t\t\t\t\ }] \n # \t\t\t\ } \n # \t\t\ }] \n # \t\ }] \n # } \") \n # .asString();" # - lang: NodeJS # source: " # var request = require(\"request\");\n\n # var options = { method: 'POST',\n # url: 'https://sandbox-api.navisphere.com/v1/purchaseorders',\n # headers: { \n # \tAuthorization: 'Bearer YOU TOKEN',\n # \t'Content-Type': 'application/json' \n # } \n # body: { \n # \t\"customerCode\": \"C4106146\",\n # \t\"customerCreatedDate\": \"2019-04-15T20:30:00.0000000Z\",\n # \t\"customerName\": \"Domino's Equipment & Supply\",\n # \t\"customerPONumber\": \"9191\",\n # \t\"customerContact\": {\n # \t\t\"name\": \"Contact One\",\n # \t\t\"contactMethods\": [{\n # \t\t\t\"method\": \"Phone\",\n # \t\t\t\"value\": \"5554678415\"\n # \t\t }] \n # \t\ } \n # \t\"incoLocation\": \"MPLS\",\n # \t\"incoTerms\": \"EXW\",\n # \t\"purchaseOrderItems\": [{\n # \t\t\"customerPoLineNumber\": \"sd156130\",\n # \t\t\"poLineItemValue\": \"2000\",\n # \t\t\"productName\": \"Pizza Table square\",\n # \t\t\"freightTerms\": \"CL\",\n # \t\t\"cpsiaTestRequired\": \"true\",\n # \t\t\"cpsiaTestPassed\": \"true\",\n # \t\t\"innerPackInsuranceValue\": \"1000\",\n # \t\t\"innerPackType\": \"BALE\",\n # \t\t\"innerPackQty\": \"10\",\n # \t\t\"innerPackOriginalQty\": \"5\",\n # \t\t\"innerPackHeight\": \"2\",\n # \t\t\"innerPackLength\": \"5\",\n # \t\t\"innerPackWidth\": \"7\",\n # \t\t\"innerPackUnitOfMeasure\": \"Inches\",\n # \t\t\"innerPackWeight\": \"100\",\n # \t\t\"innerPackWeightUnitOfMeasure\": \"pounds\",\n # \t\t\"outerPackHeight\": \"20\",\n # \t\t\"outerPackLength\": \"10\",\n # \t\t\"outerPackWidth\": \"5\",\n # \t\t\"outerPackWeight\": \"150\",\n # \t\t\"outerPackUnitOfMeasure\": \"Inches\",\n # \t\t\"outerPackWeightUnitOfMeasure\": \"Pounds\",\n # \t\t\"supplier\": {\n # \t\t\t\"supplierName\": \"Advance Tabco\",\n # \t\t\t\"address\": { \n # \t\t\t\t\"address1\": \"6 Industrial Dr\",\n # \t\t\t\t\"city\": \"Dyer\",\n # \t\t\t\t\"stateProvinceCode\": \"TN\",\n # \t\t\t\t\"postalCode\": \"38330\",\n # \t\t\t\t\"country\": \"US\"\n # \t\t\t }, \n # \t\t\t\"contact\": { \n # \t\t\t\t\"name\": \"Contact One\",\n # \t\t\t\t\"contactMethods\": [{ \n # \t\t\t\t\t\"method\": \"Phone\",\n # \t\t\t\t\t\"value\": \"5554678415\"\n # \t\t\t\t\ }] \n # \t\t\t\ } \n # \t\t\ }, \n # \t\t\"outerPackType\": \"PLT\",\n # \t\t\"outerPackStuffingQty\": \"1\",\n # \t\t\"partNumber\": \"part20\",\n # \t\t\"productCode\": \"ery789\",\n # \t\t\"sku\": \"5685-555\",\n # \t\t\"requestedBookingDate\": \"2019-04-20T20:30:00.0000000Z\",\n # \t\t\"requestedPickupDate\": \"2019-04-25T20:30:00.0000000Z\",\n # \t\t\"requestedDeliveryDate\": \"2019-04-30T20:30:00.0000000Z\",\n # \t\t\"locations\": [{ \n # \t\t\t\"name\": \"Domino's Pizza LLC\",\n # \t\t\t\"address\": { \n # \t\t\t\t\"address1\": \"5216 W. MOHAVE\",\n # \t\t\t\t\"city\": \"PHOENIX\",\n # \t\t\t\t\"stateProvinceCode\": \"AZ\",\n # \t\t\t\t\"postalCode\": \"85043\",\n # \t\t\t\t\"country\": \"US\",\n # \t\t\t\ }, \n # \t\t\t\"stopType\": \"PICK\",\n # \t\t\t\"stopSequence\": \"1\",\n # \t\t\t\"relatedParties\": [{ \n # \t\t\t\t\"partyName\": \"Test\",\n # \t\t\t\t\"partyId\": 12345,\n # \t\t\t\ }], \n # \t\t\t\"contact\": { \n # \t\t\t\t\"name\": \"Contact One\",\n # \t\t\t\t\"contactMethods\": [{ \n # \t\t\t\t\t\"method\": \"Phone\",\n # \t\t\t\t\t\"value\": \"5554678415\"\n # \t\t\t\t\ }] \n # \t\t\t\ } \n # \t\t\ }, \n # \t\t\ { \n # \t\t\t\"name\": \"DOMINO'S PIZZA\",\n # \t\t\t\"address\": { \n # \t\t\t\t\"address1\": \"7385 RADIO RD\",\n # \t\t\t\t\"address2\": \"SUITE 102\",\n # \t\t\t\t\"city\": \"Naples\",\n # \t\t\t\t\"stateProvinceCode\": \"FL\",\n # \t\t\t\t\"postalCode\": \"34104\",\n # \t\t\t\t\"country\": \"US\",\n # \t\t\t\ }, \n # \t\t\t\"stopType\": \"DROP\",\n # \t\t\t\"stopSequence\": \"2\",\n # \t\t\t\"relatedParties\": [{ \n # \t\t\t\t\"partyName\": \"Test\",\n # \t\t\t\t\"partyId\": 12345,\n # \t\t\t\ }], \n # \t\t\t\"contact\": { \n # \t\t\t\t\"name\": \"Contact One\",\n # \t\t\t\t\"contactMethods\": [{ \n # \t\t\t\t\t\"method\": \"Phone\",\n # \t\t\t\t\t\"value\": \"5554678415\"\n # \t\t\t\t\ }] \n # \t\t\t\ } \n # \t\t\ }] \n # \t\ }] \n # }};\n\n # request(options, function (error, response, body) {\n # \tif (error) throw new Error(error);\n\n # \tconsole.log(body);\n # });" # - lang: C# # source: " # var client = new RestClient(\"https://sandbox-api.navisphere.com/v1/purchaseorders\");\n # var request = new RestRequest(Method.GET);\n # request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n # request.AddHeader(\"Content-Type\", \"application/json\");\n # request.AddParameter(\"undefined\", \"{\n # \t\"customerCode\": \"C4106146\",\n # \t\"customerCreatedDate\": \"2019-04-15T20:30:00.0000000Z\",\n # \t\"customerName\": \"Domino's Equipment & Supply\",\n # \t\"customerPONumber\": \"9191\",\n # \t\"customerContact\": {\n # \t\t\"name\": \"Contact One\",\n # \t\t\"contactMethods\": [{\n # \t\t\t\"method\": \"Phone\",\n # \t\t\t\"value\": \"5554678415\"\n # \t\t }] \n # \t\ } \n # \t\"incoLocation\": \"MPLS\",\n # \t\"incoTerms\": \"EXW\",\n # \t\"purchaseOrderItems\": [{\n # \t\t\"customerPoLineNumber\": \"sd156130\",\n # \t\t\"poLineItemValue\": \"2000\",\n # \t\t\"productName\": \"Pizza Table square\",\n # \t\t\"freightTerms\": \"CL\",\n # \t\t\"cpsiaTestRequired\": \"true\",\n # \t\t\"cpsiaTestPassed\": \"true\",\n # \t\t\"innerPackInsuranceValue\": \"1000\",\n # \t\t\"innerPackType\": \"BALE\",\n # \t\t\"innerPackQty\": \"10\",\n # \t\t\"innerPackOriginalQty\": \"5\",\n # \t\t\"innerPackHeight\": \"2\",\n # \t\t\"innerPackLength\": \"5\",\n # \t\t\"innerPackWidth\": \"7\",\n # \t\t\"innerPackUnitOfMeasure\": \"Inches\",\n # \t\t\"innerPackWeight\": \"100\",\n # \t\t\"innerPackWeightUnitOfMeasure\": \"pounds\",\n # \t\t\"outerPackHeight\": \"20\",\n # \t\t\"outerPackLength\": \"10\",\n # \t\t\"outerPackWidth\": \"5\",\n # \t\t\"outerPackWeight\": \"150\",\n # \t\t\"outerPackUnitOfMeasure\": \"Inches\",\n # \t\t\"outerPackWeightUnitOfMeasure\": \"Pounds\",\n # \t\t\"supplier\": {\n # \t\t\t\"supplierName\": \"Advance Tabco\",\n # \t\t\t\"address\": { \n # \t\t\t\t\"address1\": \"6 Industrial Dr\",\n # \t\t\t\t\"city\": \"Dyer\",\n # \t\t\t\t\"stateProvinceCode\": \"TN\",\n # \t\t\t\t\"postalCode\": \"38330\",\n # \t\t\t\t\"country\": \"US\"\n # \t\t\t }, \n # \t\t\t\"contact\": { \n # \t\t\t\t\"name\": \"Contact One\",\n # \t\t\t\t\"contactMethods\": [{ \n # \t\t\t\t\t\"method\": \"Phone\",\n # \t\t\t\t\t\"value\": \"5554678415\"\n # \t\t\t\t\ }] \n # \t\t\t\ } \n # \t\t\ }, \n # \t\t\"outerPackType\": \"PLT\",\n # \t\t\"outerPackStuffingQty\": \"1\",\n # \t\t\"partNumber\": \"part20\",\n # \t\t\"productCode\": \"ery789\",\n # \t\t\"sku\": \"5685-555\",\n # \t\t\"requestedBookingDate\": \"2019-04-20T20:30:00.0000000Z\",\n # \t\t\"requestedPickupDate\": \"2019-04-25T20:30:00.0000000Z\",\n # \t\t\"requestedDeliveryDate\": \"2019-04-30T20:30:00.0000000Z\",\n # \t\t\"locations\": [{ \n # \t\t\t\"name\": \"Domino's Pizza LLC\",\n # \t\t\t\"address\": { \n # \t\t\t\t\"address1\": \"5216 W. MOHAVE\",\n # \t\t\t\t\"city\": \"PHOENIX\",\n # \t\t\t\t\"stateProvinceCode\": \"AZ\",\n # \t\t\t\t\"postalCode\": \"85043\",\n # \t\t\t\t\"country\": \"US\",\n # \t\t\t\ }, \n # \t\t\t\"stopType\": \"PICK\",\n # \t\t\t\"stopSequence\": \"1\",\n # \t\t\t\"relatedParties\": [{ \n # \t\t\t\t\"partyName\": \"Test\",\n # \t\t\t\t\"partyId\": 12345,\n # \t\t\t\ }], \n # \t\t\t\"contact\": { \n # \t\t\t\t\"name\": \"Contact One\",\n # \t\t\t\t\"contactMethods\": [{ \n # \t\t\t\t\t\"method\": \"Phone\",\n # \t\t\t\t\t\"value\": \"5554678415\"\n # \t\t\t\t\ }] \n # \t\t\t\ } \n # \t\t\ }, \n # \t\t\ { \n # \t\t\t\"name\": \"DOMINO'S PIZZA\",\n # \t\t\t\"address\": { \n # \t\t\t\t\"address1\": \"7385 RADIO RD\",\n # \t\t\t\t\"address2\": \"SUITE 102\",\n # \t\t\t\t\"city\": \"Naples\",\n # \t\t\t\t\"stateProvinceCode\": \"FL\",\n # \t\t\t\t\"postalCode\": \"34104\",\n # \t\t\t\t\"country\": \"US\",\n # \t\t\t\ }, \n # \t\t\t\"stopType\": \"DROP\",\n # \t\t\t\"stopSequence\": \"2\",\n # \t\t\t\"relatedParties\": [{ \n # \t\t\t\t\"partyName\": \"Test\",\n # \t\t\t\t\"partyId\": 12345,\n # \t\t\t\ }], \n # \t\t\t\"contact\": { \n # \t\t\t\t\"name\": \"Contact One\",\n # \t\t\t\t\"contactMethods\": [{ \n # \t\t\t\t\t\"method\": \"Phone\",\n # \t\t\t\t\t\"value\": \"5554678415\"\n # \t\t\t\t\ }] \n # \t\t\t\ } \n # \t\t\ }] \n # \t\ }] \n # }\"); \n # IRestResponse response = client.Execute(request);" # responses: # 201: # description: Request successful # 400: # description: Bad Request # content: # application/json: # schema: # $ref: '#/components/schemas/error400' # example: # - message: '"referenceNumber" is not allowed' # path: # - referenceNumber # type: object.allowUnknown # context: # child: referenceNumber # value: # - type: MBOL # value: MBOL12345 # key: referenceNumber # label: referenceNumber # 401: # description: Unauthorized # content: # application/json: # schema: # type: array # items: # $ref: '#/components/schemas/error401' # 403: # description: Forbidden # content: # application/json: # schema: # $ref: '#/components/schemas/error403' # 404: # description: Not Found # content: # application/json: # schema: # $ref: '#/components/schemas/error404' # 500: # description: Internal Server Error. Please contact your C.H. Robinson Rep. #---Visibility------------------------------------------------------------------------------------------- /v2/visibility/shipments: post: description: Post a shipment create into Navisphere® Vision and/or Navisphere® Analytics. x-beta: true operationId: Visibility Shipment Create tags: - Visibility requestBody: description: JSON object of shipment information. required: true content: application/json: schema: $ref: '#/components/schemas/shipments' example: shipmentNumber: '12345' tenantId: 'tenantid' trackingNumber: 1ZT33888AY accountCode: ACT12345 scac: ACL customerName: Your Customer Name carrierName: Gray Transportation, Inc. carrierProNumber: '0043275' trailerNumber: '3631' equipmentType: Van mode: LTL containerInformation: - containerNumber: '123456789' containerType: '45HR' containerWeight: '1000' weightUnitOfMeasure: 'Kilograms' shipmentDistance: "900" shipmentDistanceUnitOfMeasure: miles isPremiumFreight: false isManaged: true movementType: 'car' incoTerms: 'DAT' teuCount: '3432' orderNumbers: - test101 stops: - actualArriveDateTime: '2019-02-25T11:47:00.000Z' actualDepartDateTime: '2019-02-25T13:38:00.000Z' orderNumbers: - test101 locations: - locationId: W541849 sequenceNumber: '1' stopRole: pick name: Location One address1: 123 Street address2: 123 Street city: Blaine stateProvinceCode: MN postalCode: '55428' countryCode: US requested: '2018-12-11T01:14:00-08:00' openDateTime: '2019-02-20T12:00:00.000Z' closeDateTime: '2019-02-22T22:30:00.000Z' iata: 'ALO' referenceNumbers: - type: AAR value: 1A23ZZ32599ABC handlingUnits: - handlingUnitId: CO_1480525_1 packagingType: pallet quantity: 1 freightClass: '70' weight: 1996 weightUnitOfMeasure: pounds packagingLength: '10' packagingUnitOfMeasure: 'feet' volume: '5' volumeUnitOfMeasure: 'CubicFeet' containerNumber: '343534534' description: 'notes' orderNumbers: - test101 commodities: - commodityId: CO_1480525_1_1 orderNumber: '32432' name: "widgets" units: 1 sku: 'e87r99' plannerCode: '1234' value: 50 currencyCode: 'USD' serialNumber: 'sad23432' partNumber: 'ds536' isHazMat: true pickLocSequenceNumber: 0 dropLocSequenceNumber: 1 category: 'tractor' description: TRACTOR DESCRIPTION packagingVolume: 17.5 packagingVolumeUnitOfMeasure: cubicFeet costCenterCode: 'GLXX' packagingType: 'boxes' weight: 0 weightUnitOfMeasure: 'pounds' packagingLength: 0 packagingWidth: 0 packagingHeight: 0 packagingUnitOfMeasure: 'feet' packageQuantity: '10' purchaseOrderNumber: '123abc' referenceNumbers: - type: AAR value: 1A23ZZ32599ABC x-code-samples: - lang: Curl source: "curl -X POST \\ \n https://sandbox-api.navisphere.com/v2/visibility/shipments \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json' \\ \n -d '{ \n \t\"shipmentNumber\": \"12345\",\n \t\"tenantId\": \"tenantid\", \n \t\"trackingNumber\": \"1ZT33888AY\", \n \t\"accountCode\": \"ACT12345\", \n \t\"scac\": \"ACL\", \n \t\"customerName\": \"Your Customer Name\", \n \t\"carrierName\": \"Gray Transportation, Inc.\", \n \t\"carrierProNumber\": \"0043275\", \n \t\"trailerNumber\": \"3631\", \n \t\"equipmentType\": \"Van\", \n \t\"mode\": \"LTL\", \n \t\"containerInformation\": [{ \n \t\t\"containerNumber\": \"123456789\",\n \t\t\"containerType\": \"45HR\",\n \t\t\"containerWeight\": \"1000\",\n \t\t\"weightUnitOfMeasure\": \"Kilograms\"\n \t\t}],\n \t\"shipmentDistance\": \"900\", \n \t\"shipmentDistanceUnitOfMeasure\": \"miles\", \n \t\"isPremiumFreight\": false, \n \t\"isManaged\": true, \n \t\"movementType\": \"car\", \n \t\"incoTerms\": \"DAT\", \n \t\"teuCount\": \"3432\", \n \t\"orderNumbers\": [ \n \t\t\"test101\"\n \t\t],\n \t\"stops\": [{ \n \t\t\"actualArriveDateTime\": \"2019-02-25T11:47:00.000Z\",\n \t\t\"actualDepartDateTime\": \"2019-02-25T13:38:00.000Z\",\n \t\t\"orderNumbers\": [ \n \t\t\t\"test101\"\n \t\t\t],\n \t\t\"locations\": [{ \n \t\t\t\"locationId\": \"W541849\", \n \t\t\t\"sequenceNumber\": \"1\", \n \t\t\t\"stopRole\": \"pick\", \n \t\t\t\"name\": \"Location One\", \n \t\t\t\"address1\": \"123 Street\", \n \t\t\t\"address2\": \"123 Street\", \n \t\t\t\"city\": \"Blaine\", \n \t\t\t\"stateProvinceCode\": \"MN\", \n \t\t\t\"postalCode\": \"55428\", \n \t\t\t\"countryCode\": \"US\", \n \t\t\t\"requested\": \"2018-12-11T01:14:00-08:00\", \n \t\t\t\"openDateTime\": \"2019-02-20T12:00:00.000Z\", \n \t\t\t\"closeDateTime\": \"2019-02-22T22:30:00.000Z\", \n \t\t\t\"iata\": \"ALO\", \n \t\t\t\"referenceNumbers\": [{ \n \t\t\t\t\"type\": \"AAR\", \n \t\t\t\t\"value\": \"1A23ZZ32599ABC\" \n \t\t\t}]\n \t\t}]\n \t}],\n \t\"handlingUnits\": [{ \n \t\t\"handlingUnitId\": \"CO_1480525_1\", \n \t\t\"packagingType\": \"pallet\", \n \t\t\"quantity\": 1, \n \t\t\"freightClass\": \"70\", \n \t\t\"weight\": 1996, \n \t\t\"weightUnitOfMeasure\": \"pounds\", \n \t\t\"packagingLength\": \"10\", \n \t\t\"packagingUnitOfMeasure\": \"feet\", \n \t\t\"volume\": \"5\", \n \t\t\"volumeUnitOfMeasure\": \"CubicFeet\", \n \t\t\"containerNumber\": \"343534534\", \n \t\t\"description\": \"notes\", \n \t\t\"orderNumbers\": [ \n \t\t\t\"test101\"\n \t\t],\n \t\t\"commodities\": [{ \n \t\t\t\"commodityId\": \"CO_1480525_1_1\", \n \t\t\t\"orderNumber\": \"32432\", \n \t\t\t\"name\": \"widgets\", \n \t\t\t\"units\": 1, \n \t\t\t\"sku\": \"e87r99\", \n \t\t\t\"plannerCode\": \"1234\", \n \t\t\t\"value\": 50, \n \t\t\t\"currencyCode\": \"USD\", \n \t\t\t\"serialNumber\": \"sad23432\", \n \t\t\t\"partNumber\": \"ds536\", \n \t\t\t\"isHazMat\": true, \n \t\t\t\"pickLocSequenceNumber\": 0, \n \t\t\t\"dropLocSequenceNumber\": 1, \n \t\t\t\"category\": \"tractor\", \n \t\t\t\"description\": \"TRACTOR DESCRIPTION\", \n \t\t\t\"packagingVolume\": 17.5, \n \t\t\t\"packagingVolumeUnitOfMeasure\": \"cubicFeet\", \n \t\t\t\"costCenterCode\": \"GLXX\", \n \t\t\t\"packagingType\": \"boxes\", \n \t\t\t\"weight\": 0, \n \t\t\t\"weightUnitOfMeasure\": \"pounds\", \n \t\t\t\"packagingLength\": 0, \n \t\t\t\"packagingWidth\": 0, \n \t\t\t\"packagingHeight\": 0, \n \t\t\t\"packagingUnitOfMeasure\": \"feet\", \n \t\t\t\"packageQuantity\": \"10\", \n \t\t\t\"purchaseOrderNumber\": \"123abc\", \n \t\t\t\"referenceNumbers\": [{ \n \t\t\t\t\"type\": \"AAR\", \n \t\t\t\t\"value\": \"1A23ZZ32599ABC\" \n \t\t\t}]\n \t\t}]\n \t}]\n }'" - lang: Java source: "HttpResponse response = Unirest.post(\"https://sandbox-api.navisphere.com/v2/visibility/shipments\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .body(\" { \n \t\"shipmentNumber\": \"12345\",\n \t\"tenantId\": \"tenantid\", \n \t\"trackingNumber\": \"1ZT33888AY\", \n \t\"accountCode\": \"ACT12345\", \n \t\"scac\": \"ACL\", \n \t\"customerName\": \"Your Customer Name\", \n \t\"carrierName\": \"Gray Transportation, Inc.\", \n \t\"carrierProNumber\": \"0043275\", \n \t\"trailerNumber\": \"3631\", \n \t\"equipmentType\": \"Van\", \n \t\"mode\": \"LTL\", \n \t\"containerInformation\": [{ \n \t\t\"containerNumber\": \"123456789\",\n \t\t\"containerType\": \"45HR\",\n \t\t\"containerWeight\": \"1000\",\n \t\t\"weightUnitOfMeasure\": \"Kilograms\"\n \t\t}],\n \t\"shipmentDistance\": \"900\", \n \t\"shipmentDistanceUnitOfMeasure\": \"miles\", \n \t\"isPremiumFreight\": false, \n \t\"isManaged\": true, \n \t\"movementType\": \"car\", \n \t\"incoTerms\": \"DAT\", \n \t\"teuCount\": \"3432\", \n \t\"orderNumbers\": [ \n \t\t\"test101\"\n \t\t],\n \t\"stops\": [{ \n \t\t\"actualArriveDateTime\": \"2019-02-25T11:47:00.000Z\",\n \t\t\"actualDepartDateTime\": \"2019-02-25T13:38:00.000Z\",\n \t\t\"orderNumbers\": [ \n \t\t\t\"test101\"\n \t\t\t],\n \t\t\"locations\": [{ \n \t\t\t\"locationId\": \"W541849\", \n \t\t\t\"sequenceNumber\": \"1\", \n \t\t\t\"stopRole\": \"pick\", \n \t\t\t\"name\": \"Location One\", \n \t\t\t\"address1\": \"123 Street\", \n \t\t\t\"address2\": \"123 Street\", \n \t\t\t\"city\": \"Blaine\", \n \t\t\t\"stateProvinceCode\": \"MN\", \n \t\t\t\"postalCode\": \"55428\", \n \t\t\t\"countryCode\": \"US\", \n \t\t\t\"requested\": \"2018-12-11T01:14:00-08:00\", \n \t\t\t\"openDateTime\": \"2019-02-20T12:00:00.000Z\", \n \t\t\t\"closeDateTime\": \"2019-02-22T22:30:00.000Z\", \n \t\t\t\"iata\": \"ALO\", \n \t\t\t\"referenceNumbers\": [{ \n \t\t\t\t\"type\": \"AAR\", \n \t\t\t\t\"value\": \"1A23ZZ32599ABC\" \n \t\t\t}]\n \t\t}]\n \t}],\n \t\"handlingUnits\": [{ \n \t\t\"handlingUnitId\": \"CO_1480525_1\", \n \t\t\"packagingType\": \"pallet\", \n \t\t\"quantity\": 1, \n \t\t\"freightClass\": \"70\", \n \t\t\"weight\": 1996, \n \t\t\"weightUnitOfMeasure\": \"pounds\", \n \t\t\"packagingLength\": \"10\", \n \t\t\"packagingUnitOfMeasure\": \"feet\", \n \t\t\"volume\": \"5\", \n \t\t\"volumeUnitOfMeasure\": \"CubicFeet\", \n \t\t\"containerNumber\": \"343534534\", \n \t\t\"description\": \"notes\", \n \t\t\"orderNumbers\": [ \n \t\t\t\"test101\"\n \t\t],\n \t\t\"commodities\": [{ \n \t\t\t\"commodityId\": \"CO_1480525_1_1\", \n \t\t\t\"orderNumber\": \"32432\", \n \t\t\t\"name\": \"widgets\", \n \t\t\t\"units\": 1, \n \t\t\t\"sku\": \"e87r99\", \n \t\t\t\"plannerCode\": \"1234\", \n \t\t\t\"value\": 50, \n \t\t\t\"currencyCode\": \"USD\", \n \t\t\t\"serialNumber\": \"sad23432\", \n \t\t\t\"partNumber\": \"ds536\", \n \t\t\t\"isHazMat\": true, \n \t\t\t\"pickLocSequenceNumber\": 0, \n \t\t\t\"dropLocSequenceNumber\": 1, \n \t\t\t\"category\": \"tractor\", \n \t\t\t\"description\": \"TRACTOR DESCRIPTION\", \n \t\t\t\"packagingVolume\": 17.5, \n \t\t\t\"packagingVolumeUnitOfMeasure\": \"cubicFeet\", \n \t\t\t\"costCenterCode\": \"GLXX\", \n \t\t\t\"packagingType\": \"boxes\", \n \t\t\t\"weight\": 0, \n \t\t\t\"weightUnitOfMeasure\": \"pounds\", \n \t\t\t\"packagingLength\": 0, \n \t\t\t\"packagingWidth\": 0, \n \t\t\t\"packagingHeight\": 0, \n \t\t\t\"packagingUnitOfMeasure\": \"feet\", \n \t\t\t\"packageQuantity\": \"10\", \n \t\t\t\"purchaseOrderNumber\": \"123abc\", \n \t\t\t\"referenceNumbers\": [{ \n \t\t\t\t\"type\": \"AAR\", \n \t\t\t\t\"value\": \"1A23ZZ32599ABC\" \n \t\t\t}]\n \t\t}]\n \t}]\n }\") .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'POST',\n \turl: 'https://sandbox-api.navisphere.com/v2/visibility/shipments',\n \theaders: \n \t{ Authorization: 'Bearer YOU TOKEN', \n \t'Content-Type': 'application/json' } }; \n \n \tbody: { \n \t\"shipmentNumber\": \"12345\",\n \t\"tenantId\": \"tenantid\", \n \t\"trackingNumber\": \"1ZT33888AY\", \n \t\"accountCode\": \"ACT12345\", \n \t\"scac\": \"ACL\", \n \t\"customerName\": \"Your Customer Name\", \n \t\"carrierName\": \"Gray Transportation, Inc.\", \n \t\"carrierProNumber\": \"0043275\", \n \t\"trailerNumber\": \"3631\", \n \t\"equipmentType\": \"Van\", \n \t\"mode\": \"LTL\", \n \t\"containerInformation\": [{ \n \t\t\"containerNumber\": \"123456789\",\n \t\t\"containerType\": \"45HR\",\n \t\t\"containerWeight\": \"1000\",\n \t\t\"weightUnitOfMeasure\": \"Kilograms\"\n \t\t}],\n \t\"shipmentDistance\": \"900\", \n \t\"shipmentDistanceUnitOfMeasure\": \"miles\", \n \t\"isPremiumFreight\": false, \n \t\"isManaged\": true, \n \t\"movementType\": \"car\", \n \t\"incoTerms\": \"DAT\", \n \t\"teuCount\": \"3432\", \n \t\"orderNumbers\": [ \n \t\t\"test101\"\n \t\t],\n \t\"stops\": [{ \n \t\t\"actualArriveDateTime\": \"2019-02-25T11:47:00.000Z\",\n \t\t\"actualDepartDateTime\": \"2019-02-25T13:38:00.000Z\",\n \t\t\"orderNumbers\": [ \n \t\t\t\"test101\"\n \t\t\t],\n \t\t\"locations\": [{ \n \t\t\t\"locationId\": \"W541849\", \n \t\t\t\"sequenceNumber\": \"1\", \n \t\t\t\"stopRole\": \"pick\", \n \t\t\t\"name\": \"Location One\", \n \t\t\t\"address1\": \"123 Street\", \n \t\t\t\"address2\": \"123 Street\", \n \t\t\t\"city\": \"Blaine\", \n \t\t\t\"stateProvinceCode\": \"MN\", \n \t\t\t\"postalCode\": \"55428\", \n \t\t\t\"countryCode\": \"US\", \n \t\t\t\"requested\": \"2018-12-11T01:14:00-08:00\", \n \t\t\t\"openDateTime\": \"2019-02-20T12:00:00.000Z\", \n \t\t\t\"closeDateTime\": \"2019-02-22T22:30:00.000Z\", \n \t\t\t\"iata\": \"ALO\", \n \t\t\t\"referenceNumbers\": [{ \n \t\t\t\t\"type\": \"AAR\", \n \t\t\t\t\"value\": \"1A23ZZ32599ABC\" \n \t\t\t}]\n \t\t}]\n \t}],\n \t\"handlingUnits\": [{ \n \t\t\"handlingUnitId\": \"CO_1480525_1\", \n \t\t\"packagingType\": \"pallet\", \n \t\t\"quantity\": 1, \n \t\t\"freightClass\": \"70\", \n \t\t\"weight\": 1996, \n \t\t\"weightUnitOfMeasure\": \"pounds\", \n \t\t\"packagingLength\": \"10\", \n \t\t\"packagingUnitOfMeasure\": \"feet\", \n \t\t\"volume\": \"5\", \n \t\t\"volumeUnitOfMeasure\": \"CubicFeet\", \n \t\t\"containerNumber\": \"343534534\", \n \t\t\"description\": \"notes\", \n \t\t\"orderNumbers\": [ \n \t\t\t\"test101\"\n \t\t],\n \t\t\"commodities\": [{ \n \t\t\t\"commodityId\": \"CO_1480525_1_1\", \n \t\t\t\"orderNumber\": \"32432\", \n \t\t\t\"name\": \"widgets\", \n \t\t\t\"units\": 1, \n \t\t\t\"sku\": \"e87r99\", \n \t\t\t\"plannerCode\": \"1234\", \n \t\t\t\"value\": 50, \n \t\t\t\"currencyCode\": \"USD\", \n \t\t\t\"serialNumber\": \"sad23432\", \n \t\t\t\"partNumber\": \"ds536\", \n \t\t\t\"isHazMat\": true, \n \t\t\t\"pickLocSequenceNumber\": 0, \n \t\t\t\"dropLocSequenceNumber\": 1, \n \t\t\t\"category\": \"tractor\", \n \t\t\t\"description\": \"TRACTOR DESCRIPTION\", \n \t\t\t\"packagingVolume\": 17.5, \n \t\t\t\"packagingVolumeUnitOfMeasure\": \"cubicFeet\", \n \t\t\t\"costCenterCode\": \"GLXX\", \n \t\t\t\"packagingType\": \"boxes\", \n \t\t\t\"weight\": 0, \n \t\t\t\"weightUnitOfMeasure\": \"pounds\", \n \t\t\t\"packagingLength\": 0, \n \t\t\t\"packagingWidth\": 0, \n \t\t\t\"packagingHeight\": 0, \n \t\t\t\"packagingUnitOfMeasure\": \"feet\", \n \t\t\t\"packageQuantity\": \"10\", \n \t\t\t\"purchaseOrderNumber\": \"123abc\", \n \t\t\t\"referenceNumbers\": [{ \n \t\t\t\t\"type\": \"AAR\", \n \t\t\t\t\"value\": \"1A23ZZ32599ABC\" \n \t\t\t}]\n \t\t}]\n \t}],\n \tjson: true };\n\n request(options, function (error, response, body) { \n \tif (error) throw new Error(error); \n \n \tconsole.log(body); \n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v2/visibility/shipments\");\n var request = new RestRequest(Method.POST);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n request.AddParameter(\"undefined\", \" { \n \t\"shipmentNumber\": \"12345\",\n \t\"tenantId\": \"tenantid\", \n \t\"trackingNumber\": \"1ZT33888AY\", \n \t\"accountCode\": \"ACT12345\", \n \t\"scac\": \"ACL\", \n \t\"customerName\": \"Your Customer Name\", \n \t\"carrierName\": \"Gray Transportation, Inc.\", \n \t\"carrierProNumber\": \"0043275\", \n \t\"trailerNumber\": \"3631\", \n \t\"equipmentType\": \"Van\", \n \t\"mode\": \"LTL\", \n \t\"containerInformation\": [{ \n \t\t\"containerNumber\": \"123456789\",\n \t\t\"containerType\": \"45HR\",\n \t\t\"containerWeight\": \"1000\",\n \t\t\"weightUnitOfMeasure\": \"Kilograms\"\n \t\t}],\n \t\"shipmentDistance\": \"900\", \n \t\"shipmentDistanceUnitOfMeasure\": \"miles\", \n \t\"isPremiumFreight\": false, \n \t\"isManaged\": true, \n \t\"movementType\": \"car\", \n \t\"incoTerms\": \"DAT\", \n \t\"teuCount\": \"3432\", \n \t\"orderNumbers\": [ \n \t\t\"test101\"\n \t\t],\n \t\"stops\": [{ \n \t\t\"actualArriveDateTime\": \"2019-02-25T11:47:00.000Z\",\n \t\t\"actualDepartDateTime\": \"2019-02-25T13:38:00.000Z\",\n \t\t\"orderNumbers\": [ \n \t\t\t\"test101\"\n \t\t\t],\n \t\t\"locations\": [{ \n \t\t\t\"locationId\": \"W541849\", \n \t\t\t\"sequenceNumber\": \"1\", \n \t\t\t\"stopRole\": \"pick\", \n \t\t\t\"name\": \"Location One\", \n \t\t\t\"address1\": \"123 Street\", \n \t\t\t\"address2\": \"123 Street\", \n \t\t\t\"city\": \"Blaine\", \n \t\t\t\"stateProvinceCode\": \"MN\", \n \t\t\t\"postalCode\": \"55428\", \n \t\t\t\"countryCode\": \"US\", \n \t\t\t\"requested\": \"2018-12-11T01:14:00-08:00\", \n \t\t\t\"openDateTime\": \"2019-02-20T12:00:00.000Z\", \n \t\t\t\"closeDateTime\": \"2019-02-22T22:30:00.000Z\", \n \t\t\t\"iata\": \"ALO\", \n \t\t\t\"referenceNumbers\": [{ \n \t\t\t\t\"type\": \"AAR\", \n \t\t\t\t\"value\": \"1A23ZZ32599ABC\" \n \t\t\t}]\n \t\t}]\n \t}],\n \t\"handlingUnits\": [{ \n \t\t\"handlingUnitId\": \"CO_1480525_1\", \n \t\t\"packagingType\": \"pallet\", \n \t\t\"quantity\": 1, \n \t\t\"freightClass\": \"70\", \n \t\t\"weight\": 1996, \n \t\t\"weightUnitOfMeasure\": \"pounds\", \n \t\t\"packagingLength\": \"10\", \n \t\t\"packagingUnitOfMeasure\": \"feet\", \n \t\t\"volume\": \"5\", \n \t\t\"volumeUnitOfMeasure\": \"CubicFeet\", \n \t\t\"containerNumber\": \"343534534\", \n \t\t\"description\": \"notes\", \n \t\t\"orderNumbers\": [ \n \t\t\t\"test101\"\n \t\t],\n \t\t\"commodities\": [{ \n \t\t\t\"commodityId\": \"CO_1480525_1_1\", \n \t\t\t\"orderNumber\": \"32432\", \n \t\t\t\"name\": \"widgets\", \n \t\t\t\"units\": 1, \n \t\t\t\"sku\": \"e87r99\", \n \t\t\t\"plannerCode\": \"1234\", \n \t\t\t\"value\": 50, \n \t\t\t\"currencyCode\": \"USD\", \n \t\t\t\"serialNumber\": \"sad23432\", \n \t\t\t\"partNumber\": \"ds536\", \n \t\t\t\"isHazMat\": true, \n \t\t\t\"pickLocSequenceNumber\": 0, \n \t\t\t\"dropLocSequenceNumber\": 1, \n \t\t\t\"category\": \"tractor\", \n \t\t\t\"description\": \"TRACTOR DESCRIPTION\", \n \t\t\t\"packagingVolume\": 17.5, \n \t\t\t\"packagingVolumeUnitOfMeasure\": \"cubicFeet\", \n \t\t\t\"costCenterCode\": \"GLXX\", \n \t\t\t\"packagingType\": \"boxes\", \n \t\t\t\"weight\": 0, \n \t\t\t\"weightUnitOfMeasure\": \"pounds\", \n \t\t\t\"packagingLength\": 0, \n \t\t\t\"packagingWidth\": 0, \n \t\t\t\"packagingHeight\": 0, \n \t\t\t\"packagingUnitOfMeasure\": \"feet\", \n \t\t\t\"packageQuantity\": \"10\", \n \t\t\t\"purchaseOrderNumber\": \"123abc\", \n \t\t\t\"referenceNumbers\": [{ \n \t\t\t\t\"type\": \"AAR\", \n \t\t\t\t\"value\": \"1A23ZZ32599ABC\" \n \t\t\t}]\n \t\t}]\n \t}]}\n \", ParameterType.RequestBody);\n IRestResponse response = client.Execute(request);" responses: '201': description: Request successful '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' example: - message: '"referenceNumber" is not allowed' path: - services - 0 - locations - 0 - referenceNumber type: object.allowUnknown context: child: referenceNumber value: - type: PU value: SIMPPU67890 key: referenceNumber label: referenceNumber '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. get: description: "Allows partner to retrieve shipments." operationId: Visibility GET Shipments tags: - Visibility parameters: - in: query name: to required: false schema: type: string format: date-time description: Ending date/time of shipment search. example: "2023-04-20T20:30:00.0000000Z" - in: query name: from required: true schema: type: string format: date-time description: Starting date/time of shipment search. example: "2023-04-23T20:30:00.0000000Z" - in: query name: skip required: false schema: type: integer default: 0 description: Identify how many results the call will skip. example: 10 - in: query name: take required: false schema: type: integer minimum: 0 maximum: 100 default: 100 description: Identify how many results the call will retrieve. example: 100 - in: query name: shipmentNumber required: false schema: type: string minimum: 1 maximum: 20 description: Shipment Number associated to the shipment. example: "SN 1" - in: query name: trackingNumber required: false schema: type: string minimum: 1 maximum: 150 description: Tracking Number associated to the shipment. example: "Tracking 1" - in: query name: identifiers required: false schema: type: array items: description: identifier type: string description: Identifiers associated to the shipment. x-code-samples: - lang: Curl source: "curl -X GET \\ \n 'https://sandbox-api.navisphere.com/v2/visibility/shipments?shipmentNumber=20015434520&from=2023-05-01T00:00:00.000Z' \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json'" - lang: Java source: "HttpResponse response = Unirest.get(\"https://sandbox-api.navisphere.com/v2/visibility/shipments?shipmentNumber=20015434520&from=2023-05-01T00:00:00.000Z\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .asString();" - lang: NodeJS source: " var request = require(\"request\");\n\n var options = { method: 'GET',\n url: 'https://sandbox-api.navisphere.com/v2/visibility/shipments',\n qs: { shipmentNumber: '20015434520', from: '2023-05-01T00:00:00.000Z' },\n headers: { \n \tAuthorization: 'Bearer YOU TOKEN',\n \t'Content-Type': 'application/json' \n }};\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v2/visibility/shipments?shipmentNumber=20015434520&from=2023-05-01T00:00:00.000Z\");\n var request = new RestRequest(Method.GET);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n IRestResponse response = client.Execute(request);" responses: '200': description: Visibility GET Shipments Route content: application/json: example: shipmentNumber: "12345" tenantId: "tenantid" trackingNumber: "1ZT33888AY" accountCode: "ACT12345" scac: "ACL" customerName: "Your Customer Name" carrierName: "Gray Transportation, Inc." carrierProNumber: "0043275" trailerNumber: "3631" equipmentType: "Van" mode: "LTL" containerInformation: containerNumber: "123456789" containerType: "45HR" containerWeight: "1000" weightUnitOfMeasure: "Kilograms" shipmentDistance: "900" shipmentDistanceUnitOfMeasure: "miles" isPremiumFreight: false isManaged: true movementType: "car" incoTerms: "DAT" teuCount: "3432" trackingNumberHash: "eyJyZXF1ZXN0Ijp7InZpc2lvbl90cmFja2luZ19udW1iZXIiOiJaWllZWFhXV1ZWVVVUVFNTUlJRUVBQT09OTk1NIiwidGVuYW50X2lkIjo5ODc2LCJzaWduaW5nX3VuaXhfZGF0ZXRpbWVfc3RhbXAiOiIxNjExMDg4MDUyMzQ0In0sImhhc2hfc2lnbmF0dXJlIjoiL3V1U0M1UzlEUGkrRmwweEIyTFk4MU02azRURzlxa05KMFpkbUxOdmFBMD0ifQ" orderNumbers: "test101" stops: actualArriveDateTime: "2019-02-25T11:47:00.000Z" actualDepartDateTime: "2019-02-25T13:38:00.000Z" orderNumbers: "test101" locations: locationId: "W541849" sequenceNumber: "1" stopRole: "pick" name: "Location One" address1: "123 Street" address2: "123 Street" city: "Blaine" stateProvinceCode: "MN" postalCode: "55428" countryCode: "US" requested: "2018-12-11T01:14:00-08:00" openDateTime: "2019-02-20T12:00:00.000Z" closeDateTime: "2019-02-22T22:30:00.000Z" iata": "ALO" referenceNumbers: type": "AAR" value": "1A23ZZ32599ABC" handlingUnits: dropLocSequenceNumber: 0 pickLocSequenceNumber: 1 handlingUnitId: "CO_1480525_1" packagingType: "pallet" packagingLength: "10" packagingUnitOfMeasure: "feet" packagingWidth: 0 packagingHeight: 0 quantity: 1 freightClass: "70" weight: 1996 weightUnitOfMeasure: "pounds" volume: "5" volumeUnitOfMeasure: "CubicFeet" containerNumber: "343534534" description: "notes" orderNumbers: "test101" commodities: commodityId: "CO_1480525_1_1" orderNumber: "32432" name: "widgets" units: 1 sku: "e87r99" plannerCode: "1234" value: 50 serialNumber: "sad23432" partNumber: "ds536" isHazMat: true pickLocSequenceNumber: 0 dropLocSequenceNumber: 1 category: "tractor" description: "TRACTOR DESCRIPTION" packagingVolume: 17.5 packagingVolumeUnitOfMeasure: "cubicFeet" costCenterCode: "GLXX" packagingType: "boxes" weight: 0 weightUnitOfMeasure: "pounds" packagingLength: 0 packagingWidth: 0 packagingHeight: 0 packagingUnitOfMeasure: "feet" packageQuantity: "10" purchaseOrderNumber: "123abc" referenceNumbers: type: "AAR" value: "1A23ZZ32599ABC" '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact you C.H. Robinson Rep. /v2/visibility/shipments/{shipmentNumber}: delete: description: Allows partner to delete an existing shipment in Navisphere® Vision and/or Navisphere® Analytics. operationId: Visibility Shipment Delete tags: - Visibility parameters: - name: shipmentNumber in: path description: The shipment number required: true schema: type: string x-code-samples: - lang: Curl source: "curl -X DELETE \\ \n https://sandbox-api.navisphere.com/v2/visibility/shipments/123456 \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json'" - lang: Java source: "HttpResponse response = Unirest.delete(\"https://sandbox-api.navisphere.com/v2/visibility/shipments/123456\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'DELETE',\n \turl: 'https://sandbox-api.navisphere.com/v2/visibility/shipments/123456',\n \theaders: \n \t{ Authorization: 'Bearer YOU TOKEN', \n \t'Content-Type': 'application/json' } }; \n \n request(options, function (error, response, body) { \n \tif (error) throw new Error(error); \n \n \tconsole.log(body); \n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v2/visibility/shipments/123456\");\n var request = new RestRequest(Method.DELETE);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n IRestResponse response = client.Execute(request);" responses: '200': description: Request successful '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v2/visibility/invoices: post: description: Post a shipment invoice into Navisphere® Vision and/or Navisphere® Analytics. x-beta: true operationId: Visibility Invoice Create tags: - Visibility requestBody: description: JSON object of shipment information. required: true content: application/json: schema: $ref: '#/components/schemas/invoice' example: customerName: Your Customer Name tenantId: tenantId invoiceNumber: '1968203' invoiceLevel: Shipment invoiceIssuer: Fed Ex number: 12345 invoiceDate: '2019-02-27T12:10:16Z' invoiceWeight: 17924 invoiceWeightUnitOfMeasure: pounds sourceName: test referenceNumbers: [] charges: - invoicedCurrency: USD invoiceAmount: '1732.0' code: DLH description: Line Haul invoiceLine: 1 - invoicedCurrency: USD invoiceAmount: '208.58' code: '405' description: Fuel Surcharge invoiceLine: 2 - invoicedCurrency: USD invoiceAmount: '75.0' code: SOC description: stop 2 charge invoiceLine: 3 x-code-samples: - lang: Curl source: "curl -X POST \\ \n https://sandbox-api.navisphere.com/v2/visibility/invoices \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json' \\ \n -d '{ \n \t\"shipmentNumber\": \"12345\",\n \t\"tenantId\": \"tenantId\",\n \t\"invoiceNumber\": \"1968203\",\n \t\"invoiceLevel\": \"Shipment\",\n \t\"invoiceIssuer\": \"Fed Ex\",\n \t\"number\": 12345,\n \t\"invoiceDate\": \"2019-02-27T12:10:16Z\",\n \t\"invoiceWeight\": 17924,\n \t\"invoiceWeightUnitOfMeasure\": \"pounds\",\n \t\"sourceName\": \"test\",\n \t\"referenceNumbers\": [], \n \t\"charges\": [{ \n \t\t\"invoicedCurrency\": \"USD\",\n \t\t\"invoiceAmount\": \"1732.0\",\n \t\t\"code\": \"DLH\",\n \t\t\"description\": \"Line Haul\",\n \t\t\"invoiceLine\": 1 \n \t}, \n \t{ \n \t\t\"invoicedCurrency\": \"USD\",\n \t\t\"invoiceAmount\": \"208.58\",\n \t\t\"code\": \"405\",\n \t\t\"description\": \"Fuel Surcharge\",\n \t\t\"invoiceLine\": 2 \n \t}, \n \t{ \n \t\t\"invoicedCurrency\": \"USD\",\n \t\t\"invoiceAmount\": \"75.0\",\n \t\t\"code\": \"SOC\",\n \t\t\"description\": \"stop 2 charge\",\n \t\t\"invoiceLine\": 3 \n \t}]\n }'" - lang: Java source: "HttpResponse response = Unirest.post(\"https://sandbox-api.navisphere.com/v2/visibility/invoices\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .body(\" { \n \t\"shipmentNumber\": \"12345\",\n \t\"tenantId\": \"tenantId\",\n \t\"invoiceNumber\": \"1968203\",\n \t\"invoiceLevel\": \"Shipment\",\n \t\"invoiceIssuer\": \"Fed Ex\",\n \t\"number\": 12345,\n \t\"invoiceDate\": \"2019-02-27T12:10:16Z\",\n \t\"invoiceWeight\": 17924,\n \t\"invoiceWeightUnitOfMeasure\": \"pounds\",\n \t\"sourceName\": \"test\",\n \t\"referenceNumbers\": [], \n \t\"charges\": [{ \n \t\t\"invoicedCurrency\": \"USD\",\n \t\t\"invoiceAmount\": \"1732.0\",\n \t\t\"code\": \"DLH\",\n \t\t\"description\": \"Line Haul\",\n \t\t\"invoiceLine\": 1 \n \t}, \n \t{ \n \t\t\"invoicedCurrency\": \"USD\",\n \t\t\"invoiceAmount\": \"208.58\",\n \t\t\"code\": \"405\",\n \t\t\"description\": \"Fuel Surcharge\",\n \t\t\"invoiceLine\": 2 \n \t}, \n \t{ \n \t\t\"invoicedCurrency\": \"USD\",\n \t\t\"invoiceAmount\": \"75.0\",\n \t\t\"code\": \"SOC\",\n \t\t\"description\": \"stop 2 charge\",\n \t\t\"invoiceLine\": 3 \n \t}]\n }\") .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'DELETE',\n \turl: 'https://sandbox-api.navisphere.com/v2/visibility/shipments/123456',\n \theaders: \n \t{ Authorization: 'Bearer YOU TOKEN', \n \t'Content-Type': 'application/json' } }; \n \n \tbody: { \n \t\"shipmentNumber\": \"12345\",\n \t\"tenantId\": \"tenantId\",\n \t\"invoiceNumber\": \"1968203\",\n \t\"invoiceLevel\": \"Shipment\",\n \t\"invoiceIssuer\": \"Fed Ex\",\n \t\"number\": 12345,\n \t\"invoiceDate\": \"2019-02-27T12:10:16Z\",\n \t\"invoiceWeight\": 17924,\n \t\"invoiceWeightUnitOfMeasure\": \"pounds\",\n \t\"sourceName\": \"test\",\n \t\"referenceNumbers\": [], \n \t\"charges\": [{ \n \t\t\"invoicedCurrency\": \"USD\",\n \t\t\"invoiceAmount\": \"1732.0\",\n \t\t\"code\": \"DLH\",\n \t\t\"description\": \"Line Haul\",\n \t\t\"invoiceLine\": 1 \n \t}, \n \t{ \n \t\t\"invoicedCurrency\": \"USD\",\n \t\t\"invoiceAmount\": \"208.58\",\n \t\t\"code\": \"405\",\n \t\t\"description\": \"Fuel Surcharge\",\n \t\t\"invoiceLine\": 2 \n \t}, \n \t{ \n \t\t\"invoicedCurrency\": \"USD\",\n \t\t\"invoiceAmount\": \"75.0\",\n \t\t\"code\": \"SOC\",\n \t\t\"description\": \"stop 2 charge\",\n \t\t\"invoiceLine\": 3 \n \t}]\n } \n request(options, function (error, response, body) { \n \tif (error) throw new Error(error); \n \n \tconsole.log(body); \n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v2/visibility/shipments/123456\");\n var request = new RestRequest(Method.DELETE);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n request.AddParameter(\"undefined\", \" { \n \t\"shipmentNumber\": \"12345\",\n \t\"tenantId\": \"tenantId\",\n \t\"invoiceNumber\": \"1968203\",\n \t\"invoiceLevel\": \"Shipment\",\n \t\"invoiceIssuer\": \"Fed Ex\",\n \t\"number\": 12345,\n \t\"invoiceDate\": \"2019-02-27T12:10:16Z\",\n \t\"invoiceWeight\": 17924,\n \t\"invoiceWeightUnitOfMeasure\": \"pounds\",\n \t\"sourceName\": \"test\",\n \t\"referenceNumbers\": [], \n \t\"charges\": [{ \n \t\t\"invoicedCurrency\": \"USD\",\n \t\t\"invoiceAmount\": \"1732.0\",\n \t\t\"code\": \"DLH\",\n \t\t\"description\": \"Line Haul\",\n \t\t\"invoiceLine\": 1 \n \t}, \n \t{ \n \t\t\"invoicedCurrency\": \"USD\",\n \t\t\"invoiceAmount\": \"208.58\",\n \t\t\"code\": \"405\",\n \t\t\"description\": \"Fuel Surcharge\",\n \t\t\"invoiceLine\": 2 \n \t}, \n \t{ \n \t\t\"invoicedCurrency\": \"USD\",\n \t\t\"invoiceAmount\": \"75.0\",\n \t\t\"code\": \"SOC\",\n \t\t\"description\": \"stop 2 charge\",\n \t\t\"invoiceLine\": 3 \n \t}]\n }; \n IRestResponse response = client.Execute(request);" responses: 201: description: Request successful content: application/json: schema: $ref: '#/components/schemas/quoteSummaries' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v2/visibility/orders: post: description: Post an order into Navisphere® Vision and/or Navisphere® Analytics. x-beta: true operationId: Visibility Order Create tags: - Visibility requestBody: description: JSON object of Order information. required: true content: application/json: schema: $ref: '#/components/schemas/visibilityOrder' example: customerName: Your Customer Name tenantId: tenantId orderNumber: 03647809 accountType: OUTBOUND createdDateTime: '2019-02-20T20:13:45.000Z' orderStatus: Active sourceName: Test premiumFreightReasonCode: 'AA' locations: - locationId: '67183' stopRole: Pick sequenceNumber: 0 name: SOME COMPANY PRODUCTS address1: 1234 EXAMPLE PkWY address2: 'room200' city: GROVETOWN stateProvinceCode: GA postalCode: '30813' countryCode: US requested: '2019-02-20T12:00:00.000Z' openDateTime: '2019-02-20T12:00:00.000Z' closeDateTime: '2019-02-20T22:30:00.000Z' - locationId: '111111' stopRole: Drop sequenceNumber: 1 name: JOHN DOE INC address1: 14900 CHARLSON RD address2: 'Building 1' city: EDEN PRAIRIE stateProvinceCode: MN postalCode: '55347' countryCode: US requested: '2019-02-20T12:00:00.000Z' openDateTime: '2019-02-20T12:00:00.000Z' closeDateTime: '2019-02-20T12:00:00.000Z' handlingUnits: - handlingUnitId: CO_1480525_1 packagingType: pallet quantity: 1 weight: 1996 weightUnitOfMeasure: pounds freightClass: '70' containerNumber: '343534534' description: 'notes' commodities: - commodityId: CO_1480525_1_1 orderNumber: '32432' name: "widgets" units: 1 sku: 'e87r99' plannerCode: "1234" value: 50 serialNumber: 'sad23432' partNumber: 'ds536' isHazMat: true pickLocSequenceNumber: 0 dropLocSequenceNumber: 1 category: 'tractor' description: Widget Model 1 packagingVolume: 17.5 packagingVolumeUnitOfMeasure: cubicFeet costCenterCode: 10 packagingType: 'boxes' weight: 0 weightUnitOfMeasure: 'pounds' packagingLength: 0 packagingWidth: 0 packagingHeight: 0 packagingUnitOfMeasure: 'feet' purchaseOrderNumber: '123abc' referenceNumbers: [] packagingLength: 0 packagingWidth: 0 packagingHeight: 0 packagingUnitOfMeasure: 'feet' volume: 0 volumeUnitOfMeasure: 'cubicFeet' x-code-samples: - lang: Curl source: "curl -X POST \\ \n https://sandbox-api.navisphere.com/v2/visibility/orders \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json' -d '{ \n \t\"customerName\": \"Your Customer Name\",\n \t\"tenantId\": \"tenantId\",\n \t\"orderNumber\": \"03647809\",\n \t\"accountType\": \"OUTBOUND\",\n \t\"createdDateTime\": \"2019-02-20T20:13:45.000Z\",\n \t\"orderStatus\": \"Active\",\n \t\"sourceName\": \"Test\",\n \t\"premiumFreightReasonCode\": \"AA\",\n \t\"locations\": [{ \n \t\t\"locationId\": \"67183\",\n \t\t\"stopRole\": \"Pick\",\n \t\t\"locatiosequenceNumbernId\": 0,\n \t\t\"name\": \"SOME COMPANY PRODUCTS\",\n \t\t\"address1\": \"1234 EXAMPLE PkWY\",\n \t\t\"address2\": \"room200\",\n \t\t\"city\": \"GROVETOWN\",\n \t\t\"stateProvinceCode\": \"GA\",\n \t\t\"postalCode\": \"30813\",\n \t\t\"countryCode\": \"US\",\n \t\t\"requested\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"openDateTime\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"closeDateTime\": \"2019-02-20T22:30:00.000Z\"\n \t}, \t{ \t\t\"locationId\": \"111111\",\n \t\t\"stopRole\": \"Drop\",\n \t\t\"locatiosequenceNumbernId\": 1,\n \t\t\"name\": \"JOHN DOE INC\",\n \t\t\"address1\": \"14900 CHARLSON RD\",\n \t\t\"address2\": \"Building 1\",\n \t\t\"city\": \"EDEN PRAIRIE\",\n \t\t\"stateProvinceCode\": \"MN\",\n \t\t\"postalCode\": \"55347\",\n \t\t\"countryCode\": \"US\",\n \t\t\"requested\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"openDateTime\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"closeDateTime\": \"2019-02-20T12:00:00.000Z\"\n \t}], \t\"handlingUnits\": [{ \n \t\t\"handlingUnitId\": \"CO_1480525_1\",\n \t\t\"packagingType\": \"pallet\",\n \t\t\"quantity\": 1,\n \t\t\"weight\": 1996,\n \t\t\"weightUnitOfMeasure\": \"pounds\",\n \t\t\"freightClass\": \"70\",\n \t\t\"containerNumber\": \"343534534\",\n \t\t\"description\": \"notes\",\n \t\t\"handlingUnits\": [{ \n \t\t\t\"commodityId\": \"CO_1480525_1_1\",\n \t\t\t\"orderNumber\": \"32432\",\n \t\t\t\"name\": \"widgets\",\n \t\t\t\"units\": 1,\n \t\t\t\"sku\": \"e87r99\",\n \t\t\t\"plannerCode\": \"1234\",\n \t\t\t\"value\": 50,\n \t\t\t\"serialNumber\": \"sad23432\",\n \t\t\t\"partNumber\": \"ds536\",\n \t\t\t\"isHazMat\": true,\n \t\t\t\"pickLocSequenceNumber\": 0,\n \t\t\t\"dropLocSequenceNumber\": 1,\n \t\t\t\"category\": \"tractor\",\n \t\t\t\"description\": \"Widget Model 1\",\n \t\t\t\"packagingVolume\": 17.5,\n \t\t\t\"packagingVolumeUnitOfMeasure\": \"cubicFeet\",\n \t\t\t\"costCenterCode\": 10,\n \t\t\t\"packagingType\": \"boxes\",\n \t\t\t\"weight\": 0,\n \t\t\t\"weightUnitOfMeasure\": \"pounds\",\n \t\t\t\"packagingLength\": 0,\n \t\t\t\"packagingWidth\": 0,\n \t\t\t\"packagingHeight\": 0,\n \t\t\t\"packagingUnitOfMeasure\": \"feet\",\n \t\t\t\"purchaseOrderNumber\": \"123abc\",\n \t\t\t\"referenceNumbers\": [],\n \t\t}], \t\t\"packagingLength\": 0,\n \t\t\"packagingWidth\": 0,\n \t\t\"packagingHeight\": 0,\n \t\t\"packagingUnitOfMeasure\": \"feet\",\n \t\t\"volume\": 0,\n \t\t\"volumeUnitOfMeasure\": \"cubicFeet\" \n \t}] }'" - lang: Java source: "HttpResponse response = Unirest.post(\"https://sandbox-api.navisphere.com/v2/visibility/orders\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .body(\" { \n \t\"customerName\": \"Your Customer Name\",\n \t\"tenantId\": \"tenantId\",\n \t\"orderNumber\": \"03647809\",\n \t\"accountType\": \"OUTBOUND\",\n \t\"createdDateTime\": \"2019-02-20T20:13:45.000Z\",\n \t\"orderStatus\": \"Active\",\n \t\"sourceName\": \"Test\",\n \t\"premiumFreightReasonCode\": \"AA\",\n \t\"locations\": [{ \n \t\t\"locationId\": \"67183\",\n \t\t\"stopRole\": \"Pick\",\n \t\t\"locatiosequenceNumbernId\": 0,\n \t\t\"name\": \"SOME COMPANY PRODUCTS\",\n \t\t\"address1\": \"1234 EXAMPLE PkWY\",\n \t\t\"address2\": \"room200\",\n \t\t\"city\": \"GROVETOWN\",\n \t\t\"stateProvinceCode\": \"GA\",\n \t\t\"postalCode\": \"30813\",\n \t\t\"countryCode\": \"US\",\n \t\t\"requested\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"openDateTime\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"closeDateTime\": \"2019-02-20T22:30:00.000Z\"\n \t}, \t{ \t\t\"locationId\": \"111111\",\n \t\t\"stopRole\": \"Drop\",\n \t\t\"locatiosequenceNumbernId\": 1,\n \t\t\"name\": \"JOHN DOE INC\",\n \t\t\"address1\": \"14900 CHARLSON RD\",\n \t\t\"address2\": \"Building 1\",\n \t\t\"city\": \"EDEN PRAIRIE\",\n \t\t\"stateProvinceCode\": \"MN\",\n \t\t\"postalCode\": \"55347\",\n \t\t\"countryCode\": \"US\",\n \t\t\"requested\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"openDateTime\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"closeDateTime\": \"2019-02-20T12:00:00.000Z\"\n \t}], \t\"handlingUnits\": [{ \n \t\t\"handlingUnitId\": \"CO_1480525_1\",\n \t\t\"packagingType\": \"pallet\",\n \t\t\"quantity\": 1,\n \t\t\"weight\": 1996,\n \t\t\"weightUnitOfMeasure\": \"pounds\",\n \t\t\"freightClass\": \"70\",\n \t\t\"containerNumber\": \"343534534\",\n \t\t\"description\": \"notes\",\n \t\t\"handlingUnits\": [{ \n \t\t\t\"commodityId\": \"CO_1480525_1_1\",\n \t\t\t\"orderNumber\": \"32432\",\n \t\t\t\"name\": \"widgets\",\n \t\t\t\"units\": 1,\n \t\t\t\"sku\": \"e87r99\",\n \t\t\t\"plannerCode\": \"1234\",\n \t\t\t\"value\": 50,\n \t\t\t\"serialNumber\": \"sad23432\",\n \t\t\t\"partNumber\": \"ds536\",\n \t\t\t\"isHazMat\": true,\n \t\t\t\"pickLocSequenceNumber\": 0,\n \t\t\t\"dropLocSequenceNumber\": 1,\n \t\t\t\"category\": \"tractor\",\n \t\t\t\"description\": \"Widget Model 1\",\n \t\t\t\"packagingVolume\": 17.5,\n \t\t\t\"packagingVolumeUnitOfMeasure\": \"cubicFeet\",\n \t\t\t\"costCenterCode\": 10,\n \t\t\t\"packagingType\": \"boxes\",\n \t\t\t\"weight\": 0,\n \t\t\t\"weightUnitOfMeasure\": \"pounds\",\n \t\t\t\"packagingLength\": 0,\n \t\t\t\"packagingWidth\": 0,\n \t\t\t\"packagingHeight\": 0,\n \t\t\t\"packagingUnitOfMeasure\": \"feet\",\n \t\t\t\"purchaseOrderNumber\": \"123abc\",\n \t\t\t\"referenceNumbers\": [],\n \t\t}], \t\t\"packagingLength\": 0,\n \t\t\"packagingWidth\": 0,\n \t\t\"packagingHeight\": 0,\n \t\t\"packagingUnitOfMeasure\": \"feet\",\n \t\t\"volume\": 0,\n \t\t\"volumeUnitOfMeasure\": \"cubicFeet\" \n \t}] \n }\") .asString();" - lang: NodeJS source: " var request = require(\"request\"); \n\n var options = { method: 'POST',\n \turl: 'https://sandbox-api.navisphere.com/v2/visibility/orders',\n \theaders: \n \t{ Authorization: 'Bearer YOU TOKEN', \n \t'Content-Type': 'application/json' } }; \n \n \tbody: { \n \t\"customerName\": \"Your Customer Name\",\n \t\"tenantId\": \"tenantId\",\n \t\"orderNumber\": \"03647809\",\n \t\"accountType\": \"OUTBOUND\",\n \t\"createdDateTime\": \"2019-02-20T20:13:45.000Z\",\n \t\"orderStatus\": \"Active\",\n \t\"sourceName\": \"Test\",\n \t\"premiumFreightReasonCode\": \"AA\",\n \t\"locations\": [{ \n \t\t\"locationId\": \"67183\",\n \t\t\"stopRole\": \"Pick\",\n \t\t\"locatiosequenceNumbernId\": 0,\n \t\t\"name\": \"SOME COMPANY PRODUCTS\",\n \t\t\"address1\": \"1234 EXAMPLE PkWY\",\n \t\t\"address2\": \"room200\",\n \t\t\"city\": \"GROVETOWN\",\n \t\t\"stateProvinceCode\": \"GA\",\n \t\t\"postalCode\": \"30813\",\n \t\t\"countryCode\": \"US\",\n \t\t\"requested\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"openDateTime\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"closeDateTime\": \"2019-02-20T22:30:00.000Z\"\n \t}, \t{ \t\t\"locationId\": \"111111\",\n \t\t\"stopRole\": \"Drop\",\n \t\t\"locatiosequenceNumbernId\": 1,\n \t\t\"name\": \"JOHN DOE INC\",\n \t\t\"address1\": \"14900 CHARLSON RD\",\n \t\t\"address2\": \"Building 1\",\n \t\t\"city\": \"EDEN PRAIRIE\",\n \t\t\"stateProvinceCode\": \"MN\",\n \t\t\"postalCode\": \"55347\",\n \t\t\"countryCode\": \"US\",\n \t\t\"requested\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"openDateTime\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"closeDateTime\": \"2019-02-20T12:00:00.000Z\"\n \t}], \t\"handlingUnits\": [{ \n \t\t\"handlingUnitId\": \"CO_1480525_1\",\n \t\t\"packagingType\": \"pallet\",\n \t\t\"quantity\": 1,\n \t\t\"weight\": 1996,\n \t\t\"weightUnitOfMeasure\": \"pounds\",\n \t\t\"freightClass\": \"70\",\n \t\t\"containerNumber\": \"343534534\",\n \t\t\"description\": \"notes\",\n \t\t\"handlingUnits\": [{ \n \t\t\t\"commodityId\": \"CO_1480525_1_1\",\n \t\t\t\"orderNumber\": \"32432\",\n \t\t\t\"name\": \"widgets\",\n \t\t\t\"units\": 1,\n \t\t\t\"sku\": \"e87r99\",\n \t\t\t\"plannerCode\": \"1234\",\n \t\t\t\"value\": 50,\n \t\t\t\"serialNumber\": \"sad23432\",\n \t\t\t\"partNumber\": \"ds536\",\n \t\t\t\"isHazMat\": true,\n \t\t\t\"pickLocSequenceNumber\": 0,\n \t\t\t\"dropLocSequenceNumber\": 1,\n \t\t\t\"category\": \"tractor\",\n \t\t\t\"description\": \"Widget Model 1\",\n \t\t\t\"packagingVolume\": 17.5,\n \t\t\t\"packagingVolumeUnitOfMeasure\": \"cubicFeet\",\n \t\t\t\"costCenterCode\": 10,\n \t\t\t\"packagingType\": \"boxes\",\n \t\t\t\"weight\": 0,\n \t\t\t\"weightUnitOfMeasure\": \"pounds\",\n \t\t\t\"packagingLength\": 0,\n \t\t\t\"packagingWidth\": 0,\n \t\t\t\"packagingHeight\": 0,\n \t\t\t\"packagingUnitOfMeasure\": \"feet\",\n \t\t\t\"purchaseOrderNumber\": \"123abc\",\n \t\t\t\"referenceNumbers\": [],\n \t\t}], \t\t\"packagingLength\": 0,\n \t\t\"packagingWidth\": 0,\n \t\t\"packagingHeight\": 0,\n \t\t\"packagingUnitOfMeasure\": \"feet\",\n \t\t\"volume\": 0,\n \t\t\"volumeUnitOfMeasure\": \"cubicFeet\" \n \t}] \n } \n request(options, function (error, response, body) { \n \tif (error) throw new Error(error); \n \n \tconsole.log(body); \n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v2/visibility/orders\");\n var request = new RestRequest(Method.POST);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n request.AddParameter(\"undefined\", \" { \n \t\"customerName\": \"Your Customer Name\",\n \t\"tenantId\": \"tenantId\",\n \t\"orderNumber\": \"03647809\",\n \t\"accountType\": \"OUTBOUND\",\n \t\"createdDateTime\": \"2019-02-20T20:13:45.000Z\",\n \t\"orderStatus\": \"Active\",\n \t\"sourceName\": \"Test\",\n \t\"premiumFreightReasonCode\": \"AA\",\n \t\"locations\": [{ \n \t\t\"locationId\": \"67183\",\n \t\t\"stopRole\": \"Pick\",\n \t\t\"locatiosequenceNumbernId\": 0,\n \t\t\"name\": \"SOME COMPANY PRODUCTS\",\n \t\t\"address1\": \"1234 EXAMPLE PkWY\",\n \t\t\"address2\": \"room200\",\n \t\t\"city\": \"GROVETOWN\",\n \t\t\"stateProvinceCode\": \"GA\",\n \t\t\"postalCode\": \"30813\",\n \t\t\"countryCode\": \"US\",\n \t\t\"requested\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"openDateTime\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"closeDateTime\": \"2019-02-20T22:30:00.000Z\"\n \t}, \t{ \t\t\"locationId\": \"111111\",\n \t\t\"stopRole\": \"Drop\",\n \t\t\"locatiosequenceNumbernId\": 1,\n \t\t\"name\": \"JOHN DOE INC\",\n \t\t\"address1\": \"14900 CHARLSON RD\",\n \t\t\"address2\": \"Building 1\",\n \t\t\"city\": \"EDEN PRAIRIE\",\n \t\t\"stateProvinceCode\": \"MN\",\n \t\t\"postalCode\": \"55347\",\n \t\t\"countryCode\": \"US\",\n \t\t\"requested\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"openDateTime\": \"2019-02-20T12:00:00.000Z\",\n \t\t\"closeDateTime\": \"2019-02-20T12:00:00.000Z\"\n \t}], \t\"handlingUnits\": [{ \n \t\t\"handlingUnitId\": \"CO_1480525_1\",\n \t\t\"packagingType\": \"pallet\",\n \t\t\"quantity\": 1,\n \t\t\"weight\": 1996,\n \t\t\"weightUnitOfMeasure\": \"pounds\",\n \t\t\"freightClass\": \"70\",\n \t\t\"containerNumber\": \"343534534\",\n \t\t\"description\": \"notes\",\n \t\t\"handlingUnits\": [{ \n \t\t\t\"commodityId\": \"CO_1480525_1_1\",\n \t\t\t\"orderNumber\": \"32432\",\n \t\t\t\"name\": \"widgets\",\n \t\t\t\"units\": 1,\n \t\t\t\"sku\": \"e87r99\",\n \t\t\t\"plannerCode\": \"1234\",\n \t\t\t\"value\": 50,\n \t\t\t\"serialNumber\": \"sad23432\",\n \t\t\t\"partNumber\": \"ds536\",\n \t\t\t\"isHazMat\": true,\n \t\t\t\"pickLocSequenceNumber\": 0,\n \t\t\t\"dropLocSequenceNumber\": 1,\n \t\t\t\"category\": \"tractor\",\n \t\t\t\"description\": \"Widget Model 1\",\n \t\t\t\"packagingVolume\": 17.5,\n \t\t\t\"packagingVolumeUnitOfMeasure\": \"cubicFeet\",\n \t\t\t\"costCenterCode\": 10,\n \t\t\t\"packagingType\": \"boxes\",\n \t\t\t\"weight\": 0,\n \t\t\t\"weightUnitOfMeasure\": \"pounds\",\n \t\t\t\"packagingLength\": 0,\n \t\t\t\"packagingWidth\": 0,\n \t\t\t\"packagingHeight\": 0,\n \t\t\t\"packagingUnitOfMeasure\": \"feet\",\n \t\t\t\"purchaseOrderNumber\": \"123abc\",\n \t\t\t\"referenceNumbers\": [],\n \t\t}], \t\t\"packagingLength\": 0,\n \t\t\"packagingWidth\": 0,\n \t\t\"packagingHeight\": 0,\n \t\t\"packagingUnitOfMeasure\": \"feet\",\n \t\t\"volume\": 0,\n \t\t\"volumeUnitOfMeasure\": \"cubicFeet\" \n \t}] \n }; \n IRestResponse response = client.Execute(request);" responses: '201': description: Request successful '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact your C.H. Robinson rep. /v2/visibility/milestones: get: description: "Allows partner to retrieve events during the life cycle of the order and shipment." operationId: Visibility GET Milestone tags: - Visibility parameters: - in: query name: to required: false schema: type: string format: date-time description: Ending date/time of event search. example: "2019-04-20T20:30:00.0000000Z" - in: query name: from required: true schema: type: string format: date-time description: Starting date/time of event search. example: "2019-04-20T20:30:00.0000000Z" - in: query name: skip required: false schema: type: integer default: 0 description: Identify how many results the call will skip. example: 10 - in: query name: take required: false schema: type: integer minimum: 0 maximum: 100 default: 100 description: Identify how many results the call will retrieve. example: 100 - in: query name: shipmentNumber required: false schema: type: string minimum: 1 maximum: 20 description: Shipment Number associated to the milestone. example: "SN 1" - in: query name: containerNumber required: false schema: type: string minimum: 1 maximum: 20 description: Container Number associated to the milestone. example: "ConNum 1" - in: query name: trackingNumber required: false schema: type: string minimum: 1 maximum: 150 description: Tracking Number associated to the milestone. example: "Tracking 1" - in: query name: purchaseOrderNumber required: false schema: type: string minimum: 0 maximum: 100 description: Purchase order number associated to the milestone. example: "PO1" - in: query name: customerPrimaryIdentifier required: false schema: type: string minimum: 0 maximum: 100 description: Shipment ID associated to the milestone. example: "SI 1" x-code-samples: - lang: Curl source: "curl -X GET \\ \n 'https://sandbox-api.navisphere.com/v2/visibility/milestones?shipmentNumber=20015434520' \\ \n -H 'Authorization: Bearer YOU TOKEN' \\ \n -H 'Content-Type: application/json'" - lang: Java source: "HttpResponse response = Unirest.get(\"https://sandbox-api.navisphere.com/v2/visibility/milestones?shipmentNumber=20015434520\")\n .header(\"Content-Type\", \"application/json\")\n .header(\"Authorization\", \"Bearer YOU TOKEN\")\n .asString();" - lang: NodeJS source: " var request = require(\"request\");\n\n var options = { method: 'GET',\n url: 'https://sandbox-api.navisphere.com/v2/visibility/milestones',\n qs: { shipmentNumber: '20015434520' },\n headers: { \n \tAuthorization: 'Bearer YOU TOKEN',\n \t'Content-Type': 'application/json' \n }};\n\n request(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\n \tconsole.log(body);\n });" - lang: C# source: " var client = new RestClient(\"https://sandbox-api.navisphere.com/v2/visibility/milestones?shipmentNumber=20015434520\");\n var request = new RestRequest(Method.GET);\n request.AddHeader(\"Authorization\", \"Bearer YOU TOKEN\");\n request.AddHeader(\"Content-Type\", \"application/json\");\n IRestResponse response = client.Execute(request);" responses: '200': description: Visibility GET Route content: application/json: example: _id: "5e8e39829ead382aacb584eb" tenantId: "25" eventCode: "X3" shipmentIdentifier: shipperId: "12345" purchaseOrderNumber: "2016752034" visionTrackingNumber: "eyJyZXF1ZXN0Ijp7InZpc2lvbl90cmFja2luZ19udW1iZXIiOiJaWllZWFhXV1ZWVVVUVFNTUlJRUVBQT09OTk1NIiwidGVuYW50X2lkIjo5ODc2LCJzaWduaW5nX3VuaXhfZGF0ZXRpbWVfc3RhbXAiOiIxNjExMDg4MDUyMzQ0In0sImhhc2hfc2lnbmF0dXJlIjoiL3V1U0M1UzlEUGkrRmwweEIyTFk4MU02azRURzlxa05KMFpkbUxOdmFBMD0ifQ%3D%3DeyJyZXF1ZXN0Ijp7InZpc2lvbl90cmFja2luZ19udW1iZXIiOiJaWllZWFhXV1ZWVVVUVFNTUlJRUVBQT09OTk1NIiwidGVuYW50X2lkIjo5ODc2LCJzaWduaW5nX3VuaXhfZGF0ZXRpbWVfc3RhbXAiOiIxNjExMDg4MDUyMzQ0In0sImhhc2hfc2lnbmF0dXJlIjoiL3V1U0M1UzlEUGkrRmwweEIyTFk4MU02azRURzlxa05K" dateTime: eventDateTime: "2019-06-05T18:36:13.131Z" estimatedTimeOfArrival : "2019-06-05T18:36:13.131Z" appointmentWindow: openDateTime: "2019-06-05T18:36:13.131Z" closeDateTime: "2019-06-05T18:36:13.131Z" carrier: name: Test Carrier dotNumber: Test scac: RBTW temperature: 32 temperatureUnitOfMeasure: Fahrenheit vehicleDetail: tractorNumber: "375" trailerNumber: "V5346" licensePlate: "MCV246" licensePlateState: "MN" vin: "1HGBH41JXMN109186" contactInformation: driverName: "Red Barkley" driverPhone: "5556129457" secondDriverName: "Lincoln Hawk" secondDriverPhone: "5554843167" dispatchName: "Kylo Ren" dispatchPhone: 5558675309 flightDetail: flightNumber: "777" flightDepartureDateTime: "2018-10-01T21:51:37.000Z" flightCarrierCode: "DAL" vesselDetail: vesselName: "Test Vessel" voyageNumber: "VN55426" vesselIMONumber: "IMO55411" hullNumber: "H90210" location: type: drop stopSequenceNumber: 2 sequenceNumber: 1 name: Bulk Goods Warehouse locationId: W4875164 address: address1: 14800 Charlson Rd address2: Building 1 city: Eden Prairie latitude: 44.820538 longitude: -93.464427 stateProvinceCode: MN postalCode: "55347" country: US items: itemId: "123456" weight: 45 weightUnitOfMeasure: Pounds quantity: 12 pallets: 1 supplementalInformation: reasonCode: "1" notes: Truck broke its axle '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '500': description: Internal Server Error. Please contact you C.H. Robinson Rep. #---Labels----------------------------------------------------------------------------------------------- /v1/labels: post: description: Generate label operationId: Generate label tags: - Labels requestBody: description: JSON object of label information required: true content: application/json: schema: $ref: '#/components/schemas/label' example: customer: customerCode: C8283603 billTo: customerCode: C8283603 currencyCode: USD payer: type: Sender rateShopType: BestCost shipDate: "2020-05-26T00:00:00.000Z" desiredDeliveryDate: "2020-05-29T00:00:00.000Z" origin: customerLocationId: 12345 name: "Test origin" contactName: Origin Contact Name contactPhoneNumber: 5555555555 address: address1: 14900 Charlson Rd. city: Eden Prairie stateProvinceCode: MN postalCode: 55347 countryCode: US destination: customerLocationId: 67890 name: "Test Destination" contactName: Destination Contact Name contactPhoneNumber: 5555555555 address: address1: 315 N Racine Ave. address2: "#501" city: Chicago stateProvinceCode: IL postalCode: 60607 countryCode: US packages: - contents: - countryOfOriginCode: US description: Test widget value: 123.45 currencyCode: USD quantity: 100 quantityUnitOfMeasure: No_Unit_Required weight: 5 weightUnitOfMeasure: Pounds receiverName: Test Receiver receiverPhoneNumber: 555-555-5555 documentsOnly: false height: 10 length: 11 linearUnitOfMeasure: Inches description: Test Package packagingType: Customer_Package weight: 5 weightUnitOfMeasure: Pounds width: 12 labelCustomerReferenceNumber: 9876543210 labelReferenceData1: 12345 labelReferenceData2: 67890 referenceNumbers: - type: CON value: 325423455 description: Test Shipment responses: '201': description: Request Successful content: application/json: schema: $ref: '#/components/schemas/successLabelCreate' example: labelResponseId: 9dab96ff-5dea-459e-a549-f1808c8259c6 orderNumber: 7030640 carrier: FDX serviceLevel: FedEx_Ground shipDate: "2020-05-26T00:00:00.0000000" scheduledDeliveryDate: "2020-05-28T23:59:00.0000000" shippingPackages: - id: 794613487241 labels: - labelData: iVBORw0KGgoAAAANSUhEUgAAAyAAAASwAQAAAAAryhMIAAAjtUlEQVR42u3d34/bSJ4YcHI5EG9x3uZentRYQTVBguxj7GsgJyNaMcABtwhwuP0DgmDacND9EFzcHSNrad1WUdeL5gYwWknmId2IT8pfkLmn8V28ttirgXkLGNY9nbHrtUWaBzHAYkbUCGcVLaoqVaTUP9zutlpNam1PESNOW3bzI7Lq+/1WkZQkkDkswjuOqBzhyDcK0S4qqKxWk0ZkK3suJFDbbF0AJyP1vmNug+NIXzfQddL0CMCq0rTg64je+FxGYKB9DIbt9kvcfvqb1mlIv/UYKMf+0pUM7zKpWBAEWblyHLnZ+Hw4dH877JJBt labelFormat: image/png rate: 10.2 rateCurrencyCode: USD trackingNumber: 794613487321 referenceNumbers: - type: VPO value: Jason - type: CON value: 325423455 carrierMessages: - source: Rating carrier: DHL message: DHL returned a zero price for ParcelServiceLevelRDN 5304 (EXPRESS DOMESTIC) - source: Rating message: Your invoice may vary from the displayed reference rates '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/error401' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/error403' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/error404' '424': description: Failed Dependency content: application/json: schema: $ref: '#/components/schemas/error424' x-code-samples: - lang: Curl source: "curl -X POST \\ \n https://sandbox-api.navisphere.com/v1/labels \\\n -H 'Authorization: Bearer YOUR TOKEN' \\\n 'Content-Type: application/json' \\\n -d '{\n \t\"customer\": { \n \t\t\"customerCode\": \"C8283603\" \n \t}, \n \t\"billTo\": { \n \t\t\"customerCode\": \"C8283603\", \n \t\t\"currencyCode\": \"USD\" \n \t}, \n \t\"payer\": { \n \t\t\"Type\": \"Sender\" \n \t}, \n \t\"rateShopType\": \"BestCost\", \n \t\"shipDate\": \"2020-05-26T00:00:00.000Z\", \n \t\"desiredDeliveryDate\": \"2020-05-29T00:00:00.000Z\", \n \t\"origin\": {\n \t\t\"customerLocationId\": \"12345\", \n \t\t\"name\": \"Test Origin\", \n \t\t\"contactName\": \"Origin Contact Name\", \n \t\t\"contactPhoneNumber\": \"5555555555\", \n \t\t\"address\": { \n \t\t\t\"address1\": \"14900 Charlson Rd.\", \n \t\t\t\"city\": \"Eden Prairie\", \n \t\t\t\"stateProvinceCode\": \"MN\", \n \t\t\t\"postalCode\": \"55347\", \n \t\t\t\"countryCode\": \"US\" \n \t\t} \n \t}, \n \t\"destination\": {\n \t\t\"customerLocationId\": \"67890\", \n \t\t\"name\": \"Test Destination\", \n \t\t\"contactName\": \"Destination Contact Name\", \n \t\t\"contactPhoneNumber\": \"5555555555\", \n \t\t\"address\": { \n \t\t\t\"address1\": \"315 N Racine Ave.\", \n \t\t\t\"address2\": \"#501\", \n \t\t\t\"city\": \"Chicago\", \n \t\t\t\"stateProvinceCode\": \"IL\", \n \t\t\t\"postalCode\": \"60607\", \n \t\t\t\"countryCode\": \"US\" \n \t\t} \n \t}, \n \t\"packages\": [{ \n \t\t\"contents\": [{ \n \t\t\t\"countryOfOriginCode\": \"US\", \n \t\t\t\"description\": \"Test Widget\", \n \t\t\t\"value\": 123.45, \n \t\t\t\"currencyCode\": \"USD\", \n \t\t\t\"quantity\": 100, \n \t\t\t\"quantityUnitOfMeasure\": \"No_Unit_Required\", \n \t\t\t\"weight\": 5, \n \t\t\t\"weightUnitOfMeasure\": \"Pounds\"\n \t\t}], \n \t\t\"receiverName\": \"Test Receiver\", \n \t\t\"receiverPhoneNumber\"555-555-5555\", \n \t\t\"documentsOnly\": false, \n \t\t\"height\": 10, \n \t\t\"length\": 11, \n \t\t\"linearUnitOfMeasure\": \"Inches\": \n \t\t\"description\": \"Test Package\", \n \t\t\"packagingType\": \"Customer_Package\", \n \t\t\"weight\": 5, \"weightUnitOfMeasure\": \"Pounds\", \n \t\t\"width\": 12, \n \t\t\"labelCustomerReferenceNumber\": \"9876543210\", \n \t\t\"labelReferenceData1\": \"12345\", \n \t\t\"labelReferenceData2\": \"67890\" \n \t}], \n \t\"referenceNumbers\": [{ \n \t\t\"type\": \"CON\", \n \t\t\"value\": \"325423455\" \n\t}], \n \t\"description\": \"Test Shipment\" \n\t}" - lang: Java source: >- HttpResponse response = Unirest.post("https://sandbox-api.navisphere.com/v1/labels") .header("Authorization", "Bearer YOUR TOKEN") .header("Content-Type", "application/json") .header("Cookie", "ss-pid=reeoYH8VnxJJxE2wjdeR; ss-id=wz344wwbPiSmNAQ6R3L0") .body("{ "customer": { "customerCode": "C8283603" }, "billTo": { "customerCode": "C8283603", "currencyCode": "USD" }, "payer": { "type": "Sender" }, "rateShopType": "BestCost", "shipDate": "2020-05-26T00:00:00.000Z", "desiredDeliveryDate": "2020-05-29T00:00:00.000Z", "origin": { "customerLocationId": "12345", "name": "Test Origin", "contactName": "Origin Contact Name", "contactPhoneNumber": "5555555555", "address": { "address1": "14900 Charlson Rd.", "city": "Eden Prairie", "stateProvinceCode": "MN", "postalCode": "55347", "countryCode": "US" } }, "destination": { "customerLocationId": "67890", "name": "Test Destination", "contactName": "Destination Contact Name", "contactPhoneNumber": "5555555555", "address": { "address1": "315 N Racine Ave.", "address2": "#501", "city": "Chicago", "stateProvinceCode": "IL", "postalCode": "60607", "countryCode": "US" } }, "Packages": [ { "contents": [ { "countryOfOriginCode": "US", "description": "Test Widget", "value": 123.45, "currencyCode": "USD", "quantity": 100, "quantityUnitOfMeasure": "No_Unit_Required", "weight": 5, "weightUnitOfMeasure": "Pounds" } ], "receiverName": "Test Receiver", "receiverPhoneNumber": "555-555-5555", "documentsOnly": false, "height": 10, "length": 11, "linearUnitOfMeasure": "Inches", "description": "Test Package", "packagingType": "Customer_Package", "weight": 5, "weightUnitOfMeasure": "Pounds", "width": 12, "labelCustomerReferenceNumber": "9876543210", "labelReferenceData1": "12345", "labelReferenceData2": "67890" }, { "contents": [ { "countryOfOriginCode": "US", "description": "Test Widget", "value": 123.45, "currencyCode": "USD", "quantity": 100, "quantityUnitOfMeasure": "No_Unit_Required", "weight": 5, "weightUnitOfMeasure": "Pounds", "eccn": "3A001" } ], "receiverName": "Test Receiver", "receiverPhoneNumber": "555-555-5555", "documentsOnly": false, "height": 10, "length": 11, "linearUnitOfMeasure": "Inches", "description": "Test Package", "packagingType": "Customer_Package", "weight": 5, "weightUnitOfMeasure": "Pounds", "width": 12 } ], "referenceNumbers": [ { "type": "CON", "value": "325423455" } ], "description": "Test Shipment" }") .asString(); - lang: 'C#' source: |2- var client = new RestClient("https://sandbox-api.navisphere.com/v1/labels"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer YOUR TOKEN"); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{ "customer": { "customerCode": "C8283603" }, "billTo": { "customerCode": "C8283603", "currencyCode": "USD" }, "payer": { "type": "Sender" }, "rateShopType": "BestCost", "shipDate": "2020-05-26T00:00:00.000Z", "desiredDeliveryDate": "2020-05-29T00:00:00.000Z", "origin": { "customerLocationId": "12345", "name": "Test Origin", "contactName": "Origin Contact Name", "contactPhoneNumber": "5555555555", "address": { "address1": "14900 Charlson Rd.", "city": "Eden Prairie", "stateProvinceCode": "MN", "postalCode": "55347", "countryCode": "US" } }, "destination": { "customerLocationId": "67890", "name": "Test Destination", "contactName": "Destination Contact Name", "contactPhoneNumber": "5555555555", "address": { "address1": "315 N Racine Ave.", "address2": "#501", "city": "Chicago", "stateProvinceCode": "IL", "postalCode": "60607", "countryCode": "US" } }, "Packages": [ { "contents": [ { "countryOfOriginCode": "US", "description": "Test Widget", "value": 123.45, "currencyCode": "USD", "quantity": 100, "quantityUnitOfMeasure": "No_Unit_Required", "weight": 5, "weightUnitOfMeasure": "Pounds" } ], "receiverName": "Test Receiver", "receiverPhoneNumber": "555-555-5555", "documentsOnly": false, "height": 10, "length": 11, "linearUnitOfMeasure": "Inches", "description": "Test Package", "packagingType": "Customer_Package", "weight": 5, "weightUnitOfMeasure": "Pounds", "width": 12, "labelCustomerReferenceNumber": "9876543210", "labelReferenceData1": "12345", "labelReferenceData2": "67890" }, { "contents": [ { "countryOfOriginCode": "US", "description": "Test Widget", "value": 123.45, "currencyCode": "USD", "quantity": 100, "quantityUnitOfMeasure": "No_Unit_Required", "weight": 5, "weightUnitOfMeasure": "Pounds", "eccn": "3A001" } ], "receiverName": "Test Receiver", "receiverPhoneNumber": "555-555-5555", "documentsOnly": false, "height": 10, "length": 11, "linearUnitOfMeasure": "Inches", "description": "Test Package", "packagingType": "Customer_Package", "weight": 5, "weightUnitOfMeasure": "Pounds", "width": 12 } ], "referenceNumbers": [ { "type": "CON", "value": "325423455" } ], "description": "Test Shipment" }", ParameterType.RequestBody); IRestResponse response = client.Execute(request); components: securitySchemes: sandbox: type: http scheme: bearer bearerFormat: jwt bearerAuth: type: http scheme: bearer bearerFormat: jwt schemas: #---Rating--------------------------------------------------------------------------------------------- freightClassEstimate: type: object required: - length - width - height - linearUnit - originCountryCode - destinationCountryCode - customerCode - quantity properties: length: type: number format: float description: Length of the item. width: type: number format: float description: Width of the item. height: type: number format: float description: Height of the item. linearUnit: $ref: '#/components/schemas/linearUomEnum' weight: type: number format: float description: "The weight of each piece. \n\n ### Required if `totalWeight` is not being used." weightUnit: $ref: '#/components/schemas/weightUomEnum' originCountryCode: $ref: '#/components/schemas/countryCodeEnum' destinationCountryCode: $ref: '#/components/schemas/countryCodeEnum' customerCode: type: string minimum: 1 maximum: 50 description: C.H. Robinson defined code that is provided to the customer. quantity: type: number format: float description: Identifies the number of pieces of the line item. shipmentDate: type: string format: date-time description: > An ISO8601 UTC date-time used to indicate the date customer would like to ship the product. totalWeight: type: number format: float description: "The total weight. \n\n ### Required if `weight` is not being used." freightClassEstimateResponse: type: object properties: estimatedFreightClassByDensityOnly: $ref: '#/components/schemas/freightEstimateResponseEnum' ratingItem: type: object required: - actualWeight - weightUnit - weight - weightUnitOfMeasure properties: description: type: string minimum: 1 maximum: 50 description: Customer supplied description of the item. freightClass: type: number description: "Freight class code that item falls under. \n\n ### Required if quote will be used to create an Order for an **LTL shipment**." enum: - "50" - "55" - "60" - "65" - "70" - "77.5" - "85" - "92.5" - "100" - "110" - "125" - "150" - "175" - "200" - "250" - "300" - "400" - "500" actualWeight: type: number format: float description: Total Weight of the line item. This represents to total weight of the all quantities. For example, if the indvidual weight of 1 quantity is 100 pounds, and the quantity of the line item is 2, then 200 is the value for this field. deprecated: true weight: type: number format: float description: Total Weight of the line item. This represents to total weight of the all quantities. For example, if the indvidual weight of 1 quantity is 100 pounds, and the quantity of the line item is 2, then 200 is the value for this field. weightUnit: type: string description: "Unit of measure for weight parameters." enum: - "Pounds" - "Kilograms" deprecated: true weightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' length: type: number format: float description: Length of the line item. deprecated: true packagingLength: type: number format: float description: Length of the line item. width: type: number format: float description: Width of the line item. deprecated: true packagingWidth: type: number format: float description: Width of the line item. height: type: number format: float description: Height of the line item. deprecated: true packagingHeight: type: number format: float description: Height of the line item. linearUnit: type: string description: "Unit of measure for height, width, and length parameters." enum: - "Inches" - "Feet" - "Centimeters" - "Meters" deprecated: true packagingUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' pallets: type: number format: float description: Identifies how many pallets for the line item. pieces: type: number format: float description: Identifies the number of pieces of the line item. deprecated: true quantity: type: number format: float description: Quantity is the number of packagingType's. palletSpaces: type: number format: float description: Indentifies how many pallet spaces the line item will use in the truck. volume: type: number format: float description: Volume of the item. deprecated: packagingVolume: type: number format: float description: Volume of the item. volumeUnit: type: string description: "Unit of measure for volume parameters." enum: - "CubicFeet" - "CubicMeters" deprecated: true packagingVolumeUnitOfMeasure: $ref: '#/components/schemas/volumeUomEnum' density: type: number format: float description: Identifies the density of the item. linearSpace: type: number format: float description: Identifies the linear space of the item. declaredValue: type: number format: float description: "Customer assigned value of the line item. \n\n ### Required if quote will be used to create an Order." deprecated: true insuranceValue: type: number format: float description: "Customer assigned value of the line item. \n\n ### Required if quote will be used to create an Order." packagingCode: description: "Deprecated field now known as packagingType" deprecated: true packagingType: $ref: '#/components/schemas/packageCodeRatingEnum' productCode: type: string minimum: 1 maximum: 50 description: "Customer defined code for the product." productName: type: string minimum: 1 maximum: 50 description: "Deprecated field - use description field to define name of product. \n\n ### Required if quote will be used to create an Order." deprecated: true temperatureSensitive: description: "Deprecated field now known as temperatureType" deprecated: true temperatureType: $ref: '#/components/schemas/temperatureSensitiveEnum' temperatureUnit: $ref: '#/components/schemas/temperatureUomEnum' requiredTemperatureHigh: type: number description: The highest temperature the product can be transported. format: float requiredTemperatureLow: type: number description: The lowest temperature the product can be transported. format: float unitsPerPallet: type: number format: float description: Identifies the amount of units on each pallet. unitWeight: type: number format: float description: Identifies individual unit item weight. unitVolume: type: number format: float description: Identifies individual unit item volume. isStackable: type: boolean description: Indicate if items are stackable. isOverWeightOverDimensional: type: boolean description: Indicate if the item is over weight or over dimensional. isUsedGood: type: boolean description: Indicate if item is used. isHazardous: type: boolean description: Indicate if item is hazardous. hazardousDescription: type: string minimum: 1 maximum: 500 description: "Hazordous material description. \n\n ### If \"isHazardous\" is set to true you must provide a description." hazardousEmergencyPhone: type: string minimum: 1 maximum: 50 description: "Emergency phone number. \n\n ### If \"isHazardous\" is set to true you must provide an emergency phone number." nmfc: type: string minimum: 1 maximum: 50 description: National Motor Freight Class(NMFC) is a voluntary standard that provides a comparison of commodities moving in interstate, intrastate and foreign commerce. It is similar in concept to the groupings or grading systems that serve many other industries." deprecated: true nationalMotorFreightClass: type: string minimum: 1 maximum: 50 description: National Motor Freight Class(NMFC) is a voluntary standard that provides a comparison of commodities moving in interstate, intrastate and foreign commerce. It is similar in concept to the groupings or grading systems that serve many other industries." upc: type: string minimum: 1 maximum: 50 description: Universal Product Code. The bar code usually consists of a five digit manufacturer number and a five digit product number. deprecated: true upcNumber: type: string minimum: 1 maximum: 50 description: Universal Product Code. The bar code usually consists of a five digit manufacturer number and a five digit product number. sku: type: string minimum: 1 maximum: 50 description: Stock Keeping Unit. A number assigned to a product by the customer. deprecated: true skuNumber: type: string minimum: 1 maximum: 50 description: Stock Keeping Unit. A number assigned to a product by the customer. plu: type: string minimum: 1 maximum: 50 description: Price Look-up Number. A system of numbers the customer uses that uniquely identifies bulk produce deprecated: true pluNumber: type: string minimum: 1 maximum: 50 description: Price Look-up Number. A system of numbers the customer uses that uniquely identifies bulk produce pickupSequenceNumber: type: integer description: Identifies the pickup sequence of the item. Only required for multi stop. dropSequenceNumber: type: integer description: Identifies the drop sequence of the item. Only required for multi stop. referenceNumbers: type: array description: Array of additional reference numbers that can be provided. items: $ref: '#/components/schemas/referenceNumber' unNumber: type: string minimum: 1 maximum: 10 description: 'Four-digit numbers prefixed by "UN" or "NA" that indentifies dangerous goods, hazardous substances and articles (such as explosives, flammable liquids, toxic substances, etc.) in the framework of international transport.' example: 'UN2796' packagingGroup: $ref: '#/components/schemas/hazardousGroupEnum' hazmatClass: type: string minimum: 1 maximum: 10 description: Code for hazardous material in the framework of international transport. deprecated: true hazmatClassCode: type: string minimum: 1 maximum: 10 description: Code for hazardous material in the framework of international transport. ratingLocation: type: object description: Identifies all the relevant location information required: - countryCode - postalCode properties: locationName: type: string minimum: 1 maximum: 100 description: "Customer defined name of the location. \n\n ### Required if quote will be used to create an Order. \n\n ### **If you plan to provide this information on the order portion of the call, it is not required in the rating call." deprecated: true name: type: string minimum: 1 maximum: 100 description: "Customer defined name of the location. \n\n ### Required if quote will be used to create an Order. \n\n ### **If you plan to provide this information on the order portion of the call, it is not required in the rating call." address1: type: string minimum: 1 maximum: 200 description: "Indicate address line 1. \n\n ### Required if quote will be used to create an Order. \n\n ### **If you plan to provide this information on the order portion of the call, it is not required in the rating call." address2: type: string minimum: 1 maximum: 200 description: Indicate address line 2. address3: type: string minimum: 1 maximum: 200 description: Indicate address line 3. city: type: string minimum: 1 maximum: 50 description: "Indicate the city of the location. \n\n ### Required if quote will be used to create an Order. \n\n ### **If you plan to provide this information on the order portion of the call, it is not required in the rating call." stateProvinceCode: $ref: '#/components/schemas/stateProvinceCodeRatingEnum' countryCode: $ref: '#/components/schemas/countryCodeRatingEnum' postalCode: type: string minimum: 1 maximum: 10 description: >- Indicate the postal code of the location. requestedOpenDateTime: type: string format: date-time description: ISO8601 UTC date-time of the earliest time carrier can arrive at the stop. deprecated: true openDateTime: type: string format: date-time description: ISO8601 UTC date-time of the earliest time carrier can arrive at the stop. requestedCloseDateTime: type: string format: date-time description: ISO8601 UTC date-time of the latest time carrier can arrive at the stop. deprecated: true closeDateTime: type: string format: date-time description: ISO8601 UTC date-time of the latest time carrier can arrive at the stop. latitude: type: number format: float minimum: -90 maximum: 90 description: The latitude of the location. longitude: type: number format: float minimum: -180 maximum: 180 description: The longitude of the location. specialRequirement: $ref: '#/components/schemas/specialRequirementRating' isPort: type: boolean description: Indicate if location is a port. unLocode: type: string minimum: 1 maximum: 25 description: United Nations Code for trade and transport locations. iata: type: string minimum: 1 maximum: 10 description: IATA station code or simply a location identifier, is a three-letter code designating many airports around the world. Defined by the International Air Transport Association (IATA). customerLocationId: type: string minimum: 1 maximum: 50 description: "Customer defined identifier associated to a specific location. \n\n ### If C.H. Robinson maintains a list of the customer's location IDs, then customerLocationId can be provided in lieu of address information." sequenceNumber: type: integer description: System generated number applied to the location when it is entered into the system. Only required for multi stop. referenceNumbers: type: array description: Array of additional reference numbers that can be provided. items: $ref: '#/components/schemas/referenceNumber' cargoLiability: type: object description: Informs of carrier liability coverages. properties: perPound: type: integer description: Carrier’s liability per pound based on product attributes. max: type: integer description: Carrier’s maximum liability based on product attributes. amount: type: integer description: Calculated liability coverage for specific quote based on product attributes. currencyCode: $ref: '#/components/schemas/currencyCodeEnum' equipment: type: object properties: equipmentType: $ref: '#/components/schemas/equipmentCodeEnum' quantity: type: number format: float description: Define how many of identified equipment will be needed. transportMode: type: object description: Define information for transport criteria required: - mode properties: mode: $ref: '#/components/schemas/transportModeEnum' equipments: type: array description: List of required equipment needed. items: $ref: '#/components/schemas/equipment' ratingPost: required: - items - origin - destination - shipDate - customerCode - transportModes properties: items: type: array description: Identifies all relevant item level information items: $ref: '#/components/schemas/ratingItem' origin: $ref: '#/components/schemas/ratingLocation' destination: $ref: '#/components/schemas/ratingLocation' additionalLocations: type: array description: Only required for multi stop requests items: $ref: '#/components/schemas/ratingLocation' shipDate: type: string format: date-time description: "An ISO8601 UTC date-time used to indicate the date customer would like to ship the product. \n\n ### **This date can not be earlier than the current date and can not be more than thirty days in the future." platform: type: string description: "A static ID that represents an external party to C.H. Robinson. It can be used by C.H. Robinson to route external rate requests based on specific customer needs. To use this field, C.H. Robinson must generate and provide this ID to the external party. \n\n ### **This field is required for TMC customers. Reach out to your TMC Representative to obtain this ID. \n\n ### **Note that the API team does not provide this ID, and the majority of customers will not be using this field." transactionId: type: string description: "This ID is a permanent link between the unique shipment being quoted and the quote offered by C.H. Robinson - it is normally the primary shipment reference number, a value that should not change during the lifecycle of the shipment. The same transactionId should be submitted in the rate request when re-rating the same shipment. \n\n ### **Required for Truckload Quoting" customerCode: type: string minimum: 1 maximum: 50 description: C.H. Robinson defined code that is provided to the customer. transportModes: type: array description: Array of transport modes items: $ref: '#/components/schemas/transportMode' referenceNumbers: type: array description: Array of additional reference numbers that can be provided. items: $ref: '#/components/schemas/referenceNumber' optionalAccessorials: type: array description: "C.H. Robinson defined code for additional accessorials not defined in the special requirements object. \n\n ### **To take advantage of additional accessorials, a conversation will need to take place with your C.H. Robinson representative." items: type: string specialServices: type: array description: Array of special services. items: $ref: '#/components/schemas/specialServicesEnum' rates: type: array description: An array of all rates associated to a quote items: type: object properties: rateId: type: number format: float description: ID of the rate that is provided on successfully calling the Rating API. totalRate: type: number format: float description: Currency amount of the total rate unitRate: type: number format: float description: Currency amount of the unit rate quantity: type: number format: float description: Defines how many units there are rateCode: $ref: '#/components/schemas/rateCodeEnum' rateCodeValue: type: string description: Description of the rateCode currencyCode: $ref: '#/components/schemas/currencyCodeEnum' isOptional: type: boolean description: Defines if the rate is optional. If the isOptional flag is set to false, the currency amount of the assecorial will be included in the totalCharge. quoteSummaries: properties: quoteSummaries: type: array description: Array of quotes. items: type: object properties: quoteId: type: integer format: int64 description: ID of the quote that is provided on successfully calling the rating API. carrier: type: object description: Identifies the carrier associated to the quote. properties: carrierCode: type: string description: The unique identifier assigned to a carrier within C.H. Robinson. carrierName: type: string minimum: 1 maximum: 50 description: The name of the carrier. scac: type: string minimum: 1 maximum: 10 description: The SCAC code of a carrier if it has one. customer: type: object description: C.H. Robinson customer associated to the quote. properties: customerName: type: string minimum: 1 maximum: 50 description: Customer name associated to the quote. totalCharge: type: number format: float description: Total charge associated to the quote. totalFreightCharge: type: number format: float description: Total freight charge associated to the quote. totalAccessorialCharge: type: number format: float description: Total accessorial charge associated to the quote. quoteExpirationDate: type: string format: date-time description: An ISO8601 UTC date-time used to indicate the date the quote will no longer be valid. transit: type: object description: Collection of transit information associated to the quote. properties: minimumTransitDays: type: number format: float description: Minimum transit days. maximumTransitDays: type: number format: float description: Maximum transit days. minimumDeliveryDate: type: string format: date-time description: An ISO8601 UTC date-time used to indicate the minimum delivery date. maximumDeliveryDate: type: string format: date-time description: An ISO8601 UTC date-time used to indicate the maximum delivery date. originService: type: string description: Denotes whether an LTL carrier services the location terminal on their own (direct) or through the help of partner carriers who can service the location terminal on their behalf (indirect). enum: - Direct - Indirect - No Data destinationService: type: string description: Denotes whether an LTL carrier services the location terminal on their own (direct) or through the help of partner carriers who can service the location terminal on their behalf (indirect). enum: - Direct - Indirect - No Data rates: $ref: '#/components/schemas/rates' transportModeType: $ref: '#/components/schemas/transportModeEnum' equipmentType: $ref: '#/components/schemas/equipmentCodeEnum' cargoLiability: $ref: '#/components/schemas/cargoLiability' distance: type: number description: Indicates rated distance. quoteSource: type: string description: A field to indicate whether the quote returned is contracted, market or volume. #---Authentication------------------------------------------------------------------------------------- tokenRequest: required: - client_id - client_secret - audience - grant_type properties: client_id: type: string description: ID that will be provided by C.H. Robinson used to retrieve authorization tokens. example: Partner client_id client_secret: type: string description: Secret that will be provided by C.H. Robinson used to retrieve authorization tokens. example: Partner client_secret audience: type: string description: Static audience URL allowing authorization token to be created. "https://inavisphere.chrobinson.com" example: https://inavisphere.chrobinson.com grant_type: type: string description: Static identifier allowing authorization token to be created. "client_credentials" example: client_credentials tokenSuccessResponse: properties: token_type: type: string description: Indicates type of token received. **Will always be a Bearer token.** example: Bearer expires_in: type: integer description: Amount of time token is valid. **Will always be 86400 seconds (24 hours).** example: 86400 access_token: type: string description: Returned token that will be used as the bearer token on all subsequent API calls. example: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Ik1This is just an example token that won't work for anyone.FpbmluZy1hdXRoLmNocm9iaW5zb24uY29tLyIsInN1YiI6Im1BbVJ6RXVGejdQWUpYcVFXSlh4cnBldWdrN2tEQXdCQGNsaWVudHMiLCJhdWQiOiJodHRwczovL2luYXZpc3BoZXJlLmNocm9iaW5zb24uY29tIiwiaWF0IjoxNTUxMTk0MzQ5LCJleHAiOjE1NTEyODA3NDksImF6cCI6Im1BbVJ6RXVGejdQWUpYcVFXSlh4cnBldWdrN2tEQXdCIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIn0.YsDMHGaPBuLOgBCDmhLm9xyVwyxHWueefrcVpSNOIbRuQYd0Sua68znIQENFEolCbipwH8npCCSl2eGXrhmP2kALhDtPcLyypjzhCPS-4lqT4iDOa7Ll9Ek2H2sSPb4ix91bp7Up25sAROHY8nq16SR160vePelmt78q-akrD_KDVBgToLLaV0Eukpim_H2aEspIaVby6eCehc40bFuCQuipSWZXafh5pnp1j2dS6JP4yL2JrvDTUem6_oEdEWY4Q-ppvIj8JA4zU4qjidNI59RZPNWAo8BiHk0yD7sGiPQrm4l7ZFLRkO4SnCl88n9Y7bgL02JCOjRVXiqKDPUCMw scope: type: string description: Defines token access. example: read:status #---Orders--------------------------------------------------------------------------------------------- order: type: object required: - customers - billTos - services properties: orderNumber: type: integer description: >- C.H. Robinson order number received on successful order create. ### This would only be used on an Order Update. customers: type: array minimum: 1 maximum: 1 description: The customer(s) on the order. items: $ref: '#/components/schemas/orderCustomer' billTos: type: array minimum: 1 description: The bill to(s) on the order. items: $ref: '#/components/schemas/orderBillTo' services: type: array minimum: 1 description: The service(s) on the order. items: $ref: '#/components/schemas/orderService' measurementSystem: type: string description: Indicates the unit of measure. enum: - "Metric" - "Standard" referenceNumbers: type: array description: Additional reference number objects pertaining to the whole order. items: $ref: '#/components/schemas/referenceNumber' additionalLocations: type: array description: List of additional Locations for Ocean/Air transport Mode. items: $ref: '#/components/schemas/additionalLocation' internationalParcelShippingSpecs: type: object description: Elements specific to international parcel shipping scenarios. properties: isDutiable: type: boolean description: A flag required for DHL international shipments indicating whether or not the shipment is dutiable. dutyPayerType: $ref: "#/components/schemas/payerTypeEnum" dutyPayerAccountNumber: $ref: "#/components/schemas/dutyPayerAccountNumber" exportReasonCode: $ref: "#/components/schemas/exportReasonCode" AESTransactionNumber: $ref: "#/components/schemas/AESTransactionNumber" isAESExempt: type: boolean description: Indicates that goods being shipped are exempt from AES Export Filing; FedEx only, Optional. countryOfOriginCode: description: Indicates country of origin of the items; Required for all international shipments. $ref: "#/components/schemas/countryCodeEnum" parcelLabelReferenceNumbers: type: object description: Reference data to be used on the label pertaining to the whole order. properties: labelReferenceData1: $ref: "#/components/schemas/labelReferenceData1" labelReferenceData2: $ref: "#/components/schemas/labelReferenceData2" labelReferenceData3: $ref: "#/components/schemas/labelReferenceData3" parcelSpecs: type: object description: Elements specific to parcel shipping scenarios. properties: isDocumentsOnly: type: boolean description: Used on DHL parcel shipments to indicate if the parcel order only contains documents. bookingNumber: $ref: "#/components/schemas/bookingNumber" loadValues: type: object description: Values for the freight and/or trailer that will be used for an executed order. properties: equipmentLength: type: integer description: The desired length of trailer in feet. equipmentWidth: type: integer description: The desired width of trailer in inches. equipmentHeight: type: integer description: The desired height of trailer in inches. trailerNum: type: string description: The trailer number to be used for the freight. movementType: $ref: "#/components/schemas/movementTypeEnum" onlineParties: type: array description: Contains data which allows a third party visibility to an order belonging to their associated shipper via the Navisphere Online 2.0 product. items: type: object properties: partyType: type: string description: Represents the type of order party requesting visibility for the third party. enum: - "CUSTOMER" - "BILLTO" partyCode: type: string description: Represents the CHR customer code linked to the online/third party. relationshipIdentifier: type: string description: An identifier mutually recognized by all concerned parties interested in the progress of the shipment. shippingContainerValues: type: object description: Contains data about containers. properties: shippingContainers: $ref: "#/components/schemas/shippingContainers" shippingContainerItems: $ref: "#/components/schemas/shippingContainerItems" notes: type: string minimum: 1 maximum: 4000 description: Order level notes. orderCustomer: type: object description: Object containing customer information. required: - customerCode properties: customerCode: type: string minimum: 1 maximum: 50 description: C.H. Robinson defined customer code. **This will be provided by your C.H. Robinson rep**. contacts: type: array description: Contacts items: $ref: '#/components/schemas/contact' referenceNumbers: type: array description: Additional reference number objects pertaining to the customer object. items: $ref: '#/components/schemas/referenceNumber' orderBillTo: type: object description: Object containing bill to information. required: - customerCode - currencyCode properties: customerCode: type: string minimum: 1 maximum: 50 description: C.H. Robinson defined bill to customer code. **This will be provided by your C.H. Robinson rep**. charges: type: array description: Charges items: $ref: '#/components/schemas/charge' currencyCode: $ref: '#/components/schemas/currencyCodeEnum' freightTerms: $ref: '#/components/schemas/freightTermEnum' contacts: type: array description: Contacts items: $ref: '#/components/schemas/contact' referenceNumbers: type: array description: Additional reference number objects pertaining to this bill to object. items: $ref: '#/components/schemas/referenceNumber' contact: type: object description: Object containing contact information. required: - name - type - companyName - contactMethods properties: name: type: string minimum: 1 maximum: 200 description: Name of the contact. type: $ref: '#/components/schemas/contactTypeEnum' companyName: type: string minimum: 1 maximum: 100 description: Company name of the contact. contactMethods: type: array description: Contact Methods items: $ref: '#/components/schemas/contactMethod' contactMethod: type: object description: Object defining contact method. required: - method - value properties: method: $ref: '#/components/schemas/contactMethodEnum' value: type: string minimum: 1 maximum: 50 description: Actual content of contact information. charge: type: object description: Object relating to the charges for the order. required: - rate - rateCode properties: rate: type: number format: float description: Monetary amount of this rate type. rateCode: $ref: '#/components/schemas/rateCodeEnum' quantity: type: number format: float description: Quantity of the rate. Multiplying `rate` by `quantity` will give the total charge for this rate line item. default: 1 alternateDescription: type: string minimum: 1 maximum: 20 description: Description of the charge. orderService: type: object description: Object containing service information. required: - locations - items properties: dateCalculationRule: type: string description: "Selected promise date.\n\n* `promisedShipDate` - Identifies the pick up date as promised to customer. \n* `promisedDeliveryDate` - Identifies the delivery date as promised to customer." enum: - "promisedShipDate" - "promisedDeliveryDate" serviceLevel: $ref: '#/components/schemas/serviceLevelEnum' suggestedScac: type: string minimum: 1 maximum: 10 description: Indicates a specific carrier SCAC customer wishes to associate to the order. isCritical: type: boolean description: Indicates if the order is critical. isDangerous: type: boolean description: Indicates if the order contains dangerous item. isHot: type: boolean description: Indicates if the item is hot. isHighValue: type: boolean description: Indicates if the item is high value. isPartial: type: boolean description: Indicates if the item is partial. suggestedCarrierPartyCode: type: string minimum: 1 maximum: 25 description: C.H. Robinson identifier for a carrier customer wishes to associate to the order. routeCode: type: string description: Identifies the routing pattern needed to deliver this order. sellMode: $ref: '#/components/schemas/sellModeEnum' locations: type: array minimum: 2 maximum: 2 description: The locations on the order. items: $ref: '#/components/schemas/orderLocation' items: type: array description: The item(s) on the order. items: $ref: '#/components/schemas/orderItem' packages: type: array description: The package(s) on the order. items: $ref: '#/components/schemas/orderPackage' collectOnDelivered: type: array description: Collect on Deliver items: $ref: '#/components/schemas/collectOnDelivered' referenceNumbers: type: array description: Additional reference number objects pertaining to this service. items: $ref: '#/components/schemas/referenceNumber' isTeam: type: boolean description: Indicates if the order requires team service. incoTerms: $ref: '#/components/schemas/incoTermsEnum' incoTermsNamedLocation: type: string description: Name of Inco term location. customEquipmentType: type: string description: This field represents a custom value used to describe equipment. The list is specific to each customer and is coordinated with the C.H Robinson account team. Only agreed upon values will function properly in Navisphere®. It is the responsibility of the customer to supply correct values. This field is used primarily by TMC customers. Reach out to your TMC Representative for more information. parcelDeliveryServices: type: object description: Used to specify special delivery service options (these services may incur additional charges). properties: saturdayDelivery: type: boolean description: Used to indicate Saturday Delivery Service (this service may incur additional charges). deliveryConfirmation: type: string description: Used on specify if signature is required on delivery (this service may incur additional charges). enum: - "SignatureRequired" - "AdultSignatureRequired" - "NotRequired" orderLocation: type: object required: - type description: "Indicates the locations assigned to this service. All service objects only have two location objects. If you have multiple stops, they need to broken into single pick, single drop pairs, each under its own service object." properties: customerLocationId: type: string minimum: 1 maximum: 50 description: "Customer defined identifier associated to a specific location. \n\n### If C.H. Robinson maintains a list of the customer's location IDs, then customerLocationId can be provided in lieu of address information." type: type: string description: Indicates the type of stop. enum: - "origin" - "destination" name: type: string minimum: 1 maximum: 100 description: > Name of the location. If the address of the location is not in C.H. Robinson's system, it is mandatory to include the `name` parameter so C.H. Robinson can auto-create the location in our system on order create. address: $ref: '#/components/schemas/orderAddress' blindLocation: $ref: '#/components/schemas/blindLocation' openDateTime: type: string format: date-time description: ISO8601 UTC date-time of the earliest time carrier can arrive at the stop. closeDateTime: type: string format: date-time description: ISO8601 UTC date-time of the latest time carrier can arrive at the stop. arrivalDate: type: string format: date-time description: "ISO8601 UTC date-time that carrier has arrived. \n\n ### Would only ever be sent on an order update if customer received the information instead of C.H. Robinson." departureDate: type: string format: date-time description: "ISO8601 UTC date-time that carrier has departed. \n\n ### Would only ever be sent on an order update if customer received the information instead of C.H. Robinson." scheduledOpenDateTime: type: string format: date-time description: ISO8601 UTC date-time of the earliest recommended appointment time for your carrier. scheduledCloseDateTime: type: string format: date-time description: ISO8601 UTC date-time of the latest recommended appointment time for your carrier. readyAvailableDateTime: type: string format: date-time description: "ISO8601 UTC date-time when location is ready to receive the shipment. \n\n ### Would only be sent if the location type is destination." rsDateTime: type: string format: date-time description: "An ISO8601 UTC date-time when location is ready for shipment to be picked up.\n\n ### Would only be sent if the location type is origin." specialRequirement: $ref: '#/components/schemas/specialRequirementOrder' scalesRequired: type: boolean description: Indicates if order requires weighing at this location. hasDropTrailer: type: boolean description: Indicates if this location is drop trailer. loadingTypeCode: $ref: '#/components/schemas/loadingTypeEnum' specialInstructions: type: string minimum: 1 maximum: 500 description: Customer defined instructions for this location. contacts: type: array description: Contacts items: $ref: '#/components/schemas/contact' referenceNumbers: type: array description: Additional reference number objects pertaining to this location. items: $ref: '#/components/schemas/referenceNumber' isResidential: $ref: '#/components/schemas/isResidential' sequenceNumber: type: integer description: Drives sequence of multistop orders; 1-based (does not start with 0) orderAddress: type: object description: Object that contains address specific information. required: - address1 - city - stateProvinceCode - postalCode - country properties: address1: type: string minimum: 1 maximum: 200 description: Indicate address line one of the location. address2: type: string minimum: 1 maximum: 200 description: Indicate address line two of the location. address3: type: string minimum: 1 maximum: 200 description: Indicate address line three of the location. address4: type: string minimum: 1 maximum: 200 description: Indicate address line four of the location. city: type: string minimum: 1 maximum: 100 description: Indicate the city of the location. county: type: string minimum: 1 maximum: 100 description: Indicate the county of the location. lat: type: number format: float minimum: -90 maximum: 90 description: Indicate the latitude of the location. long: type: number format: float minimum: -180 maximum: 180 description: Indicate the longitude of the location stateProvinceCode: $ref: '#/components/schemas/stateProvinceCodeEnum' postalCode: type: string minimum: 1 maximum: 20 description: Indicate the postal code of the location, sometime refered to as the zip code. country: $ref: '#/components/schemas/countryCodeEnum' blindLocation: type: object description: "A \"blind shipment\" is a shipment, regardless of mode, in which the party paying the freight charges requests that either the actual \"shipper\" or actual \"consignee\" not be disclosed on the bill of lading or other shipping documentation in order to shield such party's identity from another party. This is the address that will be displayed on the Bill of Lading." properties: blindName: type: string description: Indicate name of blind location. blindAddress: type: string description: Indicate address of blind location. blindCity: type: string description: Indicate city of blind location. blindState: type: string description: indicate state of blind location. specialRequirementOrder: type: object properties: liftGate: type: boolean description: Indicates that a lift gate is needed. insidePickup: type: boolean description: Indicates that inside pickup is needed. **Only used on the origin/pick stop** insideDelivery: type: boolean description: Indicates that inside delivery is needed. **Only used on the destination/drop stop** residentialNonCommercial: type: boolean description: Indicates that a stop is residential non-commercial. limitedAccess: type: boolean description: Indicates that stop has limited access. tradeShoworConvention: type: boolean description: Indicates that stop is a trade show or convention. constructionSite: type: boolean description: Indicates that stop is a construction site. dropOffAtCarrierTerminal: type: boolean description: Indicates that customer will drop off at carrier terminal. **Only used on the origin/pick stop** pickupAtCarrierTerminal: type: boolean description: Indicates that customer will pickup at carrier terminal. **Only used on the destination/drop stop** appointmentNotification: type: boolean description: Indicates that stop has an appointment notification. **Only used on the destination/drop stop** sortAndSegregate: type: boolean description: Indicates that items will need to be sorted at stop. **Only used on the destination/drop stop** orderItem: required: - packagingType - quantity type: object properties: packagingType: $ref: '#/components/schemas/packageCodeEnum' itemId: type: integer description: Indicates the itemId. Distinct value by item that should only be used when sending shippingContainers, to link containers to their respective items. quantity: type: number format: float description: Quantity is the number of packagingType's. description: type: string minimum: 1 maximum: 200 description: Customer defined description of the item. productCode: type: string minimum: 1 maximum: 20 description: Customer defined code of the item. freightClass: $ref: '#/components/schemas/freightClassEnum' weight: type: number description: Total Weight of the line item. This represents to total weight of the all quantities. For example, if the indvidual weight of 1 quantity is 100 pounds, and the quantity of the line item is 2, then 200 is the value for this field. format: float weightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' packagingLength: type: number description: The length of the line item packaging. format: float packagingWidth: type: number description: The width of the line item packaging. format: float packagingHeight: type: number description: The height of the line item packaging. format: float packagingUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' relationships: $ref: '#/components/schemas/relationships' equipmentLength: type: number format: float description: Indicates the length of the equipment needed to transport the item. equipmentHeight: type: number format: float description: Indicates the height of the equipment needed to transport the item. equipmentWidth: type: number format: float description: Indicates the width of the equipment needed to transport the item. equipmentUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' totalTrailerFeetUsed: type: integer description: Total feet item(s) will utilize inside the trailer. itemEquipment: $ref: '#/components/schemas/itemEquipment' packagingVolume: type: number format: float description: Volume of the item. packagingVolumeUnitOfMeasure: $ref: '#/components/schemas/volumeUomEnum' insuranceValue: type: number format: float description: Customer specified declared value of the item. pallets: type: number format: float description: Identifies how many pallets for the item. palletSpaces: type: number format: float description: Indentifies how many pallet spaces the item will use in the cargo space. nationalMotorFreightClass: type: string minimum: 1 maximum: 50 description: "The National Motor Freight Traffic Association publishes the National Motor Freight Classification® (NMFC®), a standard that provides a comparison of commodities moving in commerce. The NMFC® is developed and maintained by the Commodity Classification Standards Board (CCSB)." hazardousProperties: $ref: '#/components/schemas/hazardousProperties' upcNumber: type: string minimum: 1 maximum: 50 description: Universal Product Code. The barcode consists of a five digit manufacturer number and a five digit product number. skuNumber: type: string minimum: 1 maximum: 50 description: Stock Keeping Unit. A number assigned to a product by a the customer. pluNumber: type: string minimum: 1 maximum: 50 description: Price Look-up Number. A system of numbers the customer uses that uniquely identifies bulk produce isStackable: type: boolean description: Parameter to indicate if item(s) can be stacked one on top of the other. isTemperatureSensitive: type: boolean description: Parameter to indicate if item(s) needs to be kept between specific temperatures. temperatureType: $ref: '#/components/schemas/temperatureSensitiveEnum' temperatureUnit: $ref: '#/components/schemas/temperatureUomEnum' requiredTemperatureHigh: type: number description: The highest temperature the item(s) can be. format: float requiredTemperatureLow: type: number description: The lowest temperature the item(s) can be. format: float notes: type: string minimum: 1 maximum: 4000 description: Allows customer to add notes about the item. referenceNumbers: type: array description: Additional reference number objects pertaining to this item. items: $ref: '#/components/schemas/referenceNumber' relationships: type: object description: Object to specify master and inner pack qantities. properties: innerPackQuantity: type: number format: float description: Indicates smallest unit that will be sold. innerPackUomCode: $ref: '#/components/schemas/packageCodeEnum' masterPackQuantity: type: number format: float description: Indicates quantity that contains total quantity of innerpack items. orderPackage: required: - packagingType type: object properties: packageType: $ref: '#/components/schemas/packageCodeEnum' parcelPackageType: $ref: '#/components/schemas/parcelPackageCodeEnum' weight: type: number description: Total weight of the package. format: float length: type: number description: The length of the package. format: float width: type: number description: The width of the package. format: float height: type: number description: The height of the package. format: float packageUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' volume: type: number format: float description: Volume of the package. packageVolumeUnitOfMeasure: $ref: '#/components/schemas/volumeUomEnum' weightLb: type: number description: Total weight of the package in standard pounds. format: float declaredValue: type: number format: float description: Insurance valuation of package. codAmount: type: number format: float description: Cash on deliver amount for the package. trackingNumber: type: string minimum: 1 maximum: 100 description: Tracking number assigned to package. notes: type: string minimum: 1 maximum: 100 description: A place for customer to put package level notes. itemEquipment: type: object description: Additional information as to the specific equipment needs. properties: itemEquipmentCode: $ref: '#/components/schemas/itemEquipmentTypeEnum' maxTrailerAge: type: integer description: Defines the how old a trailer can be to ship items. tarpTypeCode: $ref: '#/components/schemas/tarpTypeEnum' loadingTypeCode: $ref: '#/components/schemas/loadingTypeEnum' requiredStrapsCount: type: integer description: Indicates number of straps needed. requiredChainsCount: type: integer description: Indicates number of chains needed coilRacks: type: integer description: Indicates number of coil racks needed. locksBars: type: integer description: Indicates number of locks or bars needed. isOwOd: type: boolean description: Indicates overweight or over dimensional. safetyEquipmentRequired: type: boolean description: Indicates if safety equipment is required. hazardousProperties: type: object description: Object containing hazardous material information. required: - description properties: description: type: string minimum: 1 maximum: 500 description: Description of the hazardous material. technicalName: type: string minimum: 1 maximum: 50 description: Technical name of the hazardous material. unNumber: type: string minimum: 1 maximum: 10 description: 'Four-digit numbers that identify dangerous goods, hazardous substances and articles (such as explosives, flammable liquids, toxic substances, etc.) in the framework of international transport.' example: '2796' classCode: type: string minimum: 1 maximum: 10 description: Code for hazardous material in the framework of international transport. packagingGroup: $ref: '#/components/schemas/hazardousGroupEnum' emergencyPhone: type: string minimum: 1 maximum: 50 description: Emergency phone number. authCode: $ref: '#/components/schemas/hazmatCodeEnum' isPlacarded: type: boolean description: Does hazardous material have a placard. isReportableQuantity: type: boolean description: Hazardous material is defined as a reportable quantity. isPrimaryCommodity: type: boolean description: Is hazardous material considered a primary commodity. isNOSCommodity: type: boolean description: Is hazardous material considered a NOS commodity. flashpoint: type: number format: float description: Hazmat flash point is the minimum temperature at which a liquid gives off vapor within a test vessel in sufficient concentration to form an ignitable mixture with air near the surface of the liquid. flashpointTemperatureUnit: $ref: '#/components/schemas/temperatureUomEnum' isEnvironmentallyHazardous: type: boolean description: Is hazardous material considered environmentally hazardous. subsidiaryHazmatClasses: type: string minimum: 1 maximum: 50 description: Subsidiary Code for hazardous material in the framework of international transport. vesselStowageCategory: $ref: '#/components/schemas/vesselStowageCategoryEnum' specialProvisions: type: string minimum: 1 maximum: 50 description: Indicates the Special Provisions for Hazardous Materials. marinePollutantCategory: type: string description: Indicates the Marine Pollutant Category for Hazardous Materials. $ref: '#/components/schemas/marinePollutantCategory' enum: - "SevereMarinePollutant" - "MarinePollutant" emergencyResponseGuidePage: type: string minimum: 1 maximum: 50 description: Indicates the Emergency Response Guidebook Page for first responders during the initial Phase of Hazardous Materials Transportation Incident. passengerLimitation: type: string minimum: 1 maximum: 50 description: Indicates the passenger limitation for Hazardous Materials. cargoAircraftLimitation: type: string minimum: 1 maximum: 50 description: Indicates the Cargo Aircraft Limitation for Hazardous Materials. exemptionNotes: type: string minimum: 1 maximum: 4000 description: Indicates the exemption notes for Hazardous Materials. ordersEventsHazardousProperties: type: object description: Object containing hazardous material information. required: - description properties: description: type: string minimum: 1 maximum: 500 description: Description of the hazardous material. technicalName: type: string minimum: 1 maximum: 50 description: Technical name of the hazardous material. unNumber: type: string minimum: 1 maximum: 10 description: 'Four-digit numbers that identify dangerous goods, hazardous substances and articles (such as explosives, flammable liquids, toxic substances, etc.) in the framework of international transport.' example: '2796' classCode: type: string minimum: 1 maximum: 10 description: Code for hazardous material in the framework of international transport. packagingGroup: $ref: '#/components/schemas/hazardousGroupEnum' emergencyPhone: type: string minimum: 1 maximum: 50 description: Emergency phone number. authCode: $ref: '#/components/schemas/hazmatCodeEnum' isPlacarded: type: boolean description: Does hazardous material have a placard. isReportableQuantity: type: boolean description: Hazardous material is defined as a reportable quantity. isPrimaryCommodity: type: boolean description: Is hazardous material considered a primary commodity. isNOSCommodity: type: boolean description: Is hazardous material considered a NOS commodity. flashpoint: type: number format: float description: Hazmat flash point is the minimum temperature at which a liquid gives off vapor within a test vessel in sufficient concentration to form an ignitable mixture with air near the surface of the liquid. flashpointTemperatureUnitOfMeasure: type: string description: "Unit of measure for temperature parameters." enum: - "Fahrenheit" - "Celsius" isEnvironmentallyHazardous: type: boolean description: Is hazardous material considered environmentally hazardous. subsidiaryHazmatClasses: type: string minimum: 1 maximum: 50 description: Subsidiary Code for hazardous material in the framework of international transport. vesselStowageCategory: $ref: '#/components/schemas/vesselStowageCategoryEnum' specialProvisions: type: string minimum: 1 maximum: 50 description: Indicates the Special Provisions for Hazardous Materials. marinePollutantCategory: type: string description: Indicates the Marine Pollutant Category for Hazardous Materials. $ref: '#/components/schemas/marinePollutantCategory' enum: - "SevereMarinePollutant" - "MarinePollutant" emergencyResponseGuidePage: type: string minimum: 1 maximum: 50 description: Indicates the Emergency Response Guidebook Page for first responders during the initial Phase of Hazardous Materials Transportation Incident. passengerLimitation: type: string minimum: 1 maximum: 50 description: Indicates the passenger limitation for Hazardous Materials. cargoAircraftLimitation: type: string minimum: 1 maximum: 50 description: Indicates the Cargo Aircraft Limitation for Hazardous Materials. exemptionNotes: type: string minimum: 1 maximum: 4000 description: Indicates the exemption notes for Hazardous Materials. additionalLocation: type: object description: List of additional Locations for Ocean/Air transport Mode. required: - additionalLocationType. properties: additionalLocationType: $ref: '#/components/schemas/additionalLocationTypeEnum' customerAPILocationNumber: type: string minimum: 1 maximum: 80 description: Customer defined identifier associated to a specific location. If C.H. Robinson maintains a list of the customer's location IDs, then customerLocationId can be provided in lieu of address information. locationName: type: string minimum: 1 maximum: 200 description: Name of the location. address1: type: string minimum: 1 maximum: 200 description: Indicate address line one of the location. address2: type: string minimum: 1 maximum: 200 description: Indicate address line two of the location. address3: type: string minimum: 1 maximum: 200 description: Indicate address line three of the location. address4: type: string minimum: 1 maximum: 200 description: Indicate address line four of the location. city: type: string minimum: 1 maximum: 100 description: Indicate the city of the location. county: type: string minimum: 1 maximum: 100 description: Indicate the county of the location. lat: type: number format: float minimum: -90 maximum: 90 description: Indicate the latitude of the location. long: type: number format: float minimum: -180 maximum: 180 description: Indicate the longitude of the location stateProvinceCode: $ref: '#/components/schemas/stateProvinceCodeEnum' postalCode: type: string minimum: 1 maximum: 20 description: Indicate the postal code of the location, sometime refered to as the zip code. country: $ref: '#/components/schemas/countryCodeEnum' shippingContainers: type: object required: - containerId properties: containerId: type: integer description: ID of the container. containerType: $ref: '#/components/schemas/shipmentContainerTypeEnum' containerStatus: type: string description: Indicates the container status. enum: - "Booking Confirmed" - "Arrived Pick Up Location" - "Departed Pick Up Location" - "In-Gate" - "Rail Departure" - "Loaded On Vessel" - "Vessel Arrived" - "Vessel Departed" - "Unloaded from Vessel" - "Out Gate" - "Loaded on Rail" - "Rail Arrived at Destination" - "Arrived at Delivery Location" - "Unloaded at Delivery Location" - "Ordered" - "Wheels Up" - "Wheels Down" declaredValue: type: number format: currency description: Indicates the container declared value. weightNet: type: number format: float description: indicates the container net weight. weightGross: type: number format: float description: Indicates the container gross weight. vgm: type: number format: float description: VGM sealNum: type: string description: Indicates the container seal number. containerNumber: type: string description: Indicates the container number. weightUnit: $ref: '#/components/schemas/weightUomEnum' currency: $ref: '#/components/schemas/currencyCodeEnum' referenceNumbers: $ref: '#/components/schemas/referenceNumber' shippingContainerItems: type: object required: - containerId - itemId properties: containerId: type: integer description: ID of the container. itemId: type: integer description: Indicates the item ID. transportSpecs: type: object required: - sequenceNumber properties: sequenceNumber: type: integer description: Indicates the sequence number of the transport specification. name: type: string description: Indicates the transport specification name. type: type: string description: Indicates the transport specification type. enum: - "Ocean" - "Air" - "Intermodal" - "Agnostic" transportationNumber: type: string description: Indicates the number of the transport specification. confirmationNumber: type: string description: Indicates the name of the transport specification. voyageId: type: string description: Indicates the id of the voyage. portOfLoading: type: string description: Indicates the name of the port of loading. portOfDischarge: type: string description: Indicates the name of the port of discharge. labelReferenceData1: type: string description: First piece of reference data to be used on the package label. This is used as the customer/shipper reference number on the label for FedEx, UPS, DHL, and TNT. minLength: 1 maxLength: 35 labelReferenceData2: type: string description: Second piece of reference data to be used on the package label. This is used as the PO Number for FedEx or Reference Number 2 for UPS (not used for DHL or TNT). minLength: 1 maxLength: 35 labelReferenceData3: type: string description: Third piece of reference data to be used on the package label. This is used as the Invoice Number for FedEx (not used for UPS, DHL, or TNT). minLength: 1 maxLength: 35 dutyPayerAccountNumber: type: string description: Account number of the party paying the duty charges; Required for a dutyPayerType of Third_Party or if C.H. Robinson does not have the billing account to use on file. exportReasonCode: type: string description: A value required for DHL international shipments indicating why the shipment is being exported. enum: - "Permanent" - "Temporary" - "Re_Export" AESTransactionNumber: type: string description: AES ITN may be required if shipping internationally from the US and the value is over 2,500.00 USD; must be exactly 14 digits and prefixed with X. bookingNumber: type: string description: The booking number for FedEx heavy air shipments. isResidential: type: boolean description: A flag indicating whether or not this is a residential location. Used ONLY FOR PARCEL Shipments. For FedEx, FedEx_Ground_Home_Delivery or Fedex_Home_Delivery must be used if the destination is residential. collectOnDelivered: type: object description: Information relating to payment. required: - amount - paymentType - payableTo - mailTo - address properties: amount: type: number description: The currency amount to be paid. format: float paymentType: type: string minimum: 1 maximum: 25 description: Method of payment. payableTo: type: string minimum: 1 maximum: 50 description: Individual or entity receiving payment. mailTo: type: string minimum: 1 maximum: 50 description: Individual or entity payment is mailed to. address: $ref: '#/components/schemas/orderAddress' referenceNumbers: type: array description: Additional reference number objects pertaining to this service. items: $ref: '#/components/schemas/referenceNumber' quoteBillTo: type: object description: Object containing bill to information. properties: currencyCode: $ref: '#/components/schemas/currencyCodeEnum' contacts: type: array description: Contacts items: $ref: '#/components/schemas/contact' referenceNumbers: type: array description: Additional reference number objects pertaining to this bill to object. items: $ref: '#/components/schemas/referenceNumber' quoteLocation: type: object description: Object containing quote location information. properties: customerLocationId: type: string description: Customer specified ID for the location. locationName: type: string description: Name of the location. deprecated: true name: type: string description: Name of the location. address: $ref: '#/components/schemas/orderAddress' phone: type: string description: Phone number associated to quote location. emailAddress: type: string description: E-mail address associated to quote location. contactName: type: string description: Contact name associated to quote location. requestedShipDateOpen: type: string format: date-time description: An ISO8601 UTC date-time of the earliest time carrier can arrive at the location. deprecated: true openDateTime: type: string format: date-time description: An ISO8601 UTC date-time of the earliest time carrier can arrive at the location. requestedShipDateClose: type: string format: date-time description: An ISO8601 UTC date-time of the latest time carrier can arrive at the location. deprecated: true closeDateTime: type: string format: date-time description: An ISO8601 UTC date-time of the latest time carrier can arrive at the location. specialInstructions: type: string description: A place for customer to put location specific instructions. referenceNumbers: type: array description: Additional reference number objects pertaining to this location. items: $ref: '#/components/schemas/referenceNumber' quoteService: type: object description: Object containing quote service information. properties: referenceNumbers: type: array description: Additional reference number objects pertaining to this service. items: $ref: '#/components/schemas/referenceNumber' suggestedScac: type: string minimum: 1 maximum: 10 description: Indicates a specific carrier SCAC customer wishes to associate to the order. suggestedCarrierPartyCode: type: string minimum: 1 maximum: 25 description: C.H. Robinson identifier for a carrier customer wishes to associate to the order. isHot: type: boolean description: Indicates if the item is hot. quotes: type: array minimum: 1 items: $ref: '#/components/schemas/quote' quote: type: object description: Object containing information for quote order. required: - quoteId properties: quoteId: type: integer format: int64 description: Quote ID that was received from the rating API call. customer: $ref: '#/components/schemas/orderCustomer' billTo: $ref: '#/components/schemas/quoteBillTo' service: $ref: '#/components/schemas/quoteService' origin: $ref: '#/components/schemas/quoteLocation' destination: $ref: '#/components/schemas/quoteLocation' onlineParties: type: array description: Contains data which allows a third party visibility to an order belonging to their associated shipper via the Navisphere Online 2.0 product. items: type: object properties: partyType: type: string description: Represents the type of order party requesting visibility for the third party. enum: - "CUSTOMER" - "BILLTO" partyCode: type: string description: Represents the CHR customer code linked to the online/third party. relationshipIdentifier: type: string description: An identifier mutually recognized by all concerned parties interested in the progress of the shipment. notes: type: string minimum: 1 maximum: 4000 description: A place for customer to put quote order level notes. referenceNumbers: type: array description: Additional reference number objects pertaining to the order. items: $ref: '#/components/schemas/referenceNumber' orderResponse: type: object description: Object containg the order response. properties: orderNumber: type: string description: C.H. Robinson order number that was created. example: "81134516" quoteOrderResponse: type: object description: Object containing the quote order response. properties: quoteId: type: integer format: int64 description: ID that was used to submit the order using the quote route. orderNumber: type: integer description: C.H. Robinson order number that was created. trackingNumber: type: string description: C.H. Robinson online number that was associated to the order. orderNumber: type: object properties: orderNumber: type: integer description: C.H. Robinson defined order number. #---Events--------------------------------------------------------------------------------------------- eventResponseV1: type: object description: Object containing the search event response. properties: time: type: string format: date-time description: The date/time in ISO8601 format when the event was written to the Enterprise API database. customerReferenceNumbers: type: string description: Primary customer reference number. billToReferenceNumbers: type: string description: Primary customer bill to reference number. Often the customer's order number. customer: type: string description: C.H. Robinson defined customer identifier. eventTime: type: string format: date-time description: The date/time in ISO8601 format when the event was reported to have occured. eventType: type: string description: C.H. Robinson defined event type. enum: - "APPOINTMENT UPDATED" - "ORDER CREATED" - "ORDER UPDATED" - "ORDER CANCELED" - "LOAD BOOKED" - "CARRIER ARRIVED" - "CARRIER DEPARTED" - "LOAD PICKED UP" - "LOAD DELIVERED" - "IN TRANSIT" - "IN TRANSIT TO ORIGIN" loadNumber: type: string description: C.H. Robinson defined shipment number. orderNumbers: type: string description: C.H. Robinson defined order number(s). payload: type: string description: C.H. Robinson event payload. Contains detailed event information. eventResponses: type: object properties: totalCount: type: integer description: Total number of events available for search criteria. results: type: array description: Contains all events based on parameter search criteria. items: $ref: '#/components/schemas/eventResponse' eventResponse: type: object description: Contains the response JSON from GET call. properties: time: type: string format: date-time description: The date/time in ISO8601 UTC format when the event was written to the Enterprise API database. customer: type: string description: C.H. Robinson defined customer code. eventTime: type: string format: date-time description: The date/time in ISO8601 UTC format when the event was reported to have occured. customerReferenceNumber: type: string description: Primary customer reference number. billToReferenceNumber: type: string description: Primary customer bill to reference number. Often the customer's order number. event: type: object description: C.H. Robinson defined event type. oneOf: - $ref: '#/components/schemas/orderEvent' - $ref: '#/components/schemas/loadEvent' - $ref: '#/components/schemas/stopEvent' - $ref: '#/components/schemas/appointmentEvent' - $ref: '#/components/schemas/inTransitEvent' - $ref: '#/components/schemas/packageInTransitEvent' - $ref: '#/components/schemas/packageStopEvent' - $ref: '#/components/schemas/globalForwardingShipmentEvent' - $ref: '#/components/schemas/trackingNumberEvent' globalForwardingDateNullableChangableValue: &globalForwardingDateNullableChangableValue type: object nullable: false properties: currentValue: type: string nullable: true format: date previousValue: type: string nullable: true format: date hasChanged: type: boolean nullable: false readOnly: true globalForwardingDateTimeOffsetNullableChangableValue: &globalForwardingDateTimeOffsetNullableChangableValue type: object nullable: false properties: currentValue: type: string nullable: true format: date-time previousValue: type: string nullable: true format: date-time hasChanged: type: boolean nullable: false readOnly: true globalForwardingParty: &globalForwardingParty type: object properties: name: description: The name of this entity. type: string nullable: false globalForwardingVolume: &globalForwardingVolume type: object properties: cubicMeters: type: number format: decimal cubicFeet: type: number format: decimal globalForwardingWeight: &globalForwardingWeight type: object nullable: false properties: kilograms: type: number format: decimal pounds: type: number format: decimal globalForwardingShipmentEvent: type: object description: Represents a Global Forwarding shipment event. properties: eventType: description: The type of event that occurred on the shipment. oneOf: - $ref: '#/components/schemas/globalForwardingEventTypeEnum' - $ref: '#/components/schemas/globalForwardingUnknownEventTypeValue' shipmentNumber: description: A unique identifier for this shipment. This value is generated by CHR. type: string nullable: false agentReferenceNumber: description: A unique identifier for this shipment. This value is supplied to CHR by the agent. type: string nullable: true customerReferenceNumber: description: A unique identifier for this shipment. This value is supplied to CHR by the customer. type: string nullable: true shipmentType: description: The type of shipment. oneOf: - $ref: '#/components/schemas/globalForwardingShipmentTypeEnum' - $ref: '#/components/schemas/globalForwardingUnknownShipmentTypeValue' purchaseOrderNumbers: description: Purchase order numbers associated with the shipment. type: array nullable: false uniqueItems: true items: type: string servicesProvidedByChr: description: > The services provided by CHR for this shipment. For example, CHR may only provide Freight Forwarding services (in which case, this array would have only one elemnt). CHR may also provide Customs Brokerage services in addition (in which case, this array would have two elements -- one for each service). type: array items: oneOf: - $ref: '#/components/schemas/globalForwardingChrServiceEnum' - $ref: '#/components/schemas/globalForwardingUnknownChrServiceValue' serviceLevel: description: > The extent of service provided by CHR for this shipment. For example, CHR may be responsible for the entire shipment from origin warehouse to the destination warehouse, or only from the origin port to the destination port. oneOf: - $ref: '#/components/schemas/globalForwardingServiceLevelEnum' - $ref: '#/components/schemas/globalForwardingUnknownServiceLevelValue' mode: description: The mode of transportation for the shipment. oneOf: - $ref: '#/components/schemas/globalForwardingModeEnum' - $ref: '#/components/schemas/globalForwardingUnknownModeValue' status: description: The current status of the shipment. oneOf: - $ref: '#/components/schemas/globalForwardingShipmentStatusEnum' - $ref: '#/components/schemas/globalForwardingUnknownShipmentStatusValue' incoLocation: description: The location where the IncoTerms apply. type: string incoTerms: description: The International Commercial Terms (IncoTerms) that apply to the shipment. oneOf: - $ref: '#/components/schemas/globalForwardingIncoTermsEnum' - $ref: '#/components/schemas/globalForwardingUnknownIncoTermsValue' freightTerms: description: The freight terms that apply to the shipment. oneOf: - $ref: '#/components/schemas/globalForwardingFreightTermsEnum' - $ref: '#/components/schemas/globalForwardingUnknownFreightTermsValue' customer: description: The customer that requested this shipment. <<: *globalForwardingParty shipper: description: The shipper CHR has contracted with to transport the shipment. <<: *globalForwardingParty consignee: description: The consignee that will receive the shipment. <<: *globalForwardingParty oceanShipment: $ref: '#/components/schemas/globalForwardingOceanShipment' airShipment: $ref: '#/components/schemas/globalForwardingAirShipment' shipmentCreatedDate: description: The date-time that the shipment was created. type: string nullable: false format: date-time estimatedCargoReadyDate: description: > The date that the supplier estimates the cargo will be ready for pickup. The date is in the pick-up location's local time zone. <<: *globalForwardingDateNullableChangableValue estimatedDeliverByDate: description: > The estimated date by which CHR estimates the shipment will be delivered. The date is in the drop off location's local time zone. <<: *globalForwardingDateNullableChangableValue customsEntry: $ref: '#/components/schemas/globalForwardingCustomsEntry' customs: $ref: '#/components/schemas/globalForwardingCustoms' globalForwardingEventTypeEnum: &globalForwardingEventTypeEnum type: string nullable: false description: > The "type" of event for the shipment. If you specify this value in your API request for events, CHR will perform server-side filtering and you will only receive the events you are interested in. enum: # Generic events - SHIPMENT CREATED - SHIPMENT BOOKED - SHIPMENT CANCELLED - CONTAINER CREATED - CONTAINER CANCELLED - CONTAINER UPDATED # Estimated dates - SHIPMENT ESTIMATED DELIVERY DATE CHANGED - ESTIMATED DELIVERY DATE CHANGED - ESTIMATED TIME OF VESSEL DEPARTURE CHANGED - ESTIMATED TIME OF VESSEL ARRIVAL CHANGED - ESTIMATED TIME OF VESSEL ARRIVAL/DEPARTURE CHANGED - ESTIMATED TIME OF FLIGHT DEPARTURE CHANGED - ESTIMATED TIME OF FLIGHT ARRIVAL CHANGED - ESTIMATED TIME OF FLIGHT ARRIVAL/DEPARTURE CHANGED - ESTIMATED ARRIVAL TO DESTINATION RAIL CHANGED # Pickup location - ARRIVED AT PICKUP - CARGO PICKED UP # Origin ramp - ARRIVED AT ORIGIN RAMP - DEPARTED FROM ORIGIN RAMP # Origin terminal - ARRIVED AT ORIGIN TERMINAL - DEPARTED FROM ORIGIN TERMINAL # Origin port/airport - IN GATE AT ORIGIN PORT - VESSEL DEPARTED FROM ORIGIN PORT - FLIGHT DEPARTED FROM ORIGIN AIRPORT # Intermediary port/airport - VESSEL ARRIVED AT INTERMEDIARY PORT - FLIGHT ARRIVED AT INTERMEDIARY AIRPORT - VESSEL DEPARTED FROM INTERMEDIARY PORT - FLIGHT DEPARTED FROM INTERMEDIARY AIRPORT # Destination port/airport - VESSEL ARRIVED AT DESTINATION PORT - FLIGHT ARRIVED AT DESTINATION AIRPORT - OUT GATE FROM DESTINATION PORT - DEPARTED FROM DESTINATION AIRPORT # Destination terminal - ARRIVED AT DESTINATION TERMINAL - DEPARTED FROM DESTINATION TERMINAL # Destination ramp - ARRIVED AT DESTINATION RAMP - DEPARTED FROM DESTINATION RAMP # Drop warehouse - ARRIVED AT FINAL DESTINATION - CARGO DELIVERED # Destination port/airport - EMPTY CONTAINER RETURNED # Customs - CUSTOMS PENDING - CUSTOMS CANCELLED - CUSTOMS NOT RELEASED - CUSTOMS INTENSIVE EXAM - CUSTOMS ADMISSIBLE - CUSTOMS DOCUMENT REQUIRED - CUSTOMS REQUIRES BROKER REVIEW - PGA RELEASED - CUSTOMS RELEASED # Catch-all - SHIPMENT UPDATED globalForwardingUnknownEventTypeValue: description: > This represents a new event type that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingEventTypeEnum globalForwardingShipmentTypeEnum: &globalForwardingShipmentTypeEnum type: string nullable: false enum: - FCL - LCL globalForwardingUnknownShipmentTypeValue: description: > This represents a new shipment type that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingShipmentTypeEnum globalForwardingChrServiceEnum: &globalForwardingChrServiceEnum type: string nullable: false enum: - Non-Vessel Operating Common Carrier - Freight Forwarding - Air Direct - Air House - Air Sub House - Air Sub Master - Customs Brokerage - Service Fin Only globalForwardingUnknownChrServiceValue: description: > This represents a new service level that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingChrServiceEnum globalForwardingServiceLevelEnum: &globalForwardingServiceLevelEnum type: string nullable: false enum: - Door to Door - Port to Port - Door to Destination Port - Door to Destination Ramp - Door to Destination Terminal - Origin Port to Door - Origin Port to Destination Ramp - Origin Port to Destination Terminal - Origin Ramp to Door - Origin Ramp to Destination Port - Origin Ramp to Destination Ramp - Origin Terminal to Destination Port - Origin Terminal to Door - Origin Terminal to Destination Terminal - Origin Ramp to Destination Terminal - Origin Terminal to Destination Ramp - Door to Destination Airport - Origin Airport To Door - Origin Airport To Destination Airport - Origin Airport To Destination Terminal - Origin Terminal To Destination Airport globalForwardingUnknownServiceLevelValue: description: > This represents a new service level that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingServiceLevelEnum globalForwardingModeEnum: &globalForwardingModeEnum type: string nullable: false enum: - Ocean - Air globalForwardingUnknownModeValue: description: > This represents a new mode that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingModeEnum globalForwardingShipmentStatusEnum: &globalForwardingShipmentStatusEnum type: string nullable: false enum: - Financial Only - Ordered - Consolidated - Assigned to Rep - Tendered to Carrier - Booked - Carrier Directed - Checked In - Waybilled to Railroad - Booking Completed - Loading - Arrived at Terminal - Ready for Departure - Picked Up - Departed from Terminal - On the Rail - Departed Port or Airport - Arrived at Port or Airport - In Transit - Arrived at Ramp - Rail Completed - Port or Airport Completed - Terminal Completed - Unloading - Carrier Released - Delivered globalForwardingUnknownShipmentStatusValue: description: > This represents a new shipment status that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingShipmentStatusEnum globalForwardingIncoTermsEnum: &globalForwardingIncoTermsEnum type: string nullable: true enum: - Ex-Works - Free Carrier - Free Alongside Ship - Free On-Board Vessel - Cost & Freight - Cost Insurance & Freight - Carriage Paid To - Carriage & Insurance Paid To - Delivery At Frontier - Delivered Ex-Ship - Delivered Ex-Quay, Duty Unpaid - Delivered Duty Unpaid - Delivered Duty Paid - Delivered at Place - Delivered at Terminal - Delivered at Place Unloaded globalForwardingUnknownIncoTermsValue: description: > This represents a new INCO terms value that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingIncoTermsEnum globalForwardingFreightTermsEnum: &globalForwardingPrepaidCollectEnum description: > * Prepaid: The shipper pays for the freight charges. * Collect: The customer/consignee pays for the freight charges. type: string nullable: true enum: - Prepaid - Collect globalForwardingUnknownFreightTermsValue: description: > This represents a new freight terms value that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingPrepaidCollectEnum globalForwardingAirShipment: description: > When this shipment is an air shipment, this object will contain air shipment details. type: object nullable: true properties: houseAirwayBillNumber: description: The number of the House Airway Bill (HAWB) issued by the forwarder. type: string nullable: true masterAirwayBillNumber: description: The number of the Master Airway Bill (MAWB) issued by the carrier. type: string nullable: true airMainlineCarrier: $ref: '#/components/schemas/globalForwardingAirMainlineCarrier' stops: description: > The stops that the shipment will make during its journey. The stops are in first-to-last order. type: array nullable: false uniqueItems: true items: $ref: '#/components/schemas/globalForwardingStop' estimatedFlightDepartureFromOriginAirport: description: The estimated date-time that the flight will depart from the origin airport. <<: *globalForwardingDateTimeOffsetNullableChangableValue actualFlightDepartureFromOriginAirport: description: The actual date-time that the flight departed from the origin airport. <<: *globalForwardingDateTimeOffsetNullableChangableValue estimatedFlightArrivalAtDestinationAirport: description: The estimated date-time that the flight will arrive at the destination airport. <<: *globalForwardingDateTimeOffsetNullableChangableValue actualFlightArrivalAtDestinationAirport: description: The actual date-time that the flight arrived at the destination airport. <<: *globalForwardingDateTimeOffsetNullableChangableValue requestedPickupDate: description: The date-time that the customer requested the shipment be picked up from the pick-up location. <<: *globalForwardingDateTimeOffsetNullableChangableValue estimatedPickupDate: description: The date-time that CHR estimates that the shipment will be picked up by the carrier. <<: *globalForwardingDateTimeOffsetNullableChangableValue actualPickupDate: description: The actual date-time that the shipment was be picked up by the carrier. <<: *globalForwardingDateTimeOffsetNullableChangableValue requestedDeliveryDate: description: The date-time that the customer requested the shipment be delivered to the drop-off location. <<: *globalForwardingDateTimeOffsetNullableChangableValue estimatedDeliveryDate: description: The date-time that CHR estimates that the shipment will be delivered to the drop-off location. <<: *globalForwardingDateTimeOffsetNullableChangableValue actualDeliveryDate: description: The actual date-time that the shipment was delivered to the drop-off location. <<: *globalForwardingDateTimeOffsetNullableChangableValue innerPacks: description: Aggregated inner pack quantities of all items. type: array nullable: false uniqueItems: true items: $ref: '#/components/schemas/globalForwardingQuantity' outerPacks: description: Aggregated outer pack quantities of all items. type: array nullable: false uniqueItems: true items: $ref: '#/components/schemas/globalForwardingQuantity' totalWeight: description: The total weight of all items. <<: *globalForwardingWeight nullable: true chargeableWeight: description: The total chargeable weight of all items. <<: *globalForwardingWeight nullable: true totalVolume: description: The total volume of all items. <<: *globalForwardingVolume nullable: true globalForwardingAirMainlineCarrier: description: The mainline carrier that transports the shipment over air. type: object nullable: true properties: carrierName: description: The name of the airline carrier. type: string nullable: true carrierScac: description: The SCAC code of the airline carrier. type: string nullable: true bookingNumber: description: A unique identifier for the booking. type: string nullable: true flights: description: An ordered list of flights that are used to transport the shipment. type: array nullable: false uniqueItems: true items: $ref: '#/components/schemas/globalForwardingFlight' globalForwardingFlight: description: A flight that is used to transport the shipment. type: object nullable: true properties: flightNumber: description: The number of the flight. type: string nullable: true sequence: description: The order of the flight in the list of flights. type: integer nullable: false fromAirport: $ref: '#/components/schemas/globalForwardingFromAirport' toAirport: $ref: '#/components/schemas/globalForwardingToAirport' globalForwardingFromAirport: allOf: - $ref: '#/components/schemas/globalForwardingLocation' - type: object description: The airport that the flight departs from. nullable: true properties: estimatedDepartureDate: description: The estimated date-time that the flight will depart from the airport. <<: *globalForwardingDateTimeOffsetNullableChangableValue actualDepartureDate: description: The actual date-time that the flight departed from the airport. <<: *globalForwardingDateTimeOffsetNullableChangableValue globalForwardingToAirport: allOf: - $ref: '#/components/schemas/globalForwardingLocation' - type: object description: The airport that the flight arrives at. nullable: true properties: estimatedArrivalDate: description: The estimated date-time that the flight will arrive at the airport. <<: *globalForwardingDateTimeOffsetNullableChangableValue actualArrivalDate: description: The actual date-time that the flight arrived at the airport. <<: *globalForwardingDateTimeOffsetNullableChangableValue globalForwardingOceanShipment: description: > When this shipment is an ocean shipment, this object will contain ocean shipment details. type: object nullable: true properties: houseBillNumber: description: The number of the House Bill of Lading (HBL) issued by the NVOCC. type: string nullable: true masterBillNumber: description: The number of the Master Bill of Lading (MBL) issued by the carrier. type: string nullable: true oceanMainlineCarrier: $ref: '#/components/schemas/globalForwardingOceanMainlineCarrier' containers: description: A list of containers transported by the shipment. type: array nullable: false uniqueItems: true items: $ref: '#/components/schemas/globalForwardingContainer' estimatedVesselDepartureDate: description: The estimated date-time that the vessel will depart from the origin port. <<: *globalForwardingDateTimeOffsetNullableChangableValue actualVesselDepartureDate: description: The actual date-time that the vessel departed from the origin port. <<: *globalForwardingDateTimeOffsetNullableChangableValue estimatedVesselArrivalDate: description: The estimated date-time that the vessel will arrive at the destination port. <<: *globalForwardingDateTimeOffsetNullableChangableValue actualVesselArrivalDate: description: The actual date-time that the vessel arrived at the destination port. <<: *globalForwardingDateTimeOffsetNullableChangableValue globalForwardingOceanMainlineCarrier: description: The mainline carrier that transports the shipment over the ocean. type: object nullable: true properties: carrierName: description: The name of the mainline carrier. type: string nullable: true carrierScac: description: The SCAC code of the mainline carrier. type: string nullable: true vesselImo: description: The International Maritime Organization (IMO) number of the vessel. type: string nullable: true vesselName: description: The name of the vessel. type: string nullable: true voyageNumber: description: A unique identifier for the voyage. type: string nullable: true bookingNumber: description: A unique identifier for the booking. type: string nullable: true globalForwardingContainer: type: object properties: isAffectedByEvent: description: '`true` if the change identicated by the eventType property on the event corresponds to this container.' type: boolean nullable: false containerNumber: description: The number of the container. This should be unique within the shipment. type: string nullable: true containerType: description: The type of the container. oneOf: - $ref: '#/components/schemas/globalForwardingContainerTypeEnum' - $ref: '#/components/schemas/globalForwardingUnknownContainerTypeValue' innerPacks: description: Aggregated inner pack quantities of all items in the container. type: array nullable: false uniqueItems: true items: $ref: '#/components/schemas/globalForwardingQuantity' outerPacks: description: Aggregated outer pack quantities of all items in the container. type: array nullable: false uniqueItems: true items: $ref: '#/components/schemas/globalForwardingQuantity' purchaseOrderNumbers: description: The Purchase Order (PO) numbers associated with the items within the container. type: array nullable: false uniqueItems: true items: type: string sealNumber: description: The seal number of the container. type: string nullable: true totalGrossWeight: description: The total gross weight of the container. <<: *globalForwardingWeight nullable: true totalNetWeight: description: The total net weight of the container. <<: *globalForwardingWeight nullable: true totalVolume: description: The total volume of the container. <<: *globalForwardingVolume nullable: true stops: description: > The stops that the container will make during its journey. The stops are in first-to-last order. type: array nullable: false uniqueItems: true items: $ref: '#/components/schemas/globalForwardingStop' requestedPickupDate: description: The date-time that the customer requested the container be picked up from the pick-up location. <<: *globalForwardingDateTimeOffsetNullableChangableValue requestedDeliveryDate: description: The date-time that the customer requested the container be delivered to the drop-off location. <<: *globalForwardingDateTimeOffsetNullableChangableValue estimatedPickupDate: description: The date-time that CHR estimates that the container will be picked up by the carrier. <<: *globalForwardingDateTimeOffsetNullableChangableValue estimatedDeliveryDate: description: The date-time that CHR estimates that the container will be delivered to the drop-off location. <<: *globalForwardingDateTimeOffsetNullableChangableValue actualPickupDate: description: The actual date-time that the container was be picked up by the carrier. <<: *globalForwardingDateTimeOffsetNullableChangableValue lastFreeDay: description: The last day that the container can reside at the destination port without incurring demurrage fees. <<: *globalForwardingDateTimeOffsetNullableChangableValue actualDeliveryDate: description: The actual date-time that the container was delivered to the drop-off location. <<: *globalForwardingDateTimeOffsetNullableChangableValue lastFreeDayForEmptyReturn: description: The last day that the empty container can be returned to the destination port without incurring demurrage fees. <<: *globalForwardingDateTimeOffsetNullableChangableValue emptyPickupDate: description: The date-time that the empty container was picked up from the drop-off location. <<: *globalForwardingDateTimeOffsetNullableChangableValue emptyReturnDate: description: The date-time that the empty container was returned to the destination port. <<: *globalForwardingDateTimeOffsetNullableChangableValue globalForwardingContainerTypeEnum: &globalForwardingContainerTypeEnum type: string nullable: true enum: - 20FR - 20FT - 20IT - 20OT - 20RF - 40FR - 40FT - 40HC - 40OT - 40RF - 40RH - 45HC - 45TR - 48TR - 53TR globalForwardingUnknownContainerTypeValue: description: > This represents a new container type that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingContainerTypeEnum globalForwardingQuantity: type: object properties: value: type: number format: decimal unitOfMeasure: description: The unit of measure for the quantity. oneOf: - $ref: '#/components/schemas/globalForwardingUnitOfMeasureEnum' - $ref: '#/components/schemas/globalForwardingUnknownUnitOfMeasureValue' globalForwardingUnitOfMeasureEnum: &globalForwardingUnitOfMeasureEnum type: string nullable: true enum: - Bale - Bin - Bottle - Bucket - Jar - Loose - Lug - Other - Reels - Sack - Skid - Skid elevating or lift truck - Slip Sheet - Intermodal Trailer/Container Load (Rail) - Tray - Bags - Boxes - Bundles - Cartons - Case - Crates - Dozens - Drums - Eaches - Gaylords - Hundred Weight (lbs) - Linear Foot - Package - Pail - Pallet - Pieces - Pounds - Roll - Totes - Yards - Skids - Gallon - Kit - Feet - Pad - Pair - Set - Sheet - Meter - Kilogram - Intermediate Bulk Container - Batch - Assortment - Cube - Racks - Packet - Thousand - 24" Bin - 30" Bin - 36" Bin - 40" Bin - Bushel - Cellpack - DRC - ECO Crate - EURO Ctn - Flat - Half Bin - Half Ctn - Heavy Pack - IFCO - IFCO 6408 - IFCO 6411 - IFCO 6413 - IFCO 6416 - IFCO 6419 - IFCO 6423 - IFCO 6425 - IFCO 6428 - ORBIS - ORBIS 6409 - ORBIS 6411 - ORBIS 6413 - ORBIS 6416 - ORBIS 6419 - ORBIS 6425 - ORBIS 6428 - PL 4311 - PL 4317 - PL 6408 - PL 6411 - PL 6413 - PL 6416 - PL 6419 - PL 6423 - PL 6425 - PL 6428 - RPC - RPC 6411 - RPC 6413 - RPC 6416 - Tension Bin - TOSCA - TOSCA 6408 - TOSCA 6411 - TOSCA 6413 - TOSCA 6416 - TOSCA 6419 - TOSCA 6423 - TOSCA 6425 - TOSCA 6428 - Wood Crate - Barrel - Rack - Tub - CARD - Display - Square Feet - Cylinder - Keg - Pounds-IFCO - Pallet (48"x40") - Pallet (48"x48") - Pallet (60"x48") - Carpets - Coils - Tubes/Pipes - Garment on Hanger - Bulk - Proof of Gallons - Liter - International Pallet - Tank - Jug - Can - Unit Pack - Meters Squared - Gross - Ounces - Grams - Knockdowns globalForwardingUnknownUnitOfMeasureValue: description: > This represents a new unit of measure that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingUnitOfMeasureEnum globalForwardingStop: allOf: - $ref: '#/components/schemas/globalForwardingLocation' - type: object description: A stop that the shipment will make during its journey. properties: sequenceNumber: description: > The index of this stop in the list of stops of the parent container. Since two containers within the same shipment may have different stops, the sequence number is unique only within a given container. type: integer format: int32 nullable: false stopType: description: The type of the stop. oneOf: - $ref: '#/components/schemas/globalForwardingStopTypeEnum' - $ref: '#/components/schemas/globalForwardingUnknownStopTypeValue' estimatedArrivalDate: description: The estimated date-time that the carrier will arrive at this stop. <<: *globalForwardingDateTimeOffsetNullableChangableValue actualArrivalDate: description: The actual date-time that the carrier arrived at this stop. <<: *globalForwardingDateTimeOffsetNullableChangableValue actualDepartureDate: description: The actual date-time that the carrier departed from this stop. <<: *globalForwardingDateTimeOffsetNullableChangableValue globalForwardingStopTypeEnum: &globalForwardingStopTypeEnum description: Indicates the type of the stop. type: string nullable: false enum: - Pickup Location - Origin Port - Origin Airport - Origin Terminal - Origin Ramp - Intermediary Port - Intermediary Airport - Destination Port - Destination Airport - Destination Ramp - Destination Terminal - Drop Location globalForwardingUnknownStopTypeValue: description: > This represents a new stop type that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingStopTypeEnum globalForwardingLocation: type: object properties: name: description: The name of the location. type: string nullable: true locationCode: description: > The standard location code for this stop. For example, this may be an port code or an IATA airport code. type: string nullable: true unlocode: description: The UN/LOCODE of the location. type: string nullable: true address: $ref: '#/components/schemas/globalForwardingAddress' globalForwardingAddress: type: object nullable: true properties: address1: description: The first line of the address. type: string nullable: true address2: description: The second line of the address. type: string nullable: true city: description: The city portion of the address. type: string nullable: true stateProvinceCode: description: The state or province code of the address. type: string nullable: true country: description: The country code of the address. type: string nullable: true postalCode: description: The postal code of the address. type: string nullable: true globalForwardingCustomsEntry: description: The customs entry for the shipment. type: object properties: entryNumber: description: The entry number of the cargo release customs entry. type: string nullable: true status: description: The status of the cargo release customs entry. oneOf: - $ref: '#/components/schemas/globalForwardingCustomsEntryStatusEnum' - $ref: '#/components/schemas/globalForwardingUnknownCustomsEntryStatusValue' releaseDate: description: The release date of the cargo release customs entry. type: string nullable: true format: date-time usCustomsEntry: $ref: '#/components/schemas/globalForwardingUsCustomsEntry' globalForwardingCustomsEntryStatusEnum: &globalForardingCustomsEntryStatusEnum type: string nullable: false enum: - Pending - Intensive Exam - Admissible - NotReleased - DocumentRequired - RequiresBrokerReview - Cancelled - Released globalForwardingUnknownCustomsEntryStatusValue: description: > This represents a new customs entry status that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForardingCustomsEntryStatusEnum globalForwardingUsCustomsEntry: description: The US customs entry for the shipment. type: object properties: pgaStatuses: description: The status of the Partner Government Agency (PGA) release for the cargo release customs entry. type: array nullable: false uniqueItems: true items: $ref: '#/components/schemas/globalForwardingPgaStatus' globalForwardingPgaStatus: description: The status of the Partner Government Agency (PGA) release for the cargo. type: object nullable: false properties: agency: description: The Partner Government Agency (PGA) that is responsible for the release. type: string nullable: false status: description: The status of the PGA release. oneOf: - $ref: '#/components/schemas/globalForwardingPgaStatusEnum' - $ref: '#/components/schemas/globalForwardingUnknownPgaStatusValue' releaseDate: description: The release date of the Partner Government Agency (PGA). type: string nullable: true format: date wasReleased: description: '`true` if the cargo was released by the Partner Government Agency (PGA).' type: boolean nullable: false globalForwardingPgaStatusEnum: &globalForwardingPgaStatusEnum type: string nullable: false enum: - Ex-Works - Free Carrier - Free Alongside Ship - Free On-Board Vessel - Cost & Freight - Cost Insurance & Freight - Carriage Paid To - Carriage & Insurance Paid To - Delivery At Frontier - Delivered Ex-Ship - Delivered Ex-Quay, Duty Unpaid - Delivered Duty Unpaid - Delivered Duty Paid - Delivered at Place - Delivered at Terminal - Delivered at Place Unloaded globalForwardingUnknownPgaStatusValue: description: > This represents a new PGA status value that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingPgaStatusEnum globalForwardingCustoms: description: This represents customs entries. type: object properties: auCustoms: $ref: '#/components/schemas/globalForwardingAuCustoms' nzCustoms: $ref: '#/components/schemas/globalForwardingNzCustoms' globalForwardingAuCustoms: description: This represents the customs entries for Australia. type: object properties: n10: $ref: '#/components/schemas/globalForwardingAuCustomsN10' globalForwardingNzCustoms: description: This represents the customs entries for New Zealand. type: object properties: n10: $ref: '#/components/schemas/globalForwardingNzCustomsN10' globalForwardingNzCustomsN10: description: This represents the N10 document for a New Zealand customs entry. type: object properties: dateOfClearance: description: The date customs was cleared. type: string nullable: true format: date entryNumber: description: A unique identifier assigned to an import declaration or customs entry. type: string nullable: true status: description: Represents the current status of the customs process for imported goods. oneOf: - $ref: '#/components/schemas/globalForwardingNzCustomsStatusEnum' - $ref: '#/components/schemas/globalForwardingUnknownNzCustomsStatusValue' globalForwardingNzCustomsStatusEnum: &globalForwardingNzCustomsStatusEnum type: string nullable: false description: > This represents a New Zealand customs statuses that have been implemented and available for use. enum: - Cleared globalForwardingUnknownNzCustomsStatusValue: description: > This represents a new New Zealand customs status that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingNzCustomsStatusEnum globalForwardingAuCustomsN10: description: This represents the N10 document for Australia customs entry. type: object properties: dateOfClearance: description: The date customs was cleared. type: string nullable: true format: date entryNumber: description: A unique identifier assigned to an import declaration or customs entry. type: string nullable: true status: description: Represents the current status of the customs process for imported goods. oneOf: - $ref: '#/components/schemas/globalForwardingAuCustomsStatusEnum' - $ref: '#/components/schemas/globalForwardingUnknownAuCustomsStatusValue' globalForwardingAuCustomsStatusEnum: &globalForwardingAuCustomsStatusEnum type: string nullable: false description: > This represents a Australia customs statuses that have been implemented and available for use. enum: - Cleared globalForwardingUnknownAuCustomsStatusValue: description: > This represents a new Australia customs status that has been implemented, but it not yet ready for public consumption. type: string not: <<: *globalForwardingAuCustomsStatusEnum orderEvent: type: object properties: eventType: type: string description: "Indicates the type of order event.\n* ORDER CREATED - Order has been created in the C.H. Robinson system. This event should be listened to as confirmation the order has successfully been created in Navisphere® Order Management System.\n* ORDER UPDATE - An update has occured on the order. \n* ORDER CANCELED - The order has been canceled. \n* ORDER REJECTED - The order was rejected and will not continue processing. \n* ORDER COMPLETED - All loads associated to the order have been delivered and order is complete." enum: - "ORDER CREATED" - "ORDER REJECTED" - "ORDER UPDATED" - "ORDER CANCELED" - "ORDER COMPLETED" eventSubType: type: string description: "Indicates the sub type of order updated event. This is only applicable for Order Updated events, and must be subscribed to individually. Events consumers are automatically opted into 'ORDER UPDATE', which indicates when the service is planned or the service is booked." enum: - "ORDER UPDATE" - "ADD ITEM DETAILS" - "REMOVE ITEM DETAILS" - "UPDATE ITEM DETAILS" - "ADD PARTY" - "UPDATE PARTY" - "REMOVE PARTY" - "UPDATE PLAN" - "CREATE PLAN" - "REMOVE PLAN" - "UPDATE ORDER STATUS" - "UPDATE ORIGIN DATE" - "UPDATE DELIVERY DATE" - "UPDATE REFERENCE NUMBER" orderDetail: type: array description: Contains order number and order tracking information. items: $ref: '#/components/schemas/orderEventOrderDetail' loadNumbers: type: array description: C.H. Robinson defined shipment number(s) tied to this order. items: type: integer referenceNumbers: type: array description: Any additional reference numbers that are contained on the order. items: $ref: '#/components/schemas/referenceNumber' orderEventService: type: object properties: condition: $ref: '#/components/schemas/condition' mode: $ref: '#/components/schemas/orderEventMode' description: type: string description: The description of the mode. enum: - "LTL Transportation" - "Truckload Transportation" - "Consolidated Transportation" - "Truckload Temp Controlled Transportation" - "Truckload Flatbed Transportation" - "Small Parcel" - "LTL Temp Controlled Transportation" - "Consolidated Temp Controlled Transportation" - "LTL Europe" - "Produce Truckload Temp Controlled Transportation" - "Intermodal Full Container Transportation" - "International Ocean NVOCC" - "Produce LTL Temp Controlled Transportation" - "Domestic Air Transportation" - "Bulk Transportation" - "Ocean" - "Truckload Tautliner Europe" - "Broker - Inventory Freight" - "International Air House" - "Produce Consolidation Temp Controlled Transportation" - "Intermodal Full Temp Controlled Transportation" - "LTL Flatbed Transportation" - "Truckload Europe Box" - "Truckload Bulk Europe" - "International Air Direct" - "Intermodal Europe" - "Tautliner" - "Broker Produce Freight Partial Dry Van" serviceLevel: $ref: '#/components/schemas/orderEventServiceLevel' locations: type: array description: Locations associated to this shipment. items: $ref: '#/components/schemas/orderEventLocation' items: type: array description: Items associated to this shipment. items: $ref: '#/components/schemas/orderEventItem' suggestedScac: type: string minimum: 1 maximum: 10 description: Indicates a specific carrier SCAC customer wishes to associate to the order. suggestedCarrierPartyCode: type: string minimum: 1 maximum: 25 description: C.H. Robinson identifier for a carrier customer wishes to associate to the order. orderEventLocation: type: object description: Location information specific to the service. properties: chrLocationId: type: string description: C.H. Robinson defined location identifier. customerLocationId: type: string description: Customer generated location identifier. type: $ref: '#/components/schemas/orderEventLocationType' style: $ref: '#/components/schemas/orderEventLocationStyle' name: type: string description: Name of the location. address: $ref: '#/components/schemas/eventAddress' referenceNumbers: type: array description: Any additional reference numbers that are specific to the stop. items: $ref: '#/components/schemas/referenceNumber' orderEventItem: type: object description: Items tied to the service. properties: packagingType: $ref: '#/components/schemas/packageCodeEnum' description: type: string description: Customer defined description of the item in the order (product name). productCode: type: string description: Customer defined code of the item in the order. freightClass: $ref: '#/components/schemas/freightClassEnum' upcNumber: type: string description: UPC number number of the item. skuNumber: type: string description: sku number of the item. pluNumber: type: string description: plu number of the item. insuranceValue: type: number format: float description: Insurance valuation of item. minWeight: type: number format: float description: The minimum weight of the item. minWeightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' maxWeight: type: number format: float description: The minimum weight of the item. maxWeightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' length: type: number format: float description: Length of the item. lengthUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' height: type: number format: float description: Height of the item. heightUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' width: type: number format: float description: Width of the item. widthUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' volume: type: number format: float description: Volume of the item. volumeUnitOfMeasure: $ref: '#/components/schemas/volumeUomEnum' pallets: type: number format: float description: Number of pallets for the item. palletSpaces: type: number format: float description: Amount of pallet space the item takes up. trailerLengthUsed: type: number format: float description: Trailer feet the item takes up. trailerLengthUsedUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' referenceNumbers: type: array description: Any additional reference numbers that are contained on the order. items: $ref: '#/components/schemas/referenceNumber' isHazardous: type: boolean description: Indicates whether the item is hazardous or not. hazardousProperties: $ref: '#/components/schemas/ordersEventsHazardousProperties' loadEvent: type: object properties: eventType: type: string description: "Load level events. \n* `LOAD CREATED` - A shipment has been created in our execution system. \n* `LOAD BOOKED` - Carrier has been selected to transport the shipment.\n* `LOAD CANCELLED` - The load has been cancelled. \n* `PRO NUMBER ADDED` - Pro Number has been added to the shipment." enum: - "LOAD CREATED" - "LOAD BOOKED" - "LOAD CANCELLED" - "PRO NUMBER ADDED" orderDetails: type: array description: Contains order number and order tracking information. items: $ref: '#/components/schemas/loadEventOrderDetail' loadNumber: type: integer description: C.H. Robinson defined shipment number. equipmentType: type: string description: Indicates the equipment type. mode: type: string description: Indicates the mode of the shipment. enum: - "Truckload" - "LTL Linehaul" - "Small Parcel" - "Bulk Transportation" - "Intermodal Linehaul" - "Intermodal Pickup Drayage" - "Intermodal Delivery Drayage" - "Intermodal Cross Town Dray" serviceOffering: type: string description: Indicates the level of service associated to the shipment. enum: - "LTL Transportation" - "Truckload Transportation" - "Consolidated Transportation" - "Truckload Temp Controlled Transportation" - "Truckload Flatbed Transportation" - "Small Parcel" - "LTL Temp Controlled Transportation" - "Consolidated Temp Controlled Transportation" - "LTL Europe" - "Produce Truckload Temp Controlled Transportation" - "Intermodal Full Container Transportation" - "International Ocean NVOCC" - "Produce LTL Temp Controlled Transportation" - "Domestic Air Transportation" - "Bulk Transportation" - "Ocean" - "Truckload Tautliner Europe" - "Broker - Inventory Freight" - "International Air House" - "Produce Consolidation Temp Controlled Transportation" - "Intermodal Full Temp Controlled Transportation" - "LTL Flatbed Transportation" - "Truckload Europe Box" - "Truckload Bulk Europe" - "International Air Direct" - "Intermodal Europe" - "Tautliner" - "Broker Produce Freight Partial Dry Van" readyByDate: type: string format: date-time description: Earliest date, local to location, carrier can pick up the shipment. pickupByDate: type: string format: date-time description: Latest date, local to location, carrier can pick up the shipment. deliveryAvailableByDate: type: string format: date-time description: Earliest date, local to location, carrier can deliver the shipment. deliveryByDate: type: string format: date-time description: Latest date, local to location, carrier can deliver the shipment. proposedCarrier: $ref: '#/components/schemas/proposedCarrier' billTos: type: array description: Customer billTos associated to this shipment. items: $ref: '#/components/schemas/bookedBillTo' customers: type: array description: Customers associated to this shipment. items: $ref: '#/components/schemas/bookedCustomer' carrier: $ref: '#/components/schemas/carrier' locations: type: array description: Locations associated to this shipment. items: $ref: '#/components/schemas/bookedLocation' items: type: array description: Items associated to this shipment. items: $ref: '#/components/schemas/bookedItem' packages: type: array description: List of packages associated to the shipment. items: $ref: '#/components/schemas/eventLoadPackage' stopEvent: type: object properties: eventType: type: string description: "Indicates an event has occured at one of the designated stops.\n* `CARRIER ARRIVED` - Carrier has arrived at a stop location.\n* `CARRIER DEPARTED` - Carrier has departed at a stop location. \n* `LOAD PICKED UP` - Carrier has departed the last pick up stop.\n* `LOAD DELIVERED` - Carrier has departed the last drop off stop." enum: - "CARRIER ARRIVED" - "CARRIER DEPARTED" - "LOAD PICKED UP" - "LOAD DELIVERED" ##lateReasonCode: ##$ref: '#/components/schemas/lateCodeEnum' orderDetails: type: array description: Contains order number and order tracking information. items: $ref: '#/components/schemas/orderDetail' loadDetails: $ref: '#/components/schemas/loadDetails' loadNumber: type: integer description: C.H. Robinson defined shipment number. deliveryAvailableByDate: type: string format: date-time description: Earliest date, local to location, carrier can deliver the shipment. deliveryByDate: type: string format: date-time description: Latest date, local to location, carrier can deliver the shipment. proofOfDelivery: type: string description: Individual or entity that signed for the items upon delivery. carrier: $ref: '#/components/schemas/carrier' location: $ref: '#/components/schemas/stopEventLocation' loadStops: type: array description: An array that offers all stops on the load with key stop details. items: $ref: '#/components/schemas/loadStopInformation' items: type: array description: List of items associated to the stop. items: $ref: '#/components/schemas/eventItem' packages: type: array description: List of packages associated to the stop. items: $ref: '#/components/schemas/eventLoadPackage' inTransitEvent: type: object properties: eventType: type: string description: "A periodic location update during the transport cycle of the shipment.\n* `IN TRANSIT` - An update indicating the shipment is in transit between stops.\n* `IN TRANSIT TO ORIGIN` - An update indicating the shipment is in transit to the origin stop." enum: - "IN TRANSIT" - "IN TRANSIT TO ORIGIN" orderDetails: type: array description: Contains order number and order tracking information. items: $ref: '#/components/schemas/orderDetail' loadNumber: type: integer description: C.H. Robinson defined shipment number. carrier: $ref: '#/components/schemas/carrier' location: $ref: '#/components/schemas/inTransitAddress' loadStops: type: array description: An array that offers all stops on the load with key stop details. items: $ref: '#/components/schemas/loadStopInformation' items: type: array description: Items associated to this shipment. items: $ref: '#/components/schemas/bookedItem' deliveryEta: type: string description: The date/time in ISO8601 UTC format of the delivery ETA. nextStop: $ref: '#/components/schemas/inTransitNextStop' loadDetails: $ref: '#/components/schemas/loadDetails' notes: type: string description: Any additional information from the user or Carrier. trackingNumberEvent: type: object properties: eventType: type: string description: "Indicates CHR Tracking Number has been associated to the order/shipment. \n* `CHR TRACKING NUMBER PUBLISHED` - CHR Tracking Number has been associated to the order/shipment." enum: - "CHR TRACKING NUMBER PUBLISHED" chrTrackingNumber: type: string description: "CHR Number available for tracking on Customer Platform." trackingType: type: string description: "Identifies the core system and phase of transaction producing the number." enum: - "order" - "shipment" customerCode: type: string description: "CH Robinson defined customer code." referenceNumber: type: string description: "CHR order number or shipment (load) number." appointmentEvent: type: object properties: eventType: type: string description: "Indicates an appointment has been added or changed at one of the designated stops. \n* `APPOINTMENT UPDATED` - Provides appointment time window for the stop." enum: - "APPOINTMENT UPDATED" orderDetails: type: array description: Contains order number and order tracking information. items: $ref: '#/components/schemas/orderDetail' loadNumber: type: integer description: C.H. Robinson defined shipment number. location: $ref: '#/components/schemas/eventLocation' carrier: $ref: '#/components/schemas/carrier' appointment: type: object description: Appointment information properties: appointmentNumber: type: string description: Appointment number. scheduledOpenDateTimeUTC: type: string format: date-time description: Indicates the scheduled earliest date/time carrier can arrive at the stop. scheduledCloseDateTimeUTC: type: string format: date-time description: Indicates the scheduled latest date/time carrier can arrive at the stop changeReason: $ref: '#/components/schemas/lateCodeEnum' scheduledCompany: type: string description: Name of the company appointment is scheduled with. scheduledWithName: type: string description: Name of individual the appointment is scheduled with. items: type: array description: List of items associated to the shipment. items: $ref: '#/components/schemas/bookedItem' packageStopEvent: type: object properties: eventType: type: string description: "Indicates an event has occured at one of the designated stops.\n* `PACKAGE PICKED UP` - Carrier has departed the shipper location with the package. \n* `PACKAGE DELIVERED` - Carrier has delivered package to final destination." enum: - "PACKAGE PICKED UP" - "PACKAGE DELIVERED" orderDetails: type: array description: Contains order number and order tracking information. items: $ref: '#/components/schemas/orderDetail' loadNumber: type: integer description: C.H. Robinson defined shipment number. carrier: $ref: '#/components/schemas/carrier' location: $ref: '#/components/schemas/eventLocation' packages: type: array description: List of packages associated to the stop. items: $ref: '#/components/schemas/eventPackage' packageInTransitEvent: type: object properties: eventType: type: string description: A periodic location update during the transport cycle of the shipment. enum: - "PACKAGE IN TRANSIT" orderDetails: type: array description: Contains order number and order tracking information. items: $ref: '#/components/schemas/orderDetail' loadNumber: type: integer description: C.H. Robinson defined shipment number. carrier: $ref: '#/components/schemas/carrier' location: $ref: '#/components/schemas/packageInTransitAddress' packages: type: array description: Array of the eventPackage object. items: $ref: '#/components/schemas/eventPackage' deliveryEta: type: string description: The date/time in ISO8601 UTC format of the delivery ETA. bookedBillTo: type: object description: The bill to(s) on the shipment. properties: customerCode: type: string description: C.H. Robinson defined customer code. customerName: type: string description: The name of the customer. currencyCode: $ref: '#/components/schemas/currencyCodeEnum' invoiceMethod: $ref: '#/components/schemas/invoiceMethodEnum' milesBilled: type: string description: total miles of the shipment. exchangeRate: type: double description: Exhange rate. charges: type: array description: Charges tied to the bill to. items: $ref: '#/components/schemas/eventCharge' contacts: type: array description: Bill to contacts. items: $ref: '#/components/schemas/contact' referenceNumbers: type: array description: Bill To reference numbers. items: $ref: '#/components/schemas/referenceNumber' eventCharge: type: object description: Object relating to the charges for the order. required: - rate - rateCode properties: rate: type: number format: float description: Monetary amount of this rate type. rateCode: $ref: '#/components/schemas/rateCodeEnum' quantity: type: number format: float description: Quantity of the rate. Multiplying `rate` by `quantity` will give the total charge for this rate line item. default: 1 alternateDescription: type: string minimum: 1 maximum: 20 description: Description of the charge. chargeType: type: string description: Indicates the type of charge. enum: - Actual Charge - End Customer Charge eventAddress: type: object description: Contains address information required: - city - stateProvinceCode properties: addressLine1: type: string description: Line one of the address. addressLine2: type: string description: Line two of the address. city: type: string description: City name of address. stateProvinceCode: $ref: '#/components/schemas/stateProvinceCodeEnum' postalCode: type: string description: Postal code of address. country: $ref: '#/components/schemas/countryCodeEnum' latitude: type: number format: float minimum: -90 maximum: 90 description: The decimal latitude of the address. longitude: type: number format: float minimum: -180 maximum: 180 description: The decimal longitude of the address. milestoneLocationAddress: type: object description: Contains address information; variant that does not require stateProvinceCode. required: - city - country - latitude - longitude properties: addressLine1: type: string description: Line one of the address. addressLine2: type: string description: Line two of the address. city: type: string description: "City name of address. \n\n ### Provide either (city and country) or (latitude and longitude); one complete set is required." stateProvinceCode: description: "Indicate the state or province of the location.\n\n ### ***Though not required, it is preferred to clearly identify location where latitude and longitude is not provided.\n\nFor a detailed description of all enumerated codes please find them here." allOf: - type: string - $ref: '#/components/schemas/stateProvinceCodeEnum' postalCode: type: string description: Postal code of address. country: description: "Indicate the country of the location. \n\n ### Provide either (city and country) or (latitude and longitude); one complete set is required." allOf: - type: string - $ref: '#/components/schemas/countryCodeEnum' latitude: type: number format: float minimum: -90 maximum: 90 description: "The decimal latitude of the address. \n\n ### Provide either (city and country) or (latitude and longitude); one complete set is required." longitude: type: number format: float minimum: -180 maximum: 180 description: "The decimal longitude of the address. \n\n ### Provide either (city and country) or (latitude and longitude); one complete set is required." loadDetails: type: object description: Contains load specific information and reference numbers. properties: loadNumber: type: integer description: C.H. Robinson defined shipment number. referenceNumbers: type: array description: Load level reference numbers. items: $ref: '#/components/schemas/referenceNumber' inTransitAddress: type: object description: Contains address information properties: city: type: string description: City name of address. stateProvinceCode: $ref: '#/components/schemas/stateProvinceCodeEnum' country: $ref: '#/components/schemas/countryCodeEnum' latitude: type: number format: float minimum: -90 maximum: 90 description: The latitude of reported update in decimal format. longitude: type: number format: float minimum: -180 maximum: 180 description: The longitude of reported update in decimal format. packageInTransitAddress: type: object description: Contains address information properties: city: type: string description: City name of address. stateProvinceCode: $ref: '#/components/schemas/stateProvinceCodeEnum' postalCode: type: string description: Postal code of address. country: $ref: '#/components/schemas/countryCodeEnum' latitude: type: number format: float minimum: -90 maximum: 90 description: The latitude of reported update in decimal format. longitude: type: number format: float minimum: -180 maximum: 180 description: The longitude of reported update in decimal format. inTransitNextStop: type: object description: Contains stop information properties: eta: type: string description: The date/time in ISO8601 UTC format of ETA at the stop. stopId: type: string description: A C.H. Robinson identifier for the specific stop. stopType: type: string description: Stop type. \n- 'P' - Pick \n- 'D' - Drop \n- 'X' - Cross Dock enum: - "P" - "D" - "X" city: type: string description: City name for the stop. state: type: string description: The state abbreviation for the stop. bookedCustomer: type: object description: The customer(s) on the shipment. properties: customerCode: type: string description: C.H. Robinson defined customer code. customerName: type: string description: The name of the customer. contacts: type: array description: Customer contacts. items: $ref: '#/components/schemas/contactPosition' ebolEnabledWithCarrier: type: boolean description: Indicates if customer is enabled with listed carrier to retrieve PRO number in advance of pickup. referenceNumbers: type: array description: Customer reference numbers. items: $ref: '#/components/schemas/referenceNumber' contactPosition: type: object description: Object containing contact information. required: - name - type - companyName - contactMethods properties: name: type: string minimum: 1 maximum: 200 description: Name of the contact. type: $ref: '#/components/schemas/contactPositionEnum' companyName: type: string minimum: 1 maximum: 100 description: Company name of the contact. contactMethods: type: array description: Contact Methods items: $ref: '#/components/schemas/contactMethod' proposedCarrier: type: object description: Carrier CHR is proposing to use for this shipment (Only available for Small Parcel Mode). properties: carrierCode: type: string description: C.H. Robinson defined carrier code. carrier: type: object description: Object containing carrier information. properties: name: type: string description: Name of carrier executing shipment. carrierCode: type: string description: C.H. Robinson defined carrier code. scac: type: string description: In North America this is the Nmfta defined standard carrier alpha code. proNumber: type: string description: Carrier provided primary reference number. Primarily used for LTL shipments. driverName: type: string description: Name of the driver transporting the shipment. driverPhone: type: string description: Phone number of the driver transporting the shipment. secondDriverName: type: string description: Name of the driver transporting the shipment. sealNumber: type: string description: If trailer has a seal, the identifier of the seal. licensePlate: type: string description: License plate of the powered unit. tractorNumber: type: string description: Identifier of the powered unit transporting the shipment. trailerNumber: type: string description: Identifier of the trailer the shipment resides in. dotNumber: type: string description: A number that is issued by the Department of Transportation to a carrier. barcodeType: type: string description: Represents the barcode type used by the carrier. ebolEnabled: type: boolean description: Indicates if carrier can provide PRO number in advance of pickup. loadStopInformation: type: object description: Stop information specific to the load. properties: stopType: type: string description: Identifies the type of stop the location is. stopStyle: type: string description: Identifies the style of the stop. stopSequenceNumber: type: integer description: Number to indicate where in the order of stops the location is. C.H. Robinson uses a zero index. This means the "0" will indicate the first stop in the sequence of stops. warehouseCode: type: string description: The C.H. Robinson code for the warehouse at the stop. stopEventLocation: type: object description: Location information specific to the event. properties: chrLocationId: type: string description: C.H. Robinson defined location identifier. customerLocationId: type: string description: Customer generated location identifier. type: type: string description: Identifies the type of stop the location is. style: type: string description: identifies the style of the stop. stopSequenceNumber: type: integer description: Number to indicate where in the order of stops the location is. C.H. Robinson uses a zero index. This means the \"0\" will indicate the first stop in the sequence of stops. sequenceNumber: type: integer description: System generated number applied to the location when it is entered into the system. name: type: string description: Name of the location. address: $ref: '#/components/schemas/eventAddress' pickUpNumber: type: string description: Pick-Up number. deliveryNumber: type: string description: Delivery number. isOrderStop: type: boolean description: Indicates if this is an order service stop. False indicates this location was not included as part of the customer order. locationContact: type: object description: Contact information for the location. properties: name: type: string description: Name of contact at the location. phoneNumber: type: string description: Phone number of contact at the location. email: type: string description: E-mail address of the contact at the location. referenceNumbers: type: array description: Reference numbers associated to this location. items: $ref: '#/components/schemas/referenceNumber' eventLocation: type: object description: Location information specific to the event. properties: chrLocationId: type: string description: C.H. Robinson defined location identifier. customerLocationId: type: string description: Customer generated location identifier. type: type: string description: Identifies the type of stop the location is. style: type: string description: identifies the style of the stop. stopSequenceNumber: type: integer description: Number to indicate where in the order of stops the location is. C.H. Robinson uses a zero index. This means the \"0\" will indicate the first stop in the sequence of stops. sequenceNumber: type: integer description: System generated number applied to the location when it is entered into the system. name: type: string description: Name of the location. address: $ref: '#/components/schemas/eventAddress' pickUpNumber: type: string description: Pick-Up number. deliveryNumber: type: string description: Delivery number. locationContact: type: object description: Contact information for the location. properties: name: type: string description: Name of contact at the location. phoneNumber: type: string description: Phone number of contact at the location. email: type: string description: E-mail address of the contact at the location. referenceNumbers: type: array description: Reference numbers associated to this location. items: $ref: '#/components/schemas/referenceNumber' eventItem: type: object properties: packagingType: $ref: '#/components/schemas/packageCodeEnum' description: type: string description: Customer defined description of the item in the order (product name). productCode: type: string description: Customer defined code of the item in the order. freightClass: $ref: '#/components/schemas/freightClassEnum' insuranceValue: type: number format: float description: Insurance valuation of item. innerPackQuantity: type: float description: Represents the number of units of the innermost packing. primaryReferenceNumber: type: string description: Primary reference number of the item. poNumber: type: string description: PO number number of the item. skuNumber: type: string description: sku number of the item. pluNumber: type: string description: plu number of the item. actualQuantity: type: string format: integer description: Confirmed quantity of the item(s). actualWeight: type: string format: float description: Confirmed weight of the item(s). actualWeightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' actualPallets: type: string format: float description: Actual pallet count of the item(s). actualVolume: type: string format: float description: Volume of the item(s). actualVolumeUnitOfMeasure: $ref: '#/components/schemas/volumeUomEnum' actualPackagingLength: type: string format: float description: Confirmed packaging length of the item(s). actualPackagingHeight: type: string format: float description: Confirmed packaging height of the item(s). actualPackagingWidth: type: string format: float description: Confirmed packaging width of the item(s). actualPackagingUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' referenceNumbers: type: array description: Reference numbers associated to this item. items: $ref: '#/components/schemas/referenceNumber' orderDetail: type: object description: Contains order number and order tracking information. properties: orderNumber: type: integer description: C.H. Robinsons defined order number. customerReferenceNumber: type: string description: Primary customer reference number. billToReferenceNumber: type: string description: Primary customer bill to reference number. Often the customer's order number. customerOrderReferenceNumber: type: string description: Primary customer order reference number. navisphereTrackingNumber: type: string description: C.H. Robinson reference number that allows you to track your order through Navisphere® Online. navisphereTrackingLink: type: string description: Link that takes user straight to the Navisphere® Online webpage for the order's tracking information. referenceNumbers: type: array description: Reference numbers associated to this item. items: $ref: '#/components/schemas/referenceNumber' orderEventOrderDetail: type: object description: Contains order number and order tracking information. properties: navisphereTrackingNumber: type: string description: C.H. Robinson reference number that allows you to track your order through Navisphere® Online. navisphereTrackingLink: type: string description: Link that takes user straight to the Navisphere® Online webpage for the order's tracking information. orderNumber: type: integer description: C.H. Robinsons defined order number. condition: $ref: '#/components/schemas/condition' services: type: array description: Services associated to this event. items: $ref: '#/components/schemas/orderEventService' loadEventOrderDetail: type: object description: Contains order number and order tracking information. properties: orderNumber: type: integer description: C.H. Robinsons defined order number. customerReferenceNumber: type: string description: Primary customer reference number. billToReferenceNumber: type: string description: Primary customer bill to reference number. Often the customer's order number. customerOrderReferenceNumber: type: string description: Primary customer order reference number. navisphereTrackingNumber: type: string description: C.H. Robinson reference number that allows you to track your order through Navisphere® Online. navisphereTrackingLink: type: string description: Link that takes user straight to the Navisphere® Online webpage for the order's tracking information. referenceNumbers: type: array description: Reference numbers associated to this item. items: $ref: '#/components/schemas/referenceNumber' ordersPlannedOnLoad: type: array description: List of C.H. Robinson defined customer order numbers included on this load. items: $ref: '#/components/schemas/orderNumber' bookedLocation: allOf: - $ref: '#/components/schemas/eventLocation' - type: object properties: appointmentNumber: type: string description: Appointment number. scheduledOpenDateTime: type: string format: date-time description: An ISO8601 UTC date-time when location is scheduled to be open. scheduledCloseDateTime: type: string format: date-time description: An ISO8601 UTC date-time when location is scheduled to be closed. scheduledEnteredDate: type: string format: date-time description: An ISO8601 UTC date-time when the scheduledCloseDateTime and scheduledOpenDateTime was entered. arrivalDateTime: type: string format: date-time description: An ISO8601 UTC date-time that carrier has arrived. departureDateTime: type: string format: date-time description: An ISO8601 UTC date-time that carrier has departed. isDropTrailerNeeded: type: boolean description: Informs if drop trailer is required at this location. scheduledWith: type: string description: Individual who accepted the appointment for this location. etaDateTime: type: string format: date-time description: Estimated time of arrival for this location. eventPackage: type: object description: Package object. properties: trackingNumber: type: string description: Carrier specified tracking number. packageType: type: string description: Customer specified packaging type. ediCode: type: string description: Most parcel carriers update us on packages using EDI transactions. ediCode will reflect the EDI event code the carriers provided to us. note: type: string description: Additional information on disposition of the package. referenceNumbers: type: array description: Reference numbers associated to this package. items: $ref: '#/components/schemas/referenceNumber' eventLoadPackage: type: object description: Package object. properties: trackingNumber: type: string description: Carrier specified tracking number. packageType: type: string description: Customer specified packaging type. referenceNumbers: type: array description: Reference numbers associated to this package. items: $ref: '#/components/schemas/referenceNumber' bookedItem: allOf: - $ref: '#/components/schemas/eventItem' - type: object properties: associatedStop: type: object description: Identifies the pick up and drop off stop sequence numbers. properties: pickSequenceNumber: type: integer description: Identifies sequence number of where the item is picked up. dropSequenceNumber: type: integer description: Identifies sequence number of where the item is dropped off. expectedPallets: type: string format: float description: Expected pallet count of the item(s). expectedQuantity: type: string format: float description: Expected quantity of the item(s). expectedWeight: type: string format: float description: Expected weight of the item(s). expectedWeightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' expectedPackagingLength: type: string format: float description: Expected packaging length of the item(s). expectedPackagingHeight: type: string format: float description: Expected height length of the item(s). expectedPackagingWidth: type: string format: float description: Expected packaging width of the item(s). expectedPackagingUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' expectedVolume: type: string format: float description: Volume of the item(s). expectedVolumeUnitOfMeasure: $ref: '#/components/schemas/volumeUomEnum' innerPackQuantity: type: float description: Represents the number of units of the innermost packing. #---Load Documents CallBack-------------------------------------------------------------------------------------- loadDocumentCallback: type: object description: Object containing the search event response. properties: billToReferenceNumber: type: string description: Primary bill to reference number customerReferenceNumber: type: string description: Primary customer reference number event: type: object description: Object containing document saved detail properties: billTos: type: array description: Array containing bill to entities and references by customerCode items: type: object properties: customerCode: type: string description: CHR defined Bill to customerCode referenceNumbers: description: Array containing bill to references items: $ref: '#/components/schemas/referenceNumber' customer: type: array description: Array containing customer entities and references by customerCode items: type: object properties: customerCode: type: string description: CHR defined customer code referenceNumbers: description: Array containing customer references items: $ref: '#/components/schemas/referenceNumber' documentFileName: type: string description: Filename and extension of the carrier document documentType: type: string enum: - "BOL" - "POD" - "LUMPER" - "INTL_BOL" - "INTL_POD" description: Defines type of carrier document, such as POD (Proof of Delivery), BOL (Bill of Lading), LMP (Lumper Receipt) - see enums eventType: type: string description: DOCUMENT SAVED loadNumber: type: string description: CHR load number eventTime: type: string format: date-time description: The date/time in ISO8601 UTC format when the event was reported to have occured. time: type: string format: date-time description: The date/time in ISO8601 UTC format when the event was written to the Enterprise API database. documentFileData: type: object description: Object containing image byte array and contentType properties: document: type: string description: Base64 encoded carrier document contentType: type: string description: String showing Content-type of the document, such as application/pdf enum: - "application/pdf" - "application/tif" - "application/jpeg" #---Financials----------------------------------------------------------------------------------------- invoiceShipments: type: array description: Contains high level shipment charge information. items: type: object properties: branchCode: type: string description: C.H Robinson code identifying the internal C.H. Robinson owning branch. chrOrderNumber: type: integer description: C.H. Robinson defined order number. currencyCode: $ref: '#/components/schemas/currencyCodeEnum' customerReferenceNumber: type: string description: Customer defined reference number. invoiceAmount: type: integer description: Total currency amount of shipment. invoiceBalance: type: integer description: Remaining currency amount left to be paid on the shipment. loadNumber: type: integer format: base32 integer description: C.H. Robinson provided shipment identifier. printDate: type: string format: date-time description: An ISO8601 UTC date-time indicating when the invoice was provided to the customer. receivedAmount: type: integer description: Currency amount C.H. Robinson has received as payment for the charge. salesRep: type: string description: C.H. Robinson representative's 7 letter. invoiceRates: type: array description: Defines all charges properties items: type: object properties: balance: type: integer description: Currency amount left to pay. notes: type: string description: Notes about the charge. totalRateAmount: type: number description: Total currency amount of specific charge. rateCode: $ref: '#/components/schemas/rateCodeEnum' ratePerUnit: type: number description: Amount of each unit. rateType: type: string description: Rate type units: type: number description: Total count of units per rate. invoiceShipmentsWithRates: type: array description: Contains detailed shipment charge information. items: type: object properties: branchCode: type: string description: C.H Robinson code identifying the internal C.H. Robinson owning branch. chrOrderNumber: type: integer description: C.H. Robinson defined order number. currencyCode: $ref: '#/components/schemas/currencyCodeEnum' customerReferenceNumber: type: string description: Customer defined reference number. invoiceAmount: type: integer description: Total currency amount of shipment. invoiceBalance: type: integer description: Remaining currency amount left to be paid on the shipment. loadNumber: type: integer format: base32 integer description: C.H. Robinson provided shipment identifier. receivedAmount: type: integer description: Currency amount C.H. Robinson has received as payment for the charge. salesRep: type: string description: C.H. Robinson representative's 7 letter. invoiceRates: $ref: '#/components/schemas/invoiceRates' invoiceSummaries: type: array description: All properties returned on the invoice get call. items: type: object properties: invoiceNumber: type: integer description: C.H. Robinson defined invoice number. customerCode: type: string description: C.H. Robinson defined code for a given customer i.e. C124516. currencyCode: $ref: '#/components/schemas/currencyCodeEnum' invoiceAmount: type: integer description: Currency amount of entire invoice. invoiceBalance: type: integer description: Remaining currency amount to be paid of entire invoice. receivedAmount: type: integer description: Currency amount C.H. Robinson has received as payment for the entire invoice. invoiceDate: type: string description: An ISO8601 UTC date-time indicating when order was invoiced. dueDate: type: string description: An ISO8601 UTC date-time indicating the date invoice must be paid. releasedDate: type: string description: An ISO8601 UTC date-time indicating when invoice was available. printDate: type: string format: date-time description: An ISO8601 UTC date-time indicating when the invoice was provided to the customer. invoiceShipments: $ref: '#/components/schemas/invoiceShipments' invoiceSummary: type: object description: All properties returned on the invoice get call. properties: invoiceNumber: type: integer description: C.H. Robinson defined invoice number. customerCode: type: string description: C.H. Robinson defined code for a given customer i.e. C124516. currencyCode: $ref: '#/components/schemas/currencyCodeEnum' invoiceAmount: type: integer description: Currency amount of entire invoice. invoiceBalance: type: integer description: Remaining currency amount to be paid of entire invoice. receivedAmount: type: integer description: Currency amount C.H. Robinson has received as payment for the entire invoice. invoiceDate: type: string description: An ISO8601 UTC date-time indicating when order was invoiced. dueDate: type: string description: An ISO8601 UTC date-time indicating the date invoice must be paid. releasedDate: type: string description: An ISO8601 UTC date-time indicating when invoice was available. printDate: type: string format: date-time description: An ISO8601 UTC date-time indicating when the invoice was provided to the customer. invoiceShipments: $ref: '#/components/schemas/invoiceShipmentsWithRates' payments: type: array description: All properties returned on the payment's get call. items: type: object properties: shipmentNumber: type: integer description: C.H. Robinson defined shipment number. billingStatus: type: string description: The Status of the Bill that is being requested carrierInvoiceNumber: type: string description: Carrier invoice number. #---Documents------------------------------------------------------------------------------------------ documentIdResults: type: array description: Document ID results. items: type: object properties: doumentType: $ref: '#/components/schemas/docTypeEnum' documentId: type: integer description: Identifing ID that matches to a specific image. documentEnteredDateTime: type: string format: date-time description: The date/time in ISO8601 format when the document was attached to the load. #---Shipments------------------------------------------------------------------------------------------ shipmentDetail: type: object description: properties: time: type: string format: date description: The date/time in ISO8601 format when the event was written to the Enterprise API database. carrierCode: type: string description: C.H. Robinson defined carrier code. scac: type: string description: Standard carrier alpha code. loadNumber: type: string description: C.H. Robinson shipment number. clientId: type: string description: API clientId tied to the profile of the carrier. eventTime: type: string format: date description: The date/time in ISO8601 format when the event was reported to have occured. event: $ref: '#/components/schemas/shipmentDetailEvent' shipmentDetailEvent: type: object properties: eventType: type: string description: Indicates the type of update for the load. enum: - LOAD DETAIL CHANGED eventSubType: type: string description: Additional detail on event type. enum: - Stop Created - Stop Removed - Shipment Booked - Activity Date Changed - Expected Weight Changed - Hazardous Condition Changed - Appointment Set - Appointment Changed - Shipment Cancelled loadNumber: type: string description: C.H. Robinson provided identifier for the load. rate: type: number description: Rate for the load. activityDate: type: string format: date-time description: An ISO8601 UTC date-time when load is expected to be picked up. pickUpByDate: type: string format: date-time description: An ISO8601 UTC date-time indicating latest pick up date. pickUpReadyByDate: type: string format: date-time description: An ISO8601 UTC date-time indicating earliest pick up date. deliverByDate: type: string format: date-time description: An ISO8601 UTC date-time indicating latest delivery date. deliveryReadyByDate: type: string format: date-time description: An ISO8601 UTC date-time indicating earliest delivery date. mode: type: string description: Mode of the load enum: - V - R - F - H - B - Z - L totalCommodityValue: type: integer description: Value of the shipment. notes: type: string description: Notes pertaining to the load. distance: type: object description: The point-to-point distance of the haul properties: kilometers: type: number description: Distance from origin to destination in kilometers miles: type: number description: Distance from origin to destination in miles sourceUnitOfMeasure: type: string description: Unit of measurement pertaining to shipment. enum: - standard - metric chargeableWeight: type: integer description: Total chargeable weight for the shipment. flags: type: object description: Potential flagged details important to the shipment. properties: isTeamOperated: type: boolean description: Whether or not the load is a team driver shipment. isHazMat: type: boolean description: Whether or not the shipment contains hazardous materials. isRegulatedByStf: type: boolean description: Whether or not the shipment is regulated by FDA for sanitary food transportation. isTankerEndorsed: type: boolean description: Whether or not the shipment requires a tanker endorsement. hasOpenClaims: type: boolean description: Whether or not the shipment contains open damage claims. hasOpenEvents: type: boolean description: Whether or not there are open events for the shipment. isControl: type: boolean description: CH Robinson control flag. isForwardingHouse: type: boolean description: Whether or not the shipment is a House Shipment. itemContainers: type: array description: List of container details for those used to hold shipment. items: type: object properties: containerDetails: type: object description: Details for each container used in shipment properties: containerCondition: type: string description: The status of movement for a shipment container. enum: - A - F - R - X containerEmptyReturnDate: type: date-time description: Any date required to return an empty container containerLastFreeDayForEmptyReturn: type: date-time description: The last free day at a warehouse or PAD for container storage containerNumber: type: string description: Container identifier. containerStatus: type: integer description: Status of container. containerType: $ref: '#/components/schemas/shipmentContainerTypeEnum' isHot: type: boolean description: Whether or not the container is flagged as hot/priority movement vgmAcceptedDate: type: date-time description: The Verified Gross Mass cutoff datetime for the container itemContainerId: type: integer description: ID for shipping container. itemContainerType: type: integer description: ID for container type. packageDetails: type: object description: Details for each package in the shipment properties: packageType: type: description: enum: - P - S signedBy: type: string description: Name of package signer. trackingNumber: type: integer description: Tracking number for package referenceNumbers: $ref: '#/components/schemas/referenceNumber' stopActivityIds: type: array description: List of stop activity ID strings. items: type: string requiredShipmentEquipment: type: object description: Equipment required to move the shipment. properties: description: type: string description: Description of equipment height: $ref: '#/components/schemas/dimension' length: $ref: '#/components/schemas/dimension' width: $ref: '#/components/schemas/dimension' temperature: $ref: '#/components/schemas/dimension' referenceNumbers: $ref: '#/components/schemas/referenceNumber' items: type: array description: Details for all items included in the shipment. items: type: object properties: code: type: string description: User-entered commodity code for load item. executionOrderReferenceNumber: type: string description: C.H. Robinson customer order number origin for item. expectedHeight: $ref: '#/components/schemas/dimension' expectedLength: $ref: '#/components/schemas/dimension' expectedWidth: $ref: '#/components/schemas/dimension' expectedMaximumWeight: $ref: '#/components/schemas/dimension' expectedMinimumWeight: $ref: '#/components/schemas/dimension' expectedPackagingCode: $ref: '#/components/schemas/packageCodeEnum' expectedPallets: type: integer description: Expected count of pallets if used in shipment. expectedQuantity: type: integer description: Expected piece count expectedTrailerSpace: $ref: '#/components/schemas/dimension' hazMatDetails: type: object description: Additional item detail for hazardous materials. properties: class: type: string description: enum: - 1.4G - "2" - "2.1" - "2.2" - "2.3" - "3" - "4.1" - "4.2" - "4.3" - "5.1" - "5.2" - "6.1" - "7" - "8" - "9" - COMBUST - Combustibl - Consumer - ORM-D emergencyPhone: type: integer description: Emergency phone number for HazMat item. unNumberWithPrefix: type: string description: United Nations HazMat identifier with prefix. unNumber: type: integer description: United Nations HazMat identifier. itemContainerId: type: integer description: Identifier for item container. itemEquipment: type: object description: Additional detail for equipment used to move the shipment properties: coilRacksCount: type: integer description: The total coil racks required flatBedEquipmentCode: type: string description: Code associated to the type of flatbed equipment. "SD" (StepDeck), "RGN" (GooseNeck), "HS" (HotShot), "CN" (Conestoga), "CUST" (Custom), "DD" (DoubleDrop), "F" (Flatbed), "FO" (FlatbedOnly), "FD" (Flatbed or Stepdeck) enum: - SD - RGN - HS - CN - CUST - DD - F - FO - FD flatBedEquipmentDescription: type: string description: A description of the required flatbed equipment. loadingTypeDescription: type: string description: A description of loading type. maxTrailerAge: type: integer description: A requirement for trailer age in years. requiredChainsCount: type: integer description: The total chains required. requiredLocksCount: type: integer description: The total locks required. requiredSquaresCount: type: integer description: The total squares required. requiredStrapsCount: type: integer description: The total straps required. requiredTimbersCount: type: integer description: The total timbers required. tarpDescription: type: string description: A description of tarp requirement. itemSourceUnitOfMeasure: type: integer description: Whether item weight is measured as Metric or Imperial units name: type: string description: A name for the item. orderNumber: type: integer description: Order number associated to item. referenceNumber: type: integer description: A top-level reference number associated to the item referenceNumbers: $ref: '#/components/schemas/referenceNumber' temperature: type: integer description: Required temperature of item value: type: decimal description: Value of item volume: type: integer description: Volume of item books: type: array description: All booking records for the updated carrier. items: type: object properties: bookedDateTime: type: date-time description: The date and time the carrier was booked. bookId: type: integer description: The type of book. distance: type: object description: The point-to-point distance of the haul properties: kilometers: type: number description: Distance from origin to destination in kilometers miles: type: number description: Distance from origin to destination in miles expectedPickupDateTime: type: date-time description: The carrier's expected pickup date. expectedDeliveryDateTime: type: date-time description: The carrier's expected delivery date. referenceNumbers: $ref: '#/components/schemas/referenceNumber' stops: type: array description: All stops on the load associated to the carrier receiving event messages. items: type: object properties: activities: type: array description: Details associated to activities at the stop. items: type: object properties: appointment: type: object description: Details for pickup or delivery appointments. properties: closeDateTime: type: date-time description: The end time of the appointment window. isClostTimeSet: type: boolean description: Flag for whether or not an appointment end window is scheduled. isOpenTimeSet: type: boolean description: Flag for whether or not an appointment start window is scheduled openDateTime: type: date-time description: The start time of the appointment window. schedulingOptionsCode: type: string description: The code denoting what type of appointment is scheduled. bookIds: type: array description: Individual carrier book IDs associated to the stop. items: type: integer isDropTrailer: type: boolean description: Whether or not the stop requires a drop trailer activity. isRequestedTimeSet: type: boolean description: Flag for whether or not a drop trailer appointment time is scheduled. itemContainerId: type: string description: Identifier for item container picked or dropped at this stop itemIds: type: array description: List of all itemIds associated to the stop. items: type: string requestedDateTime: type: date-time description: Requested activity datetime. stopActivityId: type: string description: Association of stop to activity on the stop. stopId: type: integer description: A C.H. Robinson identifier for the specific stop. billOfLading: type: string description: Bill of Lading flag. billTos: type: array description: items: type: object properties: billToId: type: string description: Identifier for BillTo party. code: type: string description: CH Robinson identifier associated to BillTo party. referenceNumber: type: string description: Reference number for BillTo party referenceNumbers: $ref: '#/components/schemas/referenceNumber' freightTerms: $ref: '#/components/schemas/freightTermEnum' name: type: string description: Name associated to the BillTo party. address1: type: string description: First address line associated to the BillTo party. address2: type: string description: Second address line associated to the BillTo party. city: type: string description: City associated to the BillTo party. state: type: string description: State associated to the BillTo party. postalCode: type: string description: Postal Code associated to the BillTo party. email: type: string description: Contact email address associated to the BillTo party. contact: type: string description: Contact name for this stop. contactEmail: type: string description: Contact email for this stop. customerIds: type: array description: List of all Customer IDs associated to this stop. items: type: string isBlind: type: boolean description: Whether or not the consignee can see info for the shipper. note: type: string description: An internal note pertaining to the stop. loadingType: $ref: '#/components/schemas/loadingTypeEnum' referenceNumber: type: string description: Top-level reference number associated to the stop. referenceNumbers: $ref: '#/components/schemas/referenceNumber' stopId: type: integer description: The C.H. Robinson ID associated to the stop stopLocation: type: object description: Information associated to the stop location. properties: address1: type: string description: The first address line for the stop. address2: type: string description: The second address line for the stop. location: type: object description: Information associated to the stop location. properties: city: type: string description: The city for the stop. coordinate: type: object description: The geolocation for the stop. properties: lat: type: number description: The latitude coordinate for the stop. lon: type: number description: The longitude coordinate for the stop. countryCode: type: string description: The country for the stop. county: type: string description: The county for the stop. postalCode: type: string description: The postal code for the stop. stateCode: type: string description: The state abbreviation for the stop. warehouseCloseTime: type: string description: The time the location opens as defined by the ISO 8601 duration standard https://en.wikipedia.org/wiki/ISO_8601#Durations.. warehouseCode: type: string description: The C.H. Robinson code for the warehouse at the stop. warehouseCustomerLocationNumber: type: string description: A number linking Customer to warehouse warehouseName: type: string description: The name of the warehouse at the stop. warehouseOpenTime: type: string description: The time the location closes defined by the ISO 8601 duration standard https://en.wikipedia.org/wiki/ISO_8601#Durations. warehousePhoneNumber: type: string description: The contact phone for the warehouse. stopNumber: type: integer description: Identifies the stop order, beginning at 0 for the first pick. stopType: type: integer description: Identifier for type of location of the stop. timezoneOffsetInMinutes: type: integer description: Offset in minutes from GMT. needWeightScale: type: boolean description: Indicates if weight scale is needed. referenceNumbers: $ref: '#/components/schemas/referenceNumber' shipmentsSearch: type: object required: - dotNumber - origin - destination properties: carrierCode: type: string minimum: 1 maximum: 25 description: The C.H. Robinson unique identifier for a given carrier. dotNumber: type: string minimum: 1 maximum: 15 description: The Dept. of Transportation number for a given carrier. carrierPhone: type: string minimum: 1 maximum: 10 description: The carrier's phone number. regionCode: type: string default: NA format: uppercase minimum: 1 maximum: 3 description: The region to search for available shipments. enum: - NA - EU origin: $ref: '#/components/schemas/coordinate' originRadiusInMiles: type: number description: 'Number of radial miles you want to search from the origin latitude and longitude. ' destination: $ref: '#/components/schemas/coordinate' destinationRadiusInMiles: type: number description: 'Number of radial miles you want to search from the detination latitude and longitude. ' readyByOnOrAfter: type: string format: date-time description: An ISO8601 UTC date-time that can be set by partner to include loads available to be shipped on or before a specific date.. readyByOnOrBefore: type: string format: date-time description: An ISO8601 UTC date-time that can be set by the partner to include loads set to be delivered on or before a specific date. modes: $ref: '#/components/schemas/availableShipmentsModeEnum' equipmentCodes: $ref: '#/components/schemas/availableShipmentEquipmentEnum' rating: $ref: '#/components/schemas/availableShipmentsRateEnum' shouldExcludeTeamLoads: type: boolean description: Set this to true if you DO NOT want to include loads that require team drivers. shouldExcludeStfLoads: type: boolean description: Set this to true if you DO NOT want to include loads that fall under the government STF regulation. shouldExcludeTankerLoads: type: boolean description: Set this to true if you DO NOT want tanker loads. pageIndex: type: integer default: 0 description: Allows partner to set which page of the result to consume. pageSize: type: integer default: 10 description: Allows partner to set how many results are included in a page. availableShipmentCost: type: object properties: sequenceNumber: type: integer description: he C.H. Robinson unique identifier for a given cost. type: type: string description: Indicates the type if cost. sourcePerUnit: type: number format: float description: Quantity per unit units: type: number format: float description: Quantity of units. code: type: string description: Cost code description: type: string description: Description of the cost. availableShipmentLocation: type: object description: Location information. properties: warehouseCode: type: string minimum: 1 maximum: 100 description: C.H. Robinson defined identifier of a location. city: type: string minimum: 1 maximum: 50 description: City where load is picked up or deliverd. stateCode: type: string minimum: 1 maximum: 5 description: State where load is picked up or deliverd. postalCode: type: string minimum: 1 maximum: 10 description: State where load is picked up or deliverd. county: type: string minimum: 1 maximum: 50 description: County where load is picked up or deliverd. countryCode: type: string minimum: 1 maximum: 5 description: Country where load is picked up or deliverd. coordinate: $ref: '#/components/schemas/coordinate' openTime: type: string description: The time the location opens as defined by the ISO 8601 duration standar https://en.wikipedia.org/wiki/ISO_8601#Durations. closeTime: type: string description: The time the location closes defined by the ISO 8601 duration standar https://en.wikipedia.org/wiki/ISO_8601#Durations. name: type: string description: Name of the location. scheduleRequest: type: string availableShipmentStop: type: object properties: stopNumber: type: integer description: Number to indicate where in the order of stops the location is. C.H. Robinson uses a zero index. This means the \"0\" will indicate the first stop in the sequence of stops. sequenceNumber: type: integer description: System generated number applied to the location when it is entered into the system. stopType: type: string description: Stop type associated to this location. enum: - "Pick" - "Drop" - "CrossDock" - "DestinationAirport" - "DestinationPort" - "DestinationTerminal" - "IntermediaryAirport" - "IntermediaryPort" - "IntermediaryRamp" - "OriginAirport" - "OriginPort" - "OriginRamp" - "OriginTerminal" calculatedArriveByStartDateTime: type: string format: date-time calculatedArriveByEndDateTime: type: string format: date-time heavyWeight: type: integer maxWeight: type: integer warehouseInformation: $ref: '#/components/schemas/availableShipmentLocation' isScheduledOpenTimeSpecified: type: boolean isScheduledCloseTimeSpecified: type: boolean availableShipmentEquipment: type: object properties: length: $ref: '#/components/schemas/dimension' width: $ref: '#/components/schemas/dimension' height: $ref: '#/components/schemas/dimension' availableShipmentContact: type: object description: Contact information. properties: phoneNumber: type: string minimum: 1 maximum: 25 description: Phone number of the C.H. Robinson rep on the load. availableShipmentsSearchV2: type: object required: - regionCode properties: pageIndex: type: integer description: Sets the page of results. default: 0 pageSize: type: integer description: Sets the amount of results on the page. maximum: 100 default: 100 regionCode: type: string description: Indicates the region code for the request. enum: - NA - EU carrierCode: type: string description: C.H. Robinson define code that identifies a carrier. originRadiusSearch: $ref: '#/components/schemas/radiusSearch' destinationRadiusSearch: $ref: '#/components/schemas/radiusSearch' origins: type: array description: Indicates the country and state(s) to be considered for the origin. Only use this if originRadiusSearch isn't being used. items: type: object required: - countryCode - stateCodes properties: countryCode: type: string description: Indicate the country code. stateCodes: type: array description: Indicate state code(s) wanting to be considered. items: type: string destinations: type: array description: Indicates the country and state(s) to be considered for the destination. Only use this if destinationRadiusSearch isn't being used. items: type: object required: - countryCode - stateCodes properties: countryCode: type: string description: Indicate the country code. stateCodes: type: array description: Indicate state code(s) wanting to be considered. items: type: string modes: $ref: '#/components/schemas/availableShipmentsModeEnum' excludedModes: $ref: '#/components/schemas/availableShipmentsModeEnum' loadDistanceRange: type: object required: - unitOfMeasure - min - max description: Indicates min/max distance wanted. properties: unitOfMeasure: $ref: '#/components/schemas/unitOfMeasure' min: type: integer description: Minimum distance desired. max: type: integer description: Maximum distance desired. loadWeightRange: type: object required: - unitOfMeasure - min - max description: Indicates min/max weight wanted. properties: unitOfMeasure: $ref: '#/components/schemas/unitOfMeasure' min: type: integer description: Minimum weight desired. max: type: integer description: Maximum weight desired. equipmentLengthRange: type: object required: - unitOfMeasure - min - max description: Indicates min/max equipment length wanted. properties: unitOfMeasure: $ref: '#/components/schemas/unitOfMeasure' min: type: integer description: Minimum length desired. max: type: integer description: Maximum length desired. availableForPickUpByDateRange: type: object description: Set earliest and latest date window for a load to be ready by. properties: min: type: string format: date description: An ISO8601 UTC date used to indicate the earliest ready by date. max: type: string format: date description: An ISO8601 UTC date used to indicate the latest ready by date. specializedEquipmentCode: description: Depending on the region code you will use a code from one of the lists below. oneOf: - $ref: '#/components/schemas/specializedEquipmentCodeNAEnum' - $ref: '#/components/schemas/specializedEquipmentCodeEUEnum' teamLoad: type: boolean description: Indicate if team loads are returned in results alongside non-teamLoad loads. If exluding these types of loads is desired, "false" must be sent. default: true stfLoad: type: boolean description: Indicate if STF loads are returned in results alongside non-STF loads. If exluding these types of loads is desired, "false" must be sent. default: true hazMatLoad: type: boolean description: Indicate if Hazmat loads are returned in results alongside non-hazmat loads. If exluding these types of loads is desired, "false" must be sent. default: true tankerLoad: type: boolean default: true description: Indicate if Tanker loads are returned in results alongside non-tanker loads. If exluding these types of loads is desired, "false" must be sent. chemicalSolutionLoad: type: boolean description: Indicate if Chemical Solution loads are returned in results alongside non-Chemical solution loads. If exluding these types of loads is desired, "false" must be sent. default: true highValueLoad: type: boolean description: Indicate if High Value loads are returned in results alongside non-High value loads. If exluding these types of loads is desired, "false" must be sent. default: true sortCriteria: type: object description: Allows user to sort results. required: - field - direction properties: field: type: string description: Selection the criteria for sorting results. enum: - "LoadNumber" - "OriginCity" - "CalculatedPickupByDateTime" - "Distance" - "DestinationCity" - "CalculatedDeliverByDateTime" - "Weight" - "Mode" - "OriginDeadHeadDistance" direction: type: string description: Select either Ascending or Descending. enum: - ascending - descending availableShipmentsResponseV2: type: object properties: results: $ref: '#/components/schemas/availableShipmentV2' totalResults: type: integer description: Number of loads available from the query. availableShipmentV2: type: array description: Contains the information of available loads. items: type: object required: - origin - destination properties: loadNumber: type: integer format: base32 integer description: C.H. Robinson provided shipment identifier. origin: $ref: '#/components/schemas/availableShipmentLocation' destination: $ref: '#/components/schemas/availableShipmentLocation' distance: $ref: '#/components/schemas/distance' weight: $ref: '#/components/schemas/weight' readyBy: type: string format: date-time description: An ISO8601 UTC date-time that can be set by partner to include loads available to be shipped on or before a specific date. deliverBy: type: string format: date-time description: An ISO8601 UTC date-time that can be set by the partner to include loads set to be delivered on or before a specific date. equipment: $ref: '#/components/schemas/availableShipmentEquipment' specializedEquipment: allOf: - type: object properties: code: type: string description: Code of specialized equipment. description: type: string description: Description of specialized equipment. - $ref: '#/components/schemas/availableShipmentEquipment' hasDriverWork: type: boolean description: Indication if work is required by the driver. stopCount: type: integer description: Indicates how many stops are on the shipment. carrierTier: type: string enum: - None - Base - Core - Key - DoesNotApply - New - Managed - ManagedBase description: 'The program, if any, the shipment is a part of.' isOkToAdvertise: type: boolean description: Indicates if load is classified as okay to advertise. isDatOk: type: boolean description: Indicates if load is classified as a DAT load. isHazMat: type: boolean description: Indicates if load is classified as a HazMat. isTeamLoad: type: boolean description: Indicates if load is classified as needing a driver team. isRegulatedByStf: type: boolean description: Indicates if load is classified as STF regulated. isTankerEndorsementRequired: type: boolean description: Indicates if load is classified as needing driver to have tanker endorsement. isTest: type: boolean description: Indicates if load is a test load. isWebDisplayable: type: boolean sourceUom: $ref: '#/components/schemas/unitOfMeasure' regionCode: type: string description: Indicates region the load resides in. comment: type: string description: 'Displays, if any, comments associated to the load.' contact: $ref: '#/components/schemas/availableShipmentContact' rating: $ref: '#/components/schemas/availableShipmentsRateEnum' modes: type: array items: $ref: '#/components/schemas/availableShipmentsModeEnum' hasDropTrailer: type: boolean description: Indicates is load is a drop trailer. deliveryAvailableDate: type: string format: date description: Indicates the date the shipment is available for delivery. stops: type: array description: An array of all the stops on the shipment. items: $ref: '#/components/schemas/availableShipmentStop' pickUpByDate: type: string format: date description: Indicates the date the shipment is available for pick up. activityDate: type: string format: date description: Indicates the current activity date of the load. minimumLogipoints: type: number format: float availableLoadCosts: type: array description: Array of load costs items: $ref: '#/components/schemas/availableLoadCost' deadHeadDistance: type: number description: Deadhead mileage from search origin to load origin. reeferSetting: type: string description: Indicates the reefer setting. reeferTemperature: $ref: '#/components/schemas/availableShipmentTemperature' maxTemp: $ref: '#/components/schemas/availableShipmentTemperature' minTemp: $ref: '#/components/schemas/availableShipmentTemperature' availableForPickUp: type: object description: Set earliest and latest date window for a load to be ready by. properties: startDate: type: string format: date description: An ISO8601 UTC date-time used to indicate the start date. endDate: type: string format: date description: An ISO8601 UTC date-time used to indicate the end date. minimum: type: string format: date description: An ISO8601 UTC date-time used to indicate the earliest available for pick up by date. maximum: type: string format: date description: An ISO8601 UTC date-time used to indicate the latest available for pick up by date. minimumCargoManagementPoints: type: number description: minimum cargo management points isNotOfferable: type: boolean description: bookingContactPhoneNumber: type: string description: Contact phone number. isTwicCardRequired: type: boolean description: isPersonalProtectiveEquipmentRequired: type: boolean description: Are personal protective equipment required. hasOverDimensionalItems: type: boolean description: has over dimensional items isHeavyHaul: type: boolean description: is a heavy haul load_join: type: string description: load join createdDateTime: type: string format: date description: An ISO8601 UTC date-time. updatedDateTime: type: string format: date description: An ISO8601 UTC date-time. assignedRep: type: string description: The Rep assigned. calculatedPickUpByDateTime: type: string format: date description: An ISO8601 UTC date-time. calculatedDeliverByDateTime: type: string format: date description: An ISO8601 UTC date-time. availableLoadCost: type: object description: Object containing load cost. properties: loadNumber: type: integer description: C.H. Robinson shipment number. carrierCode: type: string description: C.H. Robinson carrier identifier. expirationDate: type: string format: date description: An ISO8601 UTC date-time used to indicate the expiration date of the cost. type: type: string description: Indicates the type of cost. code: $ref: '#/components/schemas/rateCodeEnum' description: type: string description: Cost description. sourceCostPerUnit: type: number description: Amount of cost by unit. To derive total cost take sourceCostPerUnit and multiply by units. units: type: number description: Count of the cost. currencyCode: $ref: '#/components/schemas/currencyCodeEnum' employeeCode: type: string description: C.H. Robinson employee identifier. employeeBranch: type: integer description: C.H. Robinson employee branch identifier. score: type: number description: Score createdDateTime: type: string format: date description: An ISO8601 UTC date-time used to indicate the creation date of the cost. updatedDateTime: type: string format: date description: An ISO8601 UTC date-time used to indicate the updated date of the cost. binCostKey: type: string description: C.H. Robinson generate GUID. binOfferable: type: boolean description: Indicates if this is available for offer. availableShipmentTemperature: type: object description: Temperature control properties: metric: type: number description: Temperature metricUom: type: string enum: - Fahrenheit - Celsius standard: type: number description: Temperature standardUom: type: string enum: - Fahrenheit - Celsius saltRate: allOf: - $ref: '#/components/schemas/bookSaltRate' - type: object properties: currencyCode: $ref: '#/components/schemas/currencyCodeEnum' costs: type: array items: $ref: '#/components/schemas/availableShipmentCost' totalCost: type: number format: float description: Total cost. bookSaltRate: type: object required: - costQuoteId - costQuoteSequenceNumber - carrierCode properties: costQuoteId: type: integer description: Internal C.H. Robinson identifier for the cost quote. costQuoteSequenceNumber: type: integer description: System generated number applied to the cost quote. carrierCode: type: string description: The C.H. Robinson unique identifier for a given carrier. coordinate: type: object required: - lat - lon properties: lat: type: number format: float minimum: -90 maximum: 90 description: Latitude of given location. lon: type: number format: float minimum: -180 maximum: 180 description: Longitude of given location. radiusSearch: type: object required: - coordinate - radius description: Sets the coordinates and radial distance. properties: coordinate: $ref: '#/components/schemas/coordinate' radius: type: object required: - value - unitOfMeasure description: Allows the setting of radius with the lat/long being the center of the radius. properties: value: type: number format: float description: Indicates the distance of radial circle around lat/lon point. unitOfMeasure: $ref: '#/components/schemas/unitOfMeasure' unitOfMeasure: type: string description: Indicates Standard or Metric. default: Standard enum: - Standard - Metric distance: type: object description: Total miles and kilometers of the load. properties: miles: type: number format: float description: Total distance in miles of the load. kilometers: type: number format: float description: Total distance in kilometers of the load. weight: type: object description: Total pounds and kilograms. properties: pounds: type: number format: float description: Total weight in pounds of the load. kilograms: type: number format: float description: Total weight in kilograms of the load. dimension: type: object description: Dimensions. properties: standard: type: number format: float description: Dimension in standard format. metric: type: number format: float description: Dimension in metric format. milestone: type: object description: Shipment update required: - eventCode - dateTime - shipmentIdentifier - location properties: transitType: description: Defines the type of movement the event is for. enum: - Road - Ocean - Rail - Air eventCode: description: Depending on the transitType you will use a code from one of the lists below. oneOf: - $ref: '#/components/schemas/roadMilestoneEventCodeEnum' - $ref: '#/components/schemas/oceanMilestoneEventCodeEnum' - $ref: '#/components/schemas/railMilestoneEventCodeEnum' - $ref: '#/components/schemas/airMilestoneEventCodeEnum' shipmentIdentifier: $ref: '#/components/schemas/shipmentIdentifier' dateTime: $ref: '#/components/schemas/dateTime' carrier: $ref: '#/components/schemas/milestoneCarrier' location: $ref: '#/components/schemas/milestoneLocation' items: type: array description: Array of items tied to the milestone. items: $ref: '#/components/schemas/milestoneItem' supplementalInformation: $ref: '#/components/schemas/supplementalInformation' dateTime: type: object description: "Object containing the different types of dates that can apply to a milestone. \n\n ### At least one needs to be present." properties: eventDateTime: type: string format: date-time description: ISO8601 UTC date-time of the milestone for event code not pertaining to ETA or appointment. estimatedTimeOfArrival: type: string format: date-time description: ISO8601 UTC date-time when event code pertains to ETA. appointmentWindow: type: object description: The date/time window when an appointment has been set. If there is no window, put the same date/time in both the openDateTime and closeDateTime fields. properties: openDateTime: type: string format: date-time description: ISO8601 UTC date-time of earliest time carrier will be arriving. closeDateTime: type: string format: date-time description: ISO8601 UTC date-time of latest time carrier will be arriving. shipmentIdentifier: type: object description: "A list of different common reference numbers that can be used to identify the shipment the milestone is intended for. \n\n ### At least one ship identifier needs to be present." properties: shipmentNumber: type: string minimum: 1 maximum: 20 description: Defined ID for the shipment. Usually the C.H. Robinson load number. shipperBillToId: type: string minimum: 1 maximum: 50 description: Shipper defined Bill To reference number for the shipment. proNumber: type: string minimum: 1 maximum: 20 description: Carrier defined pro number for the shipment. trackingNumber: type: string minimum: 1 maximum: 150 description: Carrier or customer defined tracking number for the shipment. containerNumber: type: string minimum: 1 maximum: 20 description: Carrier or customer defined container number for the shipment. milestoneLocation: type: object description: Location information associated to the milestone. required: - address properties: type: $ref: '#/components/schemas/milestoneStoptypeEnum' stopSequenceNumber: type: integer description: "Identifies the stop number the milestone is associated to. \n\n ### If location is for a milestone that isn't tied to a stop then this field should be set to null." sequenceNumber: type: integer description: "Identifies the sequence number the milestone is associated to. \n\n ### If location is for a milestone that isn't tied to a stop then this field should be set to null." name: type: string description: Identifies the name of the location the milestone is associated to. If location is for a milestone that isn't tied to a stop then this field should be set to null. locationId: type: string description: Milestone location identifier. unlocationCode: type: string description: The UN Location Code for the milestone location. minimum: 1 maximum: 10 iata: type: string description: The IATA code for the milestone location. address: $ref: '#/components/schemas/milestoneLocationAddress' supplementalInformation: type: object description: Allows updating entity to provide additional details pertaining to the milestone. properties: reasonCode: $ref: '#/components/schemas/lateCodeEnum' notes: type: string description: Allows updating entity to provide any notations pertaining to the milestone. milestoneCarrier: type: object description: Carrier information associated to the milestone. required: - name properties: name: type: string minimum: 1 maximum: 50 description: Name of carrier executing shipment. milestoneSource: type: string description: Source of the milestone, if not sent by the carrier. dotNumber: type: string description: United States of America government issued identification number for a carrier. mcNumber: type: string description: A legal serialization each carrier has from an operating authority to operate their carrier business. carrierCode: type: string description: "C.H. Robinson defined code for the carrier. \n\n ### Although not a validation requirement, not having carrierCode could impact the update from applying to the shipment that is managed by C.H. Robinson." scac: type: string description: In North America this is the Nmfta defined standard carrier alpha code. sealNumber: type: string description: If trailer has a seal, the identifier of the seal. temperature: type: number format: float description: Idenifies the temperature at the time of the milestone. temperatureUnitOfMeasure: $ref: '#/components/schemas/temperatureUomEnum' vehicleDetail: $ref: '#/components/schemas/vehicleDetail' flightDetail: $ref: '#/components/schemas/flightDetail' vesselDetail: $ref: '#/components/schemas/vesselDetail' railDetail: $ref: '#/components/schemas/railDetail' vehicleDetail: type: object description: Identifies vehicle information. properties: tractorNumber: type: string description: Identifier of the powered unit transporting the shipment. trailerNumber: type: string description: Identifier of the trailer the shipment resides in. licensePlate: type: string description: License plate of the powered unit. licensePlateState: type: string description: State the license plate was issued vin: type: string description: Vehicle idendification number of the powered unit. contactInformation: $ref: '#/components/schemas/vehicleContact' flightDetail: type: object description: Identifies flight information. properties: flightNumber: type: string description: Identifies the flight number. flightDepartureDateTime: type: string format: date-time description: The date/time the flight departed. flightCarrierCode: type: string description: Code associated to the flight provider. railDetail: type: object description: Identifies rail information. properties: sightingCode: type: string description: Rail specific event codes. trainNumber: type: string description: Identifies the train the miletsone refers to. vesselDetail: type: object description: Identifies vessel information. properties: vesselName: type: string description: Identifies the name of the vessel. voyageNumber: type: string description: Identifies the voyage number.. vesselIMONumber: type: string description: Identifies vessel IMO number. hullNumber: type: string description: Identifies the hull number of the vessel. vehicleContact: type: object description: Contact information. properties: driverName: type: string description: Name of the driver associated to the milestone. driverPhone: type: string description: Phone number of the driver associated to the milestone. secondDriverName: type: string description: In instances of driver teams, name of the second driver associated to the milestone. secondDriverPhone: type: string description: In instances of driver teams, phone number of the second driver associated to the milestone. dispatchName: type: string description: Name of individual at carrier dispatch center. dispatchPhone: type: string description: Phone number of carrier dispatcher. milestoneItem: type: object description: Item totals associated to milestone. properties: itemId: type: string description: Unique identifier of line item. weight: type: number description: Acutal weight of line item. weightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' quantity: type: number description: Acutal quantity of line item. pallets: type: number description: Quantity of pallet(s). emptyLocation: type: object required: - city - state - country description: Indicates the location of the carrier where they are empty and moving towards the pick up location. properties: city: type: string description: Indicates the city the carrier is empty. minimum: 1 maximum: 50 stateProvinceCode: type: string description: Indicates the state/province code the carrier is empty. minimum: 1 maximum: 50 postalCode: type: string description: Indicates the postal code the carrier is empty. minimum: 1 maximum: 20 country: $ref: '#/components/schemas/countryCodeEnum' rateConfirmation: type: object required: - name - emailAddress description: Indicates the individual who is confirming the rate. properties: name: type: string description: Name of the person who is confirming the rate. minimum: 1 maximum: 50 email: type: string description: E-mail address of the person who is confirming the rate. minimum: 1 maximum: 50 driver: type: object description: Object to provide driver information. properties: firstName: type: string description: Driver's first name. minimum: 1 maximum: 50 lastName: type: string description: Driver's last name. minimum: 1 maximum: 50 phoneNumber: type: string description: Driver's phone number. minimum: 1 maximum: 50 loadBook: type: object description: JSON payload to book a carrier to an available shipment. properties: associateStops: type: array description: Indicates the associated stop numbers the carrier will be tied to. This information is provided in the response of the available shipment call. items: type: integer bookedWith: type: string minimum: 1 maximum: 50 rateConfirmation: $ref: '#/components/schemas/rateConfirmation' driver: $ref: '#/components/schemas/driver' emptyLocation: $ref: '#/components/schemas/emptyLocation' tractorNumber: type: string description: Identifier of the powered unit transporting the shipment. minimum: 1 maximum: 50 trailerNumber: type: string description: Identifier of the trailer the shipment resides in. minimum: 1 maximum: 50 emptyDateTime: type: string format: date-time description: Indicates the date/time the trailer is empty and driver is on his way to the pick up. saltRate: $ref: '#/components/schemas/bookSaltRate' truckId: type: integer currencyCode: $ref: '#/components/schemas/currencyCodeEnum' bookedBy: type: string minimum: 1 maximum: 50 loadBookV2: type: object description: JSON payload to book a carrier to an available shipment. required: - loadNumber - carrierCode - emailAddress - availableLoadCosts - rateConEmail - rateConName properties: loadNumber: type: integer format: base32 integer description: C.H. Robinson provided shipment identifier. carrierCode: type: string description: C.H. Robinson defined code for the carrier. emptyDateTime: type: string format: date-time description: ISO8601 UTC date-time the trailer is empty and driver is on his way to the pick up. emptyLocation: $ref: '#/components/schemas/emptyLocationV2' availableLoadCosts: type: array description: Array of the bin cost object. The fields for this object are informed by the avaialble shipments response message (availableLoadCost) minimum: 1 items: $ref: '#/components/schemas/binCost' rateConfirmation: $ref: '#/components/schemas/rateConfirmation' emptyLocationV2: type: object required: - city - state - country description: Indicates the location of the carrier where they are empty and moving towards the pick up location. properties: city: type: string description: Indicates the city the carrier is empty. state: type: string description: Indicates the state/province code where the carrier is empty. country: $ref: '#/components/schemas/countryCodeEnum' zip: type: string description: Indicates the postal code the carrier is empty. binCost: type: object description: Book it now cost object that is informed by the avaialble shipments response message (availableLoadCost). required: - currencyCode - sourceCostPerUnit - units properties: type: type: string description: Indicates the type of cost. code: $ref: '#/components/schemas/rateCodeEnum' description: type: string description: Cost description. currencyCode: $ref: '#/components/schemas/currencyCodeEnum' sourceCostPerUnit: type: number format: float description: Amount of cost by unit. units: type: integer description: Count of the cost. loadOffer: type: object description: Object to use for submitting load offer. required: - carrierCode - offerPrice properties: carrierCode: type: string description: C.H. Robinson defined code for the carrier making the offer. offerPrice: type: integer description: Amount carrier would like to offer on the load. offerNote: type: string description: Any note the carrier would like to send along with the offer. currencyCode: type: string default: USD description: Currency code of the offer amount. offerAcknowledgment: type: object properties: offerRequestId: type: string description: Unique identifier that is associated with the offer request. offerResponse: type: object description: Object with response to carrier offer. properties: loadNumber: type: string description: ID of the shipment the offer was made on. carrierCode: type: string description: C.H. Robinson defined code for the carrier making the offer. offerRequestId: type: string description: Unique identifier that is associated with the offer request. This is the ID received in the response when making the offer. offerId: type: string description: C.H. Robinson's internal id associated to the offer. offerResult: type: string description: Current status of the offer. Rejected and NotConsidered can both be considered declining the offer. Counter means C.H. Robinson has countered with a new price. enum: - Accepted - Rejected - NotConsidered - Counter price: type: integer description: Price of the offer. If the offerResult is "Counter" then the price displayed is C.H. Robinson's counter offer price. currencyCode: type: string description: Currency code of the offer amount. rejectReasons: type: array description: If offer is rejected this details the reason(s). items: type: string #---PurchaseOrder-------------------------------------------------------------------------------------- purchaseOrder: type: object required: - customerCode - customerPONumber - purchaseOrderItems properties: customerCode: type: string minimum: 1 maximum: 50 description: C.H. Robinson defined customer code. customerPONumber: type: string minimum: 1 maximum: 50 description: Customer defined purchase order number. customerCreatedDate: type: string format: date-time description: An ISO8601 UTC date-time that indicates when the PO was created in the customers system. customerName: type: string minimum: 1 maximum: 50 description: Name of the customer. customerContacts: type: array minimum: 1 description: Contact for the Customer. items: $ref: '#/components/schemas/customerContact' incoLocation: type: string minimum: 1 maximum: 50 description: Location the inco terms applies to. incoTerms: $ref: '#/components/schemas/incoTermsEnum' purchaseOrderItems: type: array minimum: 1 description: The items in the Purchase Order. items: $ref: '#/components/schemas/purchaseOrderItem' purchaseOrderItem: type: object required: - innerPackType - outerPackType properties: customerPoLineNumber: type: string minimum: 1 maximum: 50 description: Customer PO line number for a given Item. poLineItemValue: type: string minimum: 1 maximum: 50 description: Value of the Item(s). productName: type: string minimum: 1 maximum: 50 description: Name of the product. freightTerms: type: string description: > Terms state who is responsible for paying the freight charges. * 'CL' - Collect Freight Terms * 'PP' - Prepaid Freight Terms * 'TP' - Third Party Freight Terms * 'PC' - Prepaid and Add Freight Terms * 'CC' - The Bill To is paying via a Credit Card enum: - "CL" - "PP" - "TP" - "PC" - "CC" cpsiaTestRequired: type: boolean description: Indicates if Consumer Product Safety Improvement Act (CPSIA) testing is required. cpsiaTestPassed: type: boolean description: Indicates if the product passed the Consumer Product Safety Improvement Act (CPSIA) assement. itemPackedQty: type: integer description: Item packed quantity. innerPackInsuranceValue: type: number format: float description: Insureance value of the inner packed item. innerPackType: $ref: '#/components/schemas/packageCodeEnum' innerPackQuantity: type: number format: float description: Quanity of inner packed items. innerPackHeight: type: number format: float description: Height of inner packed items. innerPackLength: type: number format: float description: Length of inner packed items. innerPackWidth: type: number format: float description: Width of inner packed items. innerPackUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' innerPackWeight: type: number format: float description: Weight of Innerpacked Items. innerPackWeightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' outerPackHeight: type: number format: float description: Height of outer packed items. outerPackWeight: type: number format: float description: Weight of outer packed items. outerPackLength: type: number format: float description: Length of outer packed items. outerPackWidth: type: number format: float description: Width of outer packed items. outerPackUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' outerPackWeightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' description: Type of Unit of Measure for weight. outerPackType: $ref: '#/components/schemas/packageCodeEnum' outerPackStuffingQty: type: number format: float description: Quanity of outer packed items. partNumber: type: string minimum: 1 maximum: 50 description: Customer Part Number. productCode: type: string minimum: 1 maximum: 50 description: Product code for the line item. sku: type: string minimum: 1 maximum: 50 description: SKU for the line item. requestedBookingDate: type: string format: date-time description: An ISO8601 UTC date-time that indicates the requested booking date. requestedPickupDate: type: string format: date-time description: An ISO8601 UTC date-time that indicates the requested pickup date. requestedDeliveryDate: type: string format: date-time description: An ISO8601 UTC date-time that indicates the requested delievery date. locations: type: array minimum: 1 description: The locations assoicaed to the purchase order. items: $ref: '#/components/schemas/purchaseOrderLocation' parties: type: array minimum: 1 description: The parties assoicaed to the purchase order. items: $ref: '#/components/schemas/party' suppliers: type: array minimum: 1 description: The suppliers assoicaed to the purchase order. items: $ref: '#/components/schemas/supplier' purchaseOrderLocation: type: object properties: name: type: string minimum: 1 maximum: 50 description: Name of the location. addresses: type: array minimum: 1 description: Address assoicted to this location. items: $ref: '#/components/schemas/purchaseOrderAddress' stopType: type: string minimum: 1 maximum: 50 description: Stop type associated to this location. stopSequence: type: string minimum: 1 maximum: 50 description: Stop sequnece of this location. relatedParties: type: array items: $ref: '#/components/schemas/relatedParty' contact: type: array minimum: 1 description: Contact associated to this location. items: $ref: '#/components/schemas/customerContact' purchaseOrderAddress: type: object required: - address1 - city - stateProvinceCode - postalCode - country properties: address1: type: string minimum: 1 maximum: 50 description: Indicate address line 1. address2: type: string minimum: 1 maximum: 50 description: Indicate address line 2. city: type: string minimum: 1 maximum: 30 description: Indicate the city of the location stateProvinceCode: type: string minimum: 1 maximum: 50 description: Indicate the state or province of the location. postalCode: type: string minimum: 1 maximum: 15 description: Indicate the postal code of the location. country: type: string minimum: 1 maximum: 30 description: Indicate the county of the location. party: type: object required: - partyId properties: partyName: type: string minimum: 1 maximum: 50 description: Name of the Party addresses: type: array minimum: 1 description: Address assoicted to this party. items: $ref: '#/components/schemas/purchaseOrderAddress' partyId: type: number description: ID associated to this party. relatedParties: type: array items: $ref: '#/components/schemas/relatedParty' relatedParty: type: object required: - partyId properties: partyName: type: string minimum: 1 maximum: 50 description: Name of the Party. addresses: type: array description: Address associated to this party. items: $ref: '#/components/schemas/purchaseOrderAddress' partyId: type: number description: ID associated to this party. purchaseOrderContactMethod: type: object properties: method: type: string description: Method of contact. enum: - 'Phone' value: type: string minimum: 1 maximum: 50 description: Value associated to the method (aka phone number). customerContact: type: object required: - contactMethods properties: name: type: string minimum: 1 maximum: 50 description: Name of the contact. contactMethods: type: array description: Types of contact methods. items: $ref: '#/components/schemas/purchaseOrderContactMethod' supplier: type: object properties: supplierId: type: string minimum: 1 maximum: 50 description: Id associated to the supplier. supplierName: type: string minimum: 1 maximum: 50 description: Name of the supplier. addresses: type: array description: Address associated to the supplier. items: $ref: '#/components/schemas/purchaseOrderAddress' contact: type: array minimum: 1 description: Contact associated to the supplier. items: $ref: '#/components/schemas/customerContact' #---Visibility----------------------------------------------------------------------------------------- #---Visibility----------------------------------------------------------------------------------------- shipments: type: object required: - shipmentNumber - orderNumbers - tenantId - stops - commodities - mode properties: shipmentNumber: type: string minimum: 1 maximum: 20 description: Shipment Number associated to the shipment. tenantId: type: string minimum: 1 maximum: 20 description: This ID indicates who the underlying customer is. trackingNumber: type: string minimum: 1 maximum: 150 description: Tracking number associated to the shipment. accountCode: type: string minimum: 1 maximum: 50 description: Account code associated to the shipment. carrierName: type: string minimum: 1 maximum: 100 description: Name of the carrier scac: type: string minimum: 1 maximum: 20 description: SCAC code associated to the shipment. carrierProNumber: type: string minimum: 1 maximum: 50 description: Carrier Pro number trailerNumber: type: string minimum: 1 maximum: 20 description: Trailer Number customerName: type: string minimum: 1 maximum: 100 description: Customer Name equipmentType: type: string minimum: 1 maximum: 50 description: Equipment type on the shipment mode: type: string minimum: 1 maximum: 20 description: Mode of the shipment. enum: - "AIR" - "OCEAN" - "TRUCKLOAD" - "LTL" - "OPENDECK" - "PARCEL" - "RAIL" - "INTERMODAL" containerInformation: type: array description: Array of the Containers associated to the shipment. items: $ref: '#/components/schemas/containerInformation' shipmentDistance: type: string minimum: 1 maximum: 20 description: Total shipment distance as calculated by the customer's standard contracts. shipmentDistanceUnitOfMeasure: $ref: '#/components/schemas/distanceUomEnum' isPremiumFreight: type: boolean description: Is the freight delivered at a premium or expedited service level by the provider? movementType: type: string description: Indicates type of movement. isManaged: type: boolean description: Is the freight shipped in a planned, mangaged capacity? teuCount: type: string minimum: 1 maximum: 20 description: Count of Twenty Foot Equivalent Unit(s) teid to the shipment incoLocation: type: string minimum: 1 maximum: 50 description: Named place for incoterm incoTerms: $ref: '#/components/schemas/incoTermsEnum' orderNumbers: type: array description: Array of the Order numbers associated to the shipment. minimum: 1 maximum: 25 items: type: string canceled: type: boolean description: Is the shipment canceled? highValue: type: boolean description: Does the shipment contain goods that are of high value? forwarder: type: string description: The name of the forwarder minimum: 1 maximum: 200 stops: type: array description: Array of the Stops associated to the shipment. items: $ref: '#/components/schemas/stop' handlingUnits: type: array description: Array of the commodities associated to the shipment. items: $ref: '#/components/schemas/handlingUnit' referenceNumbers: type: array description: Array of the referenceNumbers associated to the shipment. items: $ref: '#/components/schemas/referenceNumber' visibilityOrder: type: object description: Order Created by the Shipper required: - orderNumber - createdDateTime - tenantId properties: customerName: type: string minimum: 1 maximum: 20 description: Customer Name example: Your Customer Name orderNumber: type: number minimum: 1 maximum: 20 description: Order Number example: 03647809 tenantId: type: string minimum: 1 maximum: 20 description: This ID indicates who the underlying customer is. accountType: type: string minimum: 1 maximum: 10 description: Business unit or Product group associated to this order example: Parts orderStatus: type: string minimum: 1 maximum: 10 description: Current status of order. enum: - active - cancelled - planned premiumFreightReasonCode: type: string minimum: 1 maximum: 50 description: Reason code for order's expedited or premium service metadata: type: string description: meta data assoicted to the order createdDateTime: type: string format: date-time description: An ISO8601 UTC date-time sourceName: type: string minimum: 1 maximum: 20 description: Source Name with the order packagingType: $ref: '#/components/schemas/packageCodeEnum' quantity: type: number description: Quantities on the order. weight: type: number description: Total Weight of the order. format: float example: 45000 weightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' orderLength: type: number description: The length of the order's packaging. format: float example: 48 ordergWidth: type: number description: The width of the order's packaging. format: float example: 40 orderHeight: type: number description: The height of the order's packaging. format: float example: 48 orderUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' volume: type: number description: The volume of the order's packaging. volumeUnitOfMeasure: $ref: '#/components/schemas/volumeUomEnum' locations: type: array items: $ref: '#/components/schemas/visibilityLocation' handlingUnits: type: array items: $ref: '#/components/schemas/handlingUnit' visibilityLocation: type: object description: All locations associated with the order. required: - locationId - sequenceNumber - stopRole - name - address1 - countryCode properties: locationId: type: string minimum: 1 maximum: 20 description: Unique Identifier sequenceNumber: type: number description: Beginning at 0, increasing sequentially with each location in stop order stopRole: type: string description: Stop role of the location enum: - "pick" - "drop" - "crossDock" - "destinationAirport" - "destinationPort" - "destinationTerminal" - "intermediaryAirport" - "intermediaryPort" - "intermediaryRamp" - "originAirport" - "originPort" - "originRamp" - "originTerminal" - "originForwarder" - "originCrossdock" - "destinationForwarder" - "destinationCrossdock" - "destinationRamp" - "dropyard" - "supplier" - "shipper" - "consignee" - "origin" - "destination" - "broker" - "agent" - "factory" name: type: string minimum: 1 maximum: 200 description: Name of the location address1: type: string minimum: 1 maximum: 100 description: Indicate address line 1 address2: type: string minimum: 1 maximum: 100 description: Indicate address line 2 city: type: string minimum: 1 maximum: 100 description: Indicate City stateProvinceCode: type: string minimum: 1 maximum: 50 description: Indicate State or Province postalCode: type: string minimum: 1 maximum: 20 description: Indicate Postal codes countryCode: type: string minimum: 1 maximum: 2 description: Indicate 2 digit country code utilizing ISO 3166-1 alpha-2 requested: type: string format: date-time description: Order need by date, enter close date time if window time is provided in an ISO8601 format. openDateTime: type: string format: date-time description: Beginning of order need by window, enter requested date if no window time is provided in an ISO8601 format. closeDateTime: type: string format: date-time description: End of order need by window, enter requested date if no window time is provided in an ISO8601 format. unlocationCode: type: string description: The UN Location Code for the stop location. minimum: 1 maximum: 10 iata: type: string description: International Air Transport Association (IATA) minimum: 1 maximum: 10 referenceNumbers: type: array description: Array of the Stops associated to the shipment. items: $ref: '#/components/schemas/referenceNumber' stop: type: object required: - type - value - orderNumbers properties: orderNumbers: type: array description: Array of the Order numbers associated to the shipment. items: type: string actualArriveDateTime: type: string format: date-time description: An ISO8601 UTC date-time actualDepartDateTime: type: string format: date-time description: An ISO8601 UTC date-time locations: type: array items: $ref: '#/components/schemas/visibilityLocation' handlingUnit: type: object description: Object containing commodity (or group of commodities) required: - locations - items properties: handlingUnitId: type: string minimum: 1 maximum: 20 description: Handling unit ID orderNumbers: type: array description: Array of the Order numbers associated to the handling units. minimum: 1 maximum: 25 items: type: string packagingType: $ref: '#/components/schemas/packageCodeEnum' quantity: type: number description: Quantity of handling units freightClass: $ref: '#/components/schemas/freightClassEnum' weight: type: number description: Total Weight of the item. format: float example: 45000 weightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' packagingLength: type: number description: The length of the item's packaging. format: float example: 48 packagingWidth: type: number description: The width of the item's packaging. format: float example: 40 packagingHeight: type: number description: The height of the item's packaging. format: float example: 48 packagingUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' packageTrackingNumber: type: string minimum: 1 maximum: 150 description: Package Tracking Number volume: type: number description: The volume of the item's packaging volumeUnitOfMeasure: $ref: '#/components/schemas/volumeUomEnum' containerNumber: type: string minimum: 1 maximum: 20 description: Container Number description: type: string minimum: 1 maximum: 100 description: Description of the handling unit. pickLocSequenceNumber: type: integer description: The associated stop sequence number for which this handling unit will be picked up. dropLocSequenceNumber: type: integer description: The associated stop sequence number for which this handling unit will be delivered. commodities: type: array items: $ref: '#/components/schemas/commodity' commodity: required: - pickLocSequenceNumber - dropLocSequenceNumber type: object properties: commodityId: type: string minimum: 1 maximum: 20 description: Unique identifier orderNumber: type: string minimum: 1 maximum: 20 description: Indicates the order number associated to the item. name: type: string minimum: 1 maximum: 50 description: Name of the commodity. units: type: number minimum: 1 maximum: 50 description: Number of commodities. sku: type: string minimum: 1 maximum: 50 description: Indicates the sku of the commodity. plannerCode: type: string minimum: 1 maximum: 50 description: The Planners Code associated to the commodity. value: type: number minimum: 1 maximum: 50 description: Value of the commodity. currencyCode: type: string minimum: 1 maximum: 10 description: ISO 4217 currency code serialNumber: type: string minimum: 1 maximum: 50 description: Serial Number of the commodity. partNumber: type: string minimum: 1 maximum: 50 description: Part Number of the commodity. isHazMat: type: boolean description: Flag indicates if the commodity is Hazmat. pickLocSequenceNumber: type: integer description: The associated pick location sequence number. dropLocSequenceNumber: type: integer description: The associated drop location sequence number. category: type: string minimum: 1 maximum: 50 description: Category of the commodity, model number or other categorization descriptor. description: type: string minimum: 1 maximum: 100 description: Description of the item. packagingType: $ref: '#/components/schemas/packageCodeEnum' weight: type: number description: Total Weight of the item. format: float example: 45000 weightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' packagingLength: type: number description: The length of the item's packaging. format: float example: 48 packagingWidth: type: number description: The width of the item's packaging. format: float example: 40 packagingHeight: type: number description: The height of the item's packaging. format: float example: 48 packagingUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' packagingVolume: type: number format: float description: Volume of the item. example: 7680 packagingVolumeUnitOfMeasure: $ref: '#/components/schemas/volumeUomEnum' packageQuantity: type: number format: float description: Quantity of Packages. example: 10 purchaseOrderNumber: type: string minimum: 1 maximum: 20 format: float description: Purchase Order number for associated item. costCenterCode: type: number minimum: 1 maximum: 10 format: float description: Cost center code associated to the items. referenceNumbers: type: array description: Reference number associated to the given level. items: $ref: '#/components/schemas/referenceNumber' invoice: required: - invoiceNumber - invoiceIssuer - invoiceLevel - number - charges - tenantId type: object properties: invoiceNumber: type: string minimum: 1 maximum: 20 description: Invoice Number customerName: type: string minimum: 1 maximum: 20 description: Name of the customer tenantId: type: string minimum: 1 maximum: 20 description: This ID indicates who the underlying customer is. invoiceLevel: type: string minimum: 1 maximum: 10 description: Invoice Level enum: - shipment - order invoiceIssuer: type: string minimum: 1 maximum: 20 description: Who is issuing the invoice to the customer? number: type: string minimum: 1 maximum: 20 description: Number of either the shipment or order, depending on the invoice level invoiceDate: type: string format: date-time description: An ISO8601 UTC date-time invoiceWeight: type: number description: Invoice weight weightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' sourceName: type: string minimum: 1 maximum: 60 description: Party managing and sending invoice. (Meant to help tie the invoice to the shipment/order.) charges: type: array items: $ref: '#/components/schemas/visibilityCharge' referenceNumbers: type: array items: $ref: '#/components/schemas/referenceNumber' visibilityCharge: required: - invoicedCurrency - invoiceAmount - invoiceLine type: object properties: invoicedCurrency: type: string minimum: 1 maximum: 10 description: ISO 4217 currency code invoiceAmount: type: number description: Amount invoiced per line item code: minimum: 1 maximum: 20 type: string description: Standard Charge Code invoiceLine: type: integer description: Invoice line description: type: string minimum: 1 maximum: 100 description: Description of the charge code. containerInformation: type: object required: - containerNumber properties: containerNumber: type: string minimum: 1 maximum: 20 description: Number on the container associated to the shipment. containerType: type: string description: What Type of Container is associated to the shipment enum: - "L" - "LCL" - "IPLT" - "20HC" - "20" - "20OT" - "20FR" - "20RF" - "20DC" - "20DV" - "20GP" - "45HC" - "45HR" - "45UI" - "40HC" - "40" - "40OT" - "40HR" - "40RF" - "40FR" - "40DC" - "40DV" - "40GP" - "40HQ" - "45HQ" - "40NOR" containerInformation: minimum: 1 maximum: 20 type: string description: Information pertaining to the container containerWeight: type: number description: Weight of the container weightUnitOfMeasure: $ref: '#/components/schemas/weightUomEnum' #---Labels--------------------------------------------------------------------------------------------- label: type: object description: Object containing information for the label required: - billTo - customer - origin - destination - packages - payer - shipDate properties: customer: $ref: '#/components/schemas/customer' billTo: $ref: '#/components/schemas/billTo' payer: $ref: '#/components/schemas/payer' carrier: $ref: "#/components/schemas/carrierEnum" description: The carrier for this shipment; Required if rateShopType is not defined. serviceLevel: $ref: "#/components/schemas/serviceLevelLabelsEnum" description: The service level for this shipment; Required if rateShopType is not defined. rateShopType: type: string description: > Required if serviceLevel is undefined and ignored if serviceLevel is defined; used to set the logic for determining the serviceLevel from rate shop results for label generation. * `BestCostPromisedDelivery` - Returns the lowest cost serviceLevel that meets the desiredDeliveryDate exactly, and fails if no serviceLevel qualifies. Also returns the shipDate that must be used to achieve the desiredDeliveryDate. * `BestCostMandatoryTransit` - Returns the lowest cost serviceLevel that is on or before the desiredDeliveryDate, and fails if no serviceLevel qualifies. * `BestCostOptionalTransit` - Returns the lowest cost serviceLevel that is on or before the desiredDeliveryDate; if no serviceLevel qualifies, returns the lowest cost serviceLevel overall. * `BestCost` - Returns the lowest cost serviceLevel; ignores desiredDeliveryDate. enum: - "BestCostPromisedDelivery" # Returns the lowest cost serviceLevel that meets the desiredDeliveryDate exactly, and fails if no serviceLevel qualifies. Also returns the shipDate that must be used to achieve the desiredDeliveryDate. - "BestCostMandatoryTransit" # Returns the lowest cost serviceLevel that is on or before the desiredDeliveryDate, and fails if no serviceLevel qualifies. - "BestCostOptionalTransit" # Returns the lowest cost serviceLevel that is on or before the desiredDeliveryDate; if no serviceLevel qualifies, returns the lowest cost serviceLevel overall. - "BestCost" # Returns the lowest cost serviceLevel; ignores desiredDeliveryDate. shipDate: type: string description: Required; must be in ISO 8601 format. For FedEx, shipDate must not be more than 10 days in the future. format: date-time invoiceDate: type: string description: Required for UPS shipments only. Must be in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Used exclusively for UPS Paperless Invoice to process customs declarations, and must match the shipment's invoice date. format: date-time rateShopCarrierList: type: array description: Optional; limits the rate shop to only the carriers specified. By default, all configured carriers are rated. items: $ref: "#/components/schemas/carrierEnum" transactionId: type: string description: Optional; Unique identifier to correlate to the label request. If not populated, a random GUID will be used. minimum: 1 maximum: 36 desiredDeliveryDate: type: string description: Required if rateShopType is set to BestCostOptionalTransit, BestCostMandatoryTransit, or BestCostPromisedDelivery; must be in ISO 8601 format format: date-time origin: $ref: '#/components/schemas/location' destination: $ref: '#/components/schemas/location' additionalLocationList: type: array items: $ref: '#/components/schemas/additionalLocationLabels' packages: type: array description: Can define multiple packages to create multiple labels if destinations are identical. items: $ref: '#/components/schemas/package' isHazardous: type: boolean description: Indicates whether the shipment contains hazardous materials. default: false deliveryServiceList: type: array description: Used to specify special delivery service options (these services may incur additional charges). items: type: string enum: - "SaturdayDelivery" - "NeutralDelivery" # DHL Only documents: type: array description: Supporting documents to send to the carrier as part of the label request. items: $ref: '#/components/schemas/document' referenceNumbers: type: array description: Additional reference number objects pertaining to the whole order. items: $ref: "#/components/schemas/referenceNumber" description: type: string description: A description of the shipment. internationalShipping: $ref: "#/components/schemas/internationalShipping" rmaReason: type: string description: The RMA reason for FedEx return shipments. purposeOfShipment: type: string description: Required if FedEx intra-India shipment. enum: - "GIFT" - "NOT_SOLD" - "PERSONAL_EFFECTS" - "REPAIR_AND_RETURN" - "SAMPLE" - "SOLD" bookingNumber: $ref: "#/components/schemas/bookingNumber" labelResolution: type: integer description: The DPI value to use for ZPL label generation; applies to UPS, FedEx, DHL and Purolator. default: 203 enum: - 203 - 300 customer: description: The customer on the order. required: - customerCode properties: customerCode: type: string description: C.H. Robinson defined customer code. This will be provided by your C.H. Robinson rep. minimum: 1 maximum: 50 referenceNumbers: type: array description: Additional reference number objects pertaining to the customer object. items: $ref: "#/components/schemas/referenceNumber" billTo: description: The bill to on the order. required: - customerCode - currencyCode properties: customerCode: type: string description: C.H. Robinson defined bill to customer code. This will be provided by your C.H. Robinson rep. minimum: 1 maximum: 50 currencyCode: type: string $ref: "#/components/schemas/currencyCodeEnum" description: "Code to indicate the currency being used. The most common currently in use with C.H. Robinson:\n\n* `USD` - US Dollar\n* `CAD` - Canadian Dollar \n* `MXN` - Mexican Peso\n* `EUR` - European Euro" referenceNumbers: type: array description: Additional reference number objects pertaining to the customer object. items: $ref: "#/components/schemas/referenceNumber" payer: type: object description: The party responsible for paying the shipping charges. required: - type properties: type: $ref: "#/components/schemas/payerTypeEnum" description: The payer type. accountNumber: type: string minLength: 1 maxLength: 100 description: Account number of the party paying the shipping charges; Required for a payer type of Third_Party or if C.H. Robinson does not have the billing account to use on file. postalCode: type: string description: Indicates the postal code tied to the payer account; Required if accountNumber is specified. countryCode: description: Indicates the country code tied to the payer account; Required if accountNumber is specified. $ref: "#/components/schemas/countryCodeEnum" name: type: string description: Indicates the company name tied to the payer account; Required for TNT Australia domestic Third Party shipments. minimum: 1 maximum: 35 address1: type: string description: Indicates address line one tied to the payer account; Required for TNT Australia domestic Third Party shipments. minimum: 1 maximum: 35 address2: type: string description: Indicates address line two tied to the payer account; Required for TNT Australia domestic Third Party shipments. minimum: 1 maximum: 35 city: type: string description: Indicates the city tied to the payer account; Required for TNT Australia domestic Third Party shipments. minimum: 1 maximum: 100 stateProvinceCode: type: string description: Indicates the state or province of the tied to the payer account; Required for TNT Australia domestic Third Party shipments. minimum: 1 maximum: 20 contactName: type: string description: Indicates the name of the contact person tied to the payer account; Required for TNT Australia domestic Third Party shipments. minimum: 1 maximum: 35 contactPhoneNumber: type: string description: Indicates the phone number tied to the payer account; Required for TNT Australia domestic Third Party shipments. minimum: 1 maximum: 20 location: description: The locations on the label. required: - address - name - contactName - contactPhoneNumber properties: customerLocationId: type: string minLength: 1 maxLength: 50 default: null description: Customer defined identifier associated to a specific location; Optional, but required if C.H. Robinson has parcel account information on file for the location that must be passed to the carrier. name: type: string minLength: 1 maxLength: 35 description: Required; The name of the location. address: $ref: '#/components/schemas/address' isResidential: $ref: '#/components/schemas/isResidential' contactName: type: string minLength: 1 maxLength: 35 description: Required; The name of the contact person for the location. contactPhoneNumber: type: string minLength: 1 maxLength: 20 description: Required; The phone number of the contact person for the location. For UPS, the max length is shorter at 15 characters. email: type: string minLength: 1 maxLength: 50 description: The email address of the contact person for the location. specialInstructions: type: string minimum: 1 maximum: 100 referenceNumbers: type: array description: Additional reference number objects pertaining to this location. items: $ref: "#/components/schemas/referenceNumber" address: description: Object that contains address specific information. required: - address1 - city - countryCode properties: address1: type: string description: Required; Indicates address line one of the location. minLength: 1 maxLength: 35 address2: type: string description: Indicates address line two of the location. minLength: 1 maxLength: 35 address3: type: string description: Indicates address line three of the location. minLength: 1 maxLength: 35 address4: type: string description: Indicates address line four of the location. minLength: 1 maxLength: 35 city: type: string description: Required; Indicates the city of the location. minLength: 1 maxLength: 100 stateProvinceCode: type: string description: Indicates the state or province of the location. Required if countryCode is one of the following - AF, AR, AU, BR, CA, CN, ES, IT, KR, MX, PF, PG, PW, RU, SC, TH, TO, TV, US, USA, UY, VE, VN minLength: 1 maxLength: 20 postalCode: type: string description: Indicates the postal code of the location, sometimes refered to as the zip code. Required unless countryCode is one of the following - AE, AG, AO, AW, BF, BI, BJ, BM, BO, BQ, BS, BW, BZ, CD, CF, CG, CI, CK, CM, CW, DJ, DM, ER, FJ, GA, GD, GH, GM, GQ, GY, HK, JM, KI, KM, KN, KP, LY, MO, MR, MW, PS, QA, RW, SB, SC, SL, SR, SS, ST, SX, SY, TD, TF, TG, TK, TL, TO, TV, UG, VU, YE, ZW minLength: 1 maxLength: 20 countryCode: $ref: "#/components/schemas/countryCodeLabelsEnum" package: description: Describes a package required: - packagingType - weight - weightUnitOfMeasure - length - width - height - linearUnitOfMeasure properties: contents: type: array description: Required for international shipments (origin and destination countryCode do not match). Itemized package contents. items: $ref: "#/components/schemas/content" deliveryConfirmation: type: string description: Used on specify if signature is required on delivery (this service may incur additional charges). enum: - "SignatureRequired" - "AdultSignatureRequired" documentsOnly: type: boolean description: Used on DHL shipments to indicate if the package only contains documents. default: false declaredValue: type: number description: Used to request package insurance (this service may incur additional charges) format: currency declaredValueCurrencyCode: type: string description: Code to indicate the currency being used for insurance; Required if declaredValue is populated. collectOnDelivery: type: string description: Used to request COD service from the parcel provider; Reserved for future use. enum: - "Guaranteed" - "NonGuaranteed" collectOnDeliveryAmount: type: number description: Money value to collect upon delivery; Reserved for future use. format: currency collectOnDeliveryCurrencyCode: description: Code to indicate the currency being used; Reserved for future use. type: string description: type: string description: General description of the package contents for Returns Services. maxLength: 35 default: "Consumer Items" packagingType: type: string description: Required; Used to specify if prepaid carrier-branded envelopes or boxes are being used; Customer_Package should be passed if this is unknown. enum: - "USPS_Flat_Rate_Padded_Envelope" #Deprecated - "USPS_Flat_Rate_Legal_Envelope" #Deprecated - "USPS_Flat_Rate_Window_Envelope" #Deprecated - "USPS_Flat_Rate_Gift_Card_Envelope" #Deprecated - "USPS_Small_Flat_Rate_Box" #Deprecated - "USPS_Large_Flat_Rate_Box" #Deprecated - "USPS_Irregular_Parcel" #Deprecated - "USPS_Oversized_Parcel" #Deprecated - "USPS_Large_Parcel" #Deprecated - "USPS_Flat_Rate_Cardboard_Envelope" #Deprecated - "DHL_Box" - "DHL_Lab_Pak" - "Customer_Package" - "DHL_Letter" - "USPS_Regional_Rate_Box_B" #Deprecated - "USPS_DVD_Flat_Rate_Box" #Deprecated - "USPS_Small_Flat_Rate_Envelope" #Deprecated - "USPS_Regional_Rate_Box_A" #Deprecated - "USPS_Large_Video_Flat_Rate_Box" #Deprecated - "USPS_Flat_Rate_Envelope" #Deprecated - "UPS_Letter" - "FedEx_25kg_Box" - "UPS_Pak" - "UPS_Tube" - "FedEx_10kg_Box" - "FedEx_Pak" - "FedEx_Envelope" - "FedEx_Tube" - "FedEx_Box" - "UPS_Express_Box" - "USPS_Flat" #Deprecated - "USPS_Letter" #Deprecated - "USPS_Medium_Flat_Rate_Box" #Deprecated - "USPS_Parcel" #Deprecated - "USPS_Card" #Deprecated - "UPS_10_KG_Box" - "UPS_25_KG_Box" - "USPS_Package" #Deprecated - "UPS_Pallet" - "UPS_Large_Express_Box" - "UPS_Medium_Express_Box" - "UPS_Small_Express_Box" weight: type: number description: Required; weight of the package. Most parcel carriers enforce a maximum of 150 lbs or 68 kg. format: float minimum: 0.01 maximum: 999.99 weightUnitOfMeasure: type: string description: Required; weight unit of measurement. enum: - "Pounds" - "Kilograms" length: type: number description: Required; length of the package. Most parcel carriers enforce a maximum of 108 inches. format: float minimum: 0.01 maximum: 999.99 width: type: number description: Required; width of the package. format: float minimum: 0.01 maximum: 999.99 height: type: number description: Required; height of the package. format: float minimum: 0.01 maximum: 999.99 linearUnitOfMeasure: type: string description: Required; units of measurement the length, width, and height are defined in. Metric values require the Package weightUnitOfMeasure to be Kilograms, and Imperial values require Pounds. enum: - "Inches" - "Feet" - "Centimeters" - "Meters" labelReferenceData1: $ref: "#/components/schemas/labelReferenceData1" labelReferenceData2: $ref: "#/components/schemas/labelReferenceData2" labelReferenceData3: $ref: "#/components/schemas/labelReferenceData3" referenceNumbers: type: array description: Additional reference number objects pertaining to the package object (do not show on label). items: $ref: "#/components/schemas/referenceNumber" hazardousPackageInformation: description: Additional information about any hazardous materials or dangerous goods in the package. $ref: '#/components/schemas/hazardousPackageInformation' content: required: - countryOfOriginCode - description - value - currencyCode - quantity - weight - weightUnitOfMeasure properties: countryOfOriginCode: description: Indicates country of origin of the contents; Required for all international shipments. $ref: "#/components/schemas/countryCodeEnum" description: type: string description: Description of the contents of the package; Required for all international shipments. maxLength: 35 commodityCode: type: string description: Code used by customs authorities to identify products when assessing duties and taxes. Required for DHL Paperless International Shipments. minimum: 6 maximum: 10 value: type: number description: Approximate value of the contents for customs purposes; Required for all international shipments. format: float minimum: 0.01 currencyCode: $ref: "#/components/schemas/currencyCodeLabelsEnum" description: Currency code tied to the value; Required for all international shipments. quantity: type: number description: Number of pieces in the package; Required for all international shipments. format: integer minimum: 1 quantityUnitOfMeasure: type: string description: Quantity unit of measurement for the contents of the package. Required for UPS Paperless Invoice. enum: - "Pieces" - "Dozen" - "Dozen_Pieces" - "Dozen_Pairs" - "Hundred" - "Kilograms" - "Meters" - "Number" - "Packs" - "Pairs" - "No_Unit_Required" - "Thousand" weight: type: number description: Weight of the contents of the package; Required for all international shipments. For a given package, the sum of the weight of the contents must be less than or equal to the package weight. format: float minimum: 0.01 weightUnitOfMeasure: type: string description: Weight unit of measurement for the contents of the package; Required for all international shipments, and must match package weightUnitOfMeasure. enum: - "Pounds" - "Kilograms" eccn: type: string description: Export Control Classification Number; reserved for future use. minLength: 5 maxLength: 5 hazardousPackageInformation: type: object description: Additional information about any hazardous materials or dangerous goods in the package. required: - hazardousMaterials properties: hazardousMaterials: type: array description: The list of hazardous materials in the package. items: $ref: "#/components/schemas/hazardousMaterial" signatory: $ref: "#/components/schemas/signatory" packagingType: type: string description: The outermost type of packaging used for package containing hazardous materials. Ex. fiberboard box, steel drum, plastic jug; Reserved for future use. minLength: 1 maxLength: 100 isOverpack: type: boolean description: A flag indicating if the package containing hazardous materials is an overpack; Optional. isAllPackedInOne: type: boolean description: A flag indicating if the package contains multiple containers with different hazardous materials; Optional. qValue: type: string description: The Q-Value of the package containing hazardous materials; Optional. minLength: 1 maxLength: 3 offeror: type: string description: The offeror of the package containing hazardous materials; Required for FedEx. minLength: 1 maxLength: 100 hazardousMaterial: type: object required: - hazardousMaterials properties: massCapacity: type: number format: float description: The mass capacity of the hazardous material; Required for FedEx Express Service Levels and for UPS if commodityRegulationType is ExceptedQuantity, LimitedQuantity, or FullyRegulated and if the field applies to the material by regulation. minimum: 0.0 massCapacityUnitOfMeasure: type: string description: The unit of measure for the mass capacity of the hazardous material; Required when massCapacity is provided. enum: - "Pounds" - "Ounces" - "Kilograms" - "Grams" - "Liters" - "Milliliters" - "Pints" - "Quarts" - "Gallons" - "Curies" - "Millicuries" - "Gigabecquerels" - "Megabecquerels" containerType: type: string description: The type of container used to hold the hazardous material. Ex. glass jug, fiberboard box, plastic bottle; Required for FedEx Express Service Levels and for UPS if commodityRegulationType is LimitedQuantity or FullyRegulated and if the field applies to the material by regulation. minLength: 1 maxLength: 100 containerQuantity: type: string description: The number of identical containers in the package holding the same hazardous material; Required for UPS if commodityRegulationType is LimitedQuantity or FullyRegulated and if the field applies to the material by regulation. minimum: 1 outerPackagingType: type: string description: The type of nested packaging used to encapsulate the inner containers with the hazardous material. Ex. For a large box containing plastic bottles of alcohol inside small boxes, this would describe the small boxes containing the plastic bottles; Reserved for future use. minLength: 1 maxLength: 100 outerPackagingQuantity: type: string description: The number of nested packages used to encapsulate the inner containers with the hazardous material. Ex. For a large box containing plastic bottles of alcohol inside small boxes, this would count the small boxes containing the plastic bottles; Reserved for future use. minimum: 1 regulationSet: type: string description: The hazardous material shipping regulation set applicable to the hazardous material; Required for UPS. enum: - "IATA" # Worldwide air shipments - "TDG" # Canada to Canada ground shipments or Canada to US standard shipments - "DOT" # US Department of Transportation - "ORMD" # Other Regulated Materials for Domestic Transport Only (ORM-D) - "ADR" # Europe to Europe ground shipments - "CFR" # Hazardous material shipments regulated by US Dept. of Transportation within the U.S. or ground shipments to Canada regulatoryIdNumber: type: string description: Required; The UN/NA/ID Identification Number assigned to the hazardous material. minLength: 1 maxLength: 10 hazardClassDivisionNumber: type: string description: The primary hazard class or division number assigned to the hazardous material; Required for UPS if commodityRegulationType is ExceptedQuantity, LimitedQuantity, or FullyRegulated and if the field applies to the material by regulation. $ref: "#/components/schemas/hazardousClassDivisionNumberEnum" subHazardClassDivisions: type: array description: The subsidary hazard class or division numbers assigned to the hazardous material; Optional. items: type: string $ref: "#/components/schemas/hazardousClassDivisionNumberEnum" packingGroup: type: string description: The IATA packing group for the hazardous material; Required for FedEx and TNT, and required for UPS if commodityRegulationType is LimitedQuantity or FullyRegulated and if the field applies to the material by regulation. enum: - "I" # Packing Group I: high danger - "II" # Packing Group II: medium danger - "III" # Packing Group III: low danger packagingInstructionCode: type: string description: The code for the packaging instructions used to pack the hazardous material; Required for FedEx Express Service Levels and for UPS if commodityRegulationType is LimitedQuantity or FullyRegulated and if the field applies to the material by regulation. minLength: 1 maxLength: 10 properShippingName: type: string description: The proper shipping name for the hazardous material assigned by ADR, CFR or IATA; Required for UPS and TNT. minLength: 1 maxLength: 150 technicalName: type: string description: The technical name for the hazardous material; Required for UPS if commodityRegulationType is LimitedQuantity or FullyRegulated and if the field applies to the material by regulation and if the field applies to the material by regulation. minLength: 1 maxLength: 200 isAccessible: type: boolean description: Indicates whether or not the hazardous material is accessible by the carrier during transport (ex. accessible by the flight crew in-flight); FedEx Only. commodityRegulationLevel: type: string description: The regulation level for the hazardous material; Required for UPS and TNT. enum: - "LightlyRegulated" - "FullyRegulated" - "LimitedQuantity" - "ExceptedQuantity" transportationMode: type: string description: The transportation mode that the hazardous material was prepared for; Required for UPS if regulationSet is anything other than ADR or if commodityRegulationType is LimitedQuantity or FullyRegulated. enum: - "Ground" - "Highway" - "PassengerAircraft" - "CargoAircraftOnly" emergencyContact: type: string description: The name of the person to contact in the event of an emergency; Optional. minLength: 1 maxLength: 35 emergencyPhoneNumber: type: string description: The telephone number to contact in the event of an emergency; Required for FedEx. minLength: 1 maxLength: 25 additionalDescription: type: string description: Additional information about the hazardous material. This could be additional regulatory information, additional handling details, etc; Required for UPS if commodityRegulationType is LimitedQuantity or FullyRegulated and if the field applies to the material by regulation. maxLength: 250 chemicalRecordIdentifier: type: string description: Identifies the hazardous material in a package. If a package contains multiple hazardous materials, each one should be clearly labeled with an identifier so that it can be easily recognized; Required for UPS. minLength: 1 maxLength: 3 hazardousMaterialType: type: string description: The type of hazardous material; Required for FedEx. enum: - "HazardousMaterials" # Package contains hazardous materials requiring complete documentation. Includes batteries with 5 grams or more of lithium. - "LimitedQuantitiesCommodities" # Package contains limited quantities of hazardous commodities. - "Battery" # Package contains batteries with nonhazardous quantities of lithium (less than 5 grams of lithium). - "ORMD" # Package contains other regulated materials for U.S. shipping. - "ReportableQuantities" # Package contains hazardous materials in an amount that needs to be reported. - "SmallQuantityException" # Package contains hazardous content in excepted quantities. hazardousContentDescription: type: string description: The hazardous material content ID; Required for DHL. enum: - "DryIceUN1845" # Dry Ice UN1845 - "LithiumIonBatteryPI965SectionII" # Lithium Ion Battery (Packaging Instruction 965 Section II) - "LithiumIonBatteryWithEquipmentPI966SectionII" # Lithium Ion Battery With Equipment (Packaging Instruction 966 Section II) - "LithiumIonBatteryInEquipmentPI967SectionII" # Lithium Ion Battery In Equipment (Packaging Instruction 967 Section II) - "LithiumMetalBatteryWithEquipmentPI969SectionII" # Lithium Metal Battery With Equipment (Packaging Instruction 969 Section II) - "LithiumMetalBatteryInEquipmentPI970SectionII" # Lithium Metal Battery In Equipment (Packaging Instruction 970 Section II) - "LimitedQuantitiesADR" # Limited quantities to the limits of ADR - "ExceptedQuantitiesIATA" # Excepted quantities in accordance with IATA - "BiologicalSubstancesUN3373" # Biological Substances UN3373 - "DGPerAttachedDGDPAX" # Dangerous Goods as per attached DGD - PAX - "DGPerAttachedDGDCAO" # Dangerous Goods as per attached DGD - CAO - "GeneticallyModifiedOrganisms" # Genetically modified organisms/microorganisms - "Class9ConsumerCommodities" # Class 9 Consumer Commodities ID8000 - "ADRLoadExemptions" # ADR Load Exemptions - "UN2807MagnetizedMaterial" # UN2807 Magnetized Material - "UN3164PI208aArticlesPressurizedHydraulic" # UN3164 PI208a Articles Pressurized Hydraulic - "UN3164PI208aArticlesPressurizedPneumatic" # UN3164 PI208a Articles Pressurized Pneumatic - "ExemptHumanSpecimen" # Exempt Human Specimen - "ExemptAnimalSpecimen" # Exempt Animal Specimen - "NotRestrictedSpecialProvision" # Not Restricted, Special Provision signatory: type: object properties: name: type: string description: The name of the hazardous shipment signatory; Required for FedEx Express Service Levels. minLength: 1 maxLength: 35 title: type: string description: The title of the hazardous shipment signatory; Required for FedEx Express Service Levels. minLength: 1 maxLength: 35 place: type: string description: The place of the hazardous shipment signatory; Required for FedEx Express Service Levels. minLength: 1 maxLength: 35 internationalShipping: type: object description: Elements specific to international shipping scenarios. properties: isDutiable: type: boolean description: A flag required for DHL international shipments indicating whether or not the shipment is dutiable. exportReasonCode: $ref: "#/components/schemas/exportReasonCode" AESTransactionNumber: $ref: "#/components/schemas/AESTransactionNumber" AESExempt: type: boolean description: Indicates that goods being shipped are exempt from AES Export Filing; FedEx only, Optional. dutyPayerType: $ref: "#/components/schemas/payerTypeEnum" description: Indicates which party involved in a shipment is responsible for duty payment; Required for all international shipments (including when the isDutiable flag is false). dutyPayerAccountNumber: $ref: "#/components/schemas/dutyPayerAccountNumber" dutyPayerPostalCode: type: string description: Postal code of the party paying the duty charges; Used for a dutyPayerType of Third_Party. minLength: 1 maxLength: 20 dutyPayerCountryCode: $ref: "#/components/schemas/countryCodeEnum" description: Country code of the party paying the duty charges; Used for a dutyPayerType of Third_Party. dutyPayerName: type: string description: Indicates the company name tied to the duty payer account; Reserved for future use. minimum: 1 maximum: 35 dutyPayerAddress1: type: string description: Indicates address line one tied to the duty payer account; Reserved for future use. minimum: 1 maximum: 35 dutyPayerAddress2: type: string description: Indicates address line two tied to the duty payer account; Reserved for future use. minimum: 1 maximum: 35 dutyPayerCity: type: string description: Indicates the city tied to the duty payer account; Reserved for future use. minimum: 1 maximum: 100 dutyPayerStateProvinceCode: type: string description: Indicates the state or province of the tied to the duty payer account; Reserved for future use. minimum: 1 maximum: 20 dutyPayerContactName: type: string description: Indicates the name of the contact person tied to the duty payer account; Reserved for future use. minimum: 1 maximum: 35 dutyPayerContactPhoneNumber: type: string description: Indicates the phone number tied to the duty payer account; Reserved for future use. minimum: 1 maximum: 20 incoTerms: type: string description: Specifies who is responsible for paying for and managing the shipment; Optional - FedEx and DHL only. enum: - "CFR" # Cost and Freight - "CIF" # Cost Insurance and Freight - "CIP" # Carriage and Insurance Paid To - "CPT" # Carriage Paid To - "DAF" # Delivery at Frontier - "DAP" # Delivered at Place - "DAT" # Delivered at Terminal - "DDP" # Delivered Duty Paid - "DDU" # Delivered Duty Unpaid - "DEQ" # Delivered Ex-Quay, Duty Unpaid - "DES" # Delivered Ex-Ship - "DPU" # Delivered at Place Unloaded - "EXW" # Ex-Works - "FAS" # Free Alongside Ship - "FCA" # Free Carrier - "FOB" # Free On-Board Vessel additionalLocationLabels: type: object description: List of additional locations to provide extra information for customs purposes. (Only supported for UPS paperless Invoice and FedEx). required: - additionalLocationType - address - name - contactName - contactPhoneNumber properties: additionalLocationType: type: string description: Required; List of supported additional location types for UPS and FedEx customs purposes. enum: - "SoldTo" #UPS - "Customs_Importer" #FedEx - "Importer_Of_Record" #FedEx - "Customs_Exporter" #FedEx customerLocationId: type: string minimum: 1 maximum: 80 description: Customer defined identifier associated to a specific location; Optional, but required if C.H. Robinson has parcel account information on file for the location that must be passed to the carrier. name: type: string minimum: 1 maximum: 200 description: Required; Name of the location. address: $ref: '#/components/schemas/address' contactName: type: string minLength: 1 maxLength: 35 description: Required; The name of the contact person for the location. contactPhoneNumber: type: string minLength: 1 maxLength: 20 description: Required; The phone number of the contact person for the location. For UPS, the max length is shorter at 15 characters. document: type: object description: Defines document content and metadata. required: - fileName - documentUploadType - content properties: fileName: type: string description: Filename with extension; supported extensions are PDF, TXT, PNG, JPG/JPEG, GIF, BMP, TIF/TIFF, RTF, DOC, DOCX, XLS and XLSX. documentUploadType: type: string description: The type of document being uploaded. enum: - "AirwayBill" - "AuthorizationForm" - "CommercialInvoice" - "CertificateOfOrigin" - "CustomsDeclaration" - "ExportAccompanyingDocument" - "ExportLicense" - "ImportPermit" - "Invoice" - "NAFTACertificateOfOrigin" - "Other" - "PackingList" - "PowerOfAttorney" - "ProFormaInvoice" - "SEDDocument" - "ShippersLetterOfInstruction" documentUploadCategory: type: string description: The category of the document being uploaded. FedEx only. enum: - "CustomerInformation" - "ElectronicTradeDocuments" - "PricingDocuments" expirationDate: type: string description: Date upon which the carrier can discard the document, and must be in ISO 8601 format. FedEx only. format: date-time content: type: string description: Base64 encoded file data; maximum size per file is 10MB for UPS, 5MB for FedEx, and 2MB for DHL. currencyCodeLabelsEnum: type: string description: "Code to indicate the currency being used. The most common currently in use with C.H. Robinson:\n\n* `USD` - US Dollar\n* `CAD` - Canadian Dollar \n* `MXN` - Mexican Peso\n* `EUR` - European Euro" enum: - "USD" # US Dollar - "CAD" # Canadian Dollar - "EUR" # Euro - "MXN" # Mexican Peso - "CHF" # Swiss Franc - "GBP" # British Pound - "HUF" # Hungarian Forint - "CZK" # Czech Koruna - "NZD" # New Zealand Dollar - "PLN" # Polish Zlotych - "ZAR" # South African Rand - "VES" # Venezuelan Bolivar - "VND" # Vietnamese Dong - "TWD" # New Taiwan Dollar - "TRY" # Turkish New Lira - "SEK" # Swedish Krona - "SGD" # Singapore Dollar - "RUB" # Russian Ruble - "NOK" # Norwegian Krone - "HKD" # Hong Kong Dollar - "INR" # Indian Rupee - "JPY" # Japanese Yen - "CLP" # Chilean Peso - "CNY" # Chinese Renminbi - "DKK" # Danish Krone - "AUD" # Australian Dollar - "BRL" # Brazilian Real - "AED" # UAE Dirham - "PEN" # Peruvian Nuevo Sol - "THB" # Thai Baht - "ARS" # Argentinian Peso - "MYR" # Malaysian Ringgit - "SAR" # Saudi Riyal - "BBD" # Barbados Dollar - "BHD" # Bahraini Dinar - "BMD" # Bermuda Dollar - "BSD" # Bahamian Dollar - "ILS" # Israeli Shekel - "ISK" # Iceland Krona - "KES" # Kenyan Shilling - "KRW" # South Korean Won - "KWD" # Kuwaiti Dinar - "OMR" # Omani Rial - "PHP" # Philippine Peso - "PKR" # Pakistani Rupee - "QAR" # Qatar Rial - "RON" # Romanian New Leu - "TTD" # Trinidad Tobago Dollar - "UAH" # Ukraine Hryvnia - "LKR" # Sri Lankan Rupee - "XPF" # CFP Franc (French Polynesia, New Caledonia, and Wallis and Futuna) - "UYU" # Uruguayan Peso - "COP" # Colombian Peso - "CRC" # Costa Rican Colon - "FJD" # Fijian Dollar - "CLF" # Chilean Unidad de Formento - "RSD" # Serbian Dinar - "BAM" # Bosnia and Herzegovina Convertible Mark - "BGN" # Bulgarian Lev - "GEL" # Georgian Lari - "HRK" # Croatian Kuna - "IDR" # Indonesian Rupiah countryCodeLabelsEnum: type: string description: Indicates the country. enum: - "AD" # Andorra - "AE" # United Arab Emirates - "AF" # Afghanistan - "AG" # Antigua and Barbuda - "AI" # Anguilla - "AL" # Albania - "AM" # Armenia - "AO" # Angola - "AQ" # Antarctica - "AR" # Argentina - "AS" # American Samoa - "AT" # Austria - "AU" # Australia - "AW" # Aruba - "AX" # Åland Islands - "AZ" # Azerbaijan - "BA" # Bosnia and Herzegovina - "BB" # Barbados - "BD" # Bangladesh - "BE" # Belgium - "BF" # Burkina Faso - "BG" # Bulgaria - "BH" # Bahrain - "BI" # Burundi - "BJ" # Benin - "BM" # Bermuda - "BN" # Brunei Darussalam - "BO" # Bolivia - "BQ" # Bonaire, Sint Eustatius and Saba - "BR" # Brazil - "BS" # Bahamas - "BT" # Bhutan - "BW" # Botswana - "BY" # Belarus - "BZ" # Belize - "CA" # Canada - "CC" # Cocos (Keeling) Islands - "CD" # Democratic Republic of the Congo - "CF" # Central African Republic - "CG" # Republic of the Congo - "CH" # Switzerland - "CI" # Côte d'Ivoire (Ivory Coast) - "CK" # Cook Islands - "CL" # Chile - "CM" # Cameroon - "CN" # China - "CO" # Colombia - "CR" # Costa Rica - "CU" # Cuba - "CV" # Cabo Verde (Cape Verde) - "CW" # Curaçao - "CX" # Christmas Island - "CY" # Cyprus - "CZ" # Czechia (Czech Republic) - "DE" # Germany - "DJ" # Djibouti - "DK" # Denmark - "DM" # Dominica - "DO" # Dominican Republic - "DZ" # Algeria - "EC" # Ecuador - "EE" # Estonia - "EG" # Egypt - "EH" # Western Sahara - "ER" # Eritrea - "ES" # Spain - "ET" # Ethiopia - "FI" # Finland - "FJ" # Fiji - "FK" # Falkland Islands - "FM" # Micronesia (Federated States of) - "FO" # Faroe Islands - "FR" # France - "GA" # Gabon - "GB" # United Kingdom of Great Britain and Northern Ireland - "GD" # Grenada - "GE" # Georgia - "GF" # French Guiana - "GG" # Guernsey - "GH" # Ghana - "GI" # Gibraltar - "GL" # Greenland - "GM" # Gambia - "GN" # Guinea - "GP" # Guadeloupe - "GQ" # Equatorial Guinea - "GR" # Greece - "GS" # South Georgia and the South Sandwich Islands - "GT" # Guatemala - "GU" # Guam - "GW" # Guinea-Bissau - "GY" # Guyana - "HK" # Hong Kong - "HN" # Honduras - "HR" # Croatia - "HT" # Haiti - "HU" # Hungary - "ID" # Indonesia - "IE" # Ireland - "IL" # Israel - "IM" # Isle of Man - "IN" # India - "IO" # British Indian Ocean Territory - "IQ" # Iraq - "IR" # Iran - "IS" # Iceland - "IT" # Italy - "JE" # Jersey - "JM" # Jamaica - "JO" # Jordan - "JP" # Japan - "KE" # Kenya - "KG" # Kyrgyzstan - "KH" # Cambodia - "KI" # Kiribati - "KM" # Comoros - "KN" # Saint Kitts and Nevis - "KP" # Democratic People's Republic of Korea (North Korea) - "KR" # Republic of Korea (South Korea) - "KW" # Kuwait - "KY" # Cayman Islands - "KZ" # Kazakhstan - "LA" # Laos - "LB" # Lebanon - "LC" # Saint Lucia - "LI" # Liechtenstein - "LK" # Sri Lanka - "LR" # Liberia - "LS" # Lesotho - "LT" # Lithuania - "LU" # Luxembourg - "LV" # Latvia - "LY" # Libya - "MA" # Morocco - "MC" # Monaco - "MD" # Moldova - "ME" # Montenegro - "MF" # Saint Martin (French part) - "MG" # Madagascar - "MH" # Marshall Islands - "MK" # North Macedonia - "ML" # Mali - "MM" # Myanmar - "MN" # Mongolia - "MO" # Macao - "MP" # Northern Mariana Islands - "MQ" # Martinique - "MR" # Mauritania - "MS" # Montserrat - "MT" # Malta - "MU" # Mauritius - "MV" # Maldives - "MW" # Malawi - "MX" # Mexico - "MY" # Malaysia - "MZ" # Mozambique - "NA" # Namibia - "NC" # New Caledonia - "NE" # Niger - "NF" # Norfolk Island - "NG" # Nigeria - "NI" # Nicaragua - "NL" # Netherlands - "NO" # Norway - "NP" # Nepal - "NR" # Nauru - "NU" # Niue - "NZ" # New Zealand - "OM" # Oman - "PA" # Panama - "PE" # Peru - "PF" # French Polynesia - "PG" # Papua New Guinea - "PH" # Philippines - "PK" # Pakistan - "PL" # Poland - "PM" # Saint Pierre and Miquelon - "PN" # Pitcairn - "PR" # Puerto Rico - "PS" # Palestine, State of - "PT" # Portugal - "PW" # Palau - "PY" # Paraguay - "QA" # Qatar - "RE" # Réunion - "RO" # Romania - "RS" # Serbia - "RU" # Russia - "RW" # Rwanda - "SA" # Saudi Arabia - "SB" # Solomon Islands - "SC" # Seychelles - "SD" # Sudan - "SE" # Sudan - "SG" # Singapore - "SH" # Saint Helena, Ascension and Tristan da Cunha - "SI" # Slovenia - "SJ" # Svalbard and Jan Mayen - "SK" # Slovakia - "SL" # Sierra Leone - "SM" # San Marino - "SN" # Senegal - "SO" # Somalia - "SR" # Suriname - "SS" # South Sudan - "ST" # Sao Tome and Principe - "SV" # El Salvador - "SX" # Sint Maarten (Dutch part) - "SY" # Syria - "SZ" # Eswatini - "TC" # Turks and Caicos Islands - "TD" # Chad - "TF" # French Southern Territories - "TG" # Togo - "TH" # Thailand - "TJ" # Tajikistan - "TK" # Tokelau - "TL" # Timor-Leste - "TM" # Turkmenistan - "TN" # Tunisia - "TO" # Tonga - "TR" # Turkey - "TT" # Trinidad and Tobago - "TV" # Tuvalu - "TW" # Taiwan (Province of China) - "TZ" # Tanzania - "UA" # Ukraine - "UG" # Uganda - "UM" # United States Minor Outlying Islands - "US" # United States - "USA" # United States - "UY" # Uruguay - "UZ" # Uzbekistan - "VA" # Holy See (Vatican City) - "VC" # Saint Vincent and the Grenadines - "VE" # Venezuela - "VG" # Virgin Islands (British) - "VI" # Virgin Islands (U.S.) - "VN" # Viet Nam - "VU" # Vanuatu - "WF" # Wallis and Futuna - "WS" # Samoa - "YE" # Yemen - "YT" # Mayotte - "ZA" # South Africa - "ZM" # Zambia - "ZW" # Zimbabwe - "IC" # Reserved code rather than a full, offical code. Used by UPS for Canary Islands - "XC" # Used by UPS for Ceuta - "XL" # Used by UPS for Melilla payerTypeEnum: type: string description: Indicates which party involved in the shipment is responsible for payment. enum: - "Sender" - "Recipient" - "Third_Party" carrierEnum: type: string description: The list of supported small parcel carriers enum: - "UPS" - "FDX" # FedEx - "DHL" - "TNT" - "SNGPST" # Singapore Post - "SFX" # SF Express - "PUR" # Purolator - "DPD" # DPD Meta API - "TGE" # Team Global Express (formerly known as TOLL Australia) - "CEX" # Correos Express - "USPS" serviceLevelLabelsEnum: type: string description: The list of supported small parcel carrier service levels enum: - "DHL_Domestic_Express" - "DHL_Domestic_Express_12PM" - "DHL_Domestic_Express_9AM" - "DHL_Economy_Select" - "DHL_Express_12PM" - "DHL_Express_9AM" - "DHL_Express_Worldwide_Doc_DOX" - "DHL_Worldwide_Priority_Express" - "DHL_Worldwide_Express_EU" - "FedEx_2Day" - "FedEx_2Day_AM" - "FedEx_Europe_First" - "FedEx_Express_Saver" - "FedEx_First_Freight" - "FedEx_First_Overnight" - "FedEx_Ground" - "FedEx_Ground_Home_Delivery" - "FedEx_Home_Delivery" - "FedEx_International_Economy" - "FedEx_International_Economy_Freight" - "FedEx_International_First" - "FedEx_International_Priority" - "FedEx_International_Priority_Express" - "FedEx_International_Priority_Freight" - "FedEx_International_Connect_Plus" - "FedEx_Next_Day_UK_9AM" #Deprecated - "FedEx_Next_Day_UK_10AM" #Deprecated - "FedEx_Next_Day_UK_12PM" #Deprecated - "FedEx_Next_Day_UK_End_Of_Day" #Deprecated - "FedEx_Next_Day_UK_Freight" #Deprecated - "FedEx_First" - "FedEx_Priority_Express" - "FedEx_Priority" - "FedEx_Priority_Freight" - "FedEx_Economy_Select" - "FedEx_Priority_Express_Freight" - "FedEx_Priority_Overnight" - "FedEx_Standard_Overnight" - "FedEx_1Day_Freight" - "FedEx_2Day_Freight" - "FedEx_3Day_Freight" - "UPS_2nd_Day_Air" - "UPS_2nd_Day_Air_AM" - "UPS_3_Day_Select" - "UPS_Ground" - "UPS_Next_Day_Air" - "UPS_Next_Day_Air_Early_AM" - "UPS_Next_Day_Air_Saver" - "UPS_Saver" - "UPS_Standard" - "UPS_Worldwide_Expedited_SM" - "UPS_Worldwide_Express_Plus_SM" - "UPS_Worldwide_Express_Saver" - "UPS_Worldwide_Express_SM" - "UPS_Worldwide_Saver" - "UPS_Canada_Domestic_Expedited" - "TNT_Express_9AM" - "TNT_Express_10AM" - "TNT_Express_12PM" - "TNT_Express" - "TNT_Economy_Express" - "TNT_Domestic_Express" - "TNT_Economy_Express_12PM" - "TNT_Next_Day_9AM" - "TNT_Next_Day_10AM" - "TNT_Next_Day_12PM" - "TNT_Next_Day" - "TNT_Express_8AM" - "TNT_Business_Pak_8AM" - "TNT_Business_Pak_9AM" - "TNT_Business_Pak_10AM" - "TNT_Business_Pak_12PM" - "TNT_Australia_Sameday" - "TNT_Australia_Overnight_Express" - "TNT_Australia_Road_Express" - "TNT_Australia_Premium_Express" - "TNT_Australia_Sensitive_Express" - "TNT_Italy_10_Express" - "TNT_Italy_12_Express" - "TNT_Italy_Express" - "TNT_IDE_Mastercon_Road" - "TNT_IDE_Economy" - "SingaporePost_Quantium_Solutions_Ezyparcels_Priority_Domestic" - "SingaporePost_Speedpost_Priority_Singapore_Inbound" - "SingaporePost_Speedpost_Priority_Singapore_Outbound" - "SingaporePost_Quantium_Solutions_Domestic_Standard" - "SFExpress_Speedy_Express" - "SFExpress_Same_Day" - "SFExpress_Standard" - "SFExpress_Freight_Standard" - "Purolator_Ground" - "Purolator_Ground_Evening" - "Purolator_Express_1030AM" - "Purolator_Express" - "Purolator_Express_Evening" - "Purolator_Express_12PM" - "Purolator_Express_Pack_9AM" - "Purolator_Express_Pack_1030AM" - "Purolator_Express_Pack_12PM" - "Purolator_Express_Pack" - "Purolator_Express_Pack_Evening" - "Purolator_Express_Box_9AM" - "Purolator_Express_Box_1030AM" - "Purolator_Express_Box_12PM" - "Purolator_Express_Box" - "Purolator_Express_Box_Evening" - "Purolator_Express_US" - "Purolator_Express_US_9AM" - "Purolator_Express_US_1030AM" - "Purolator_Express_US_12PM" - "Purolator_Express_Envelope_US" - "Purolator_Express_US_Envelope_9AM" - "Purolator_Express_US_Envelope_1030AM" - "Purolator_Express_US_Envelope_12PM" - "Purolator_Express_Pack_US" - "Purolator_Express_US_Pack_9AM" - "Purolator_Express_US_Pack_1030AM" - "Purolator_Express_US_Pack_12PM" - "Purolator_Express_Box_US" - "Purolator_Express_US_Box_9AM" - "Purolator_Express_US_Box_1030AM" - "Purolator_Express_US_Box_12PM" - "Purolator_Ground_US" - "Purolator_Express_International" - "Purolator_Express_International_9AM" - "Purolator_Express_International_1030AM" - "Purolator_Express_International_12PM" - "Purolator_Express_Envelope_International" - "Purolator_Express_International_Envelope_9AM" - "Purolator_Express_International_Envelope_1030AM" - "Purolator_Express_International_Envelope_12PM" - "Purolator_Express_Pack_International" - "Purolator_Express_International_Pack_9AM" - "Purolator_Express_International_Pack_1030AM" - "Purolator_Express_International_Pack_12PM" - "Purolator_Express_Box_International" - "Purolator_Express_International_Box_9AM" - "Purolator_Express_International_Box_1030AM" - "Purolator_Express_International_Box_12PM" - "Purolator_Ground_1030AM" - "Purolator_Ground_9AM" - "Purolator_Express_9AM" - "DPD_Deferred" - "DPD_Seur_24" - "DPD_Seur_48" - "DPD_Seur_72" - "DPD_Seur_10" - "DPD_Seur_1330" - "DPD_Seur_Maritimo" - "DPD_Bartolini_Priority_1200" - "DPD_Bartolini_1030" - "TGE_Priority_Australia_Overnight" - "TGE_Priority_Australia_DangerousGoods_Overnight" - "TGE_Priority_Australia_SameDay" - "TGE_Priority_Australia_OffPeak" - "TGE_Priority_Australia_5kg_Satchel" - "TGE_Priority_Australia_3kg_Satchel" - "TGE_Priority_Australia_1kg_Satchel" - "TGE_IPEC_Sensitive" - "TGE_IPEC_Road" - "CorreosExpress_Paq10" - "CorreosExpress_Paq14" - "CorreosExpress_Paq24" - "CorreosExpress_Entrega_Plus" - "CorreosExpress_Paq14" - "CorreosExpress_ Internacional_Express" - "CorreosExpress_PAQ_Empresa14" - "CorreosExpress_ePAQ24" - "CorreosExpress_Islas_Express" - "CorreosExpress_Islas_Documentacion" - "CorreosExpress_Islas_Maritimo" - "USPS_Parcel_Select" - "USPS_Connect_Local" - "USPS_Connect_Regional" - "USPS_Connect_Mail" - "USPS_Ground_Advantage" - "USPS_Priority_Mail_Express" - "USPS_Priority_Mail" hazardousClassDivisionNumberEnum: type: string description: The list of supported hazardous material classes enum: - "1.1" # Explosives (with a mass explosion hazard) (e.g. dynamite and blasting explosives) - "1.2" # Explosives (with a projection hazard) (e.g. weapons cartridges and hand grenades) - "1.3" # Explosives (with predominately a fire hazard) (e.g. flash powder and commercial-grade fireworks) - "1.4" # Explosives (with no significant blast hazard) (e.g. model rocket motors and consumer-grade fireworks) - "1.5" # Very insensitive explosives; blasting agents (e.g. ammonium nitrate-fuel oil mixture and very insensitive explosive articles) - "1.6" # Extremely insensitive detonating substances (e.g. extremely insensitive explosive articles) - "2.1" # Flammable gas (e.g. spray paint and lighters) - "2.2" # Non-flammable compressed gas (e.g. oxygen generators and shock absorbers) - "2.3" # Poisonous gas (e.g. Chlorine Gas and Phosgene Gas) - "3" # Flammable liquid and combustible liquid (e.g. acetone, adhesives, paints, gasoline, ethanol) - "4.1" # Flammable solid (e.g. match sticks and desensitized solid explosives) - "4.2" # Spontaneously combustible material (e.g. Aluminum borohydride, oily rags) - "4.3" # Dangerous when wet material (e.g. Barium and lithium metal) - "5.1" # Oxidizer (e.g. hydrogen peroxide and calcium chlorate) - "5.2" # Organic Peroxide (e.g. Ammonium nitrate fertilizers and hardeners or accelerators) - "6.1" # Poisonous/Toxic material (e.g. nicotine and arsenic) - "6.2" # Infectious substance (e.g. Covid19 test samples and regulated medical waste) - "7" # Class 7: Radioactive Materials - "8" # Class 8: Corrosives - "9" # Class 9: Miscellaneous Hazardous Materials successLabelCreate: properties: labelResponseId: type: string orderNumber: description: C.H. Robinson order number received on successful order create. type: number carrier: $ref: "#/components/schemas/carrierEnum" serviceLevel: $ref: "#/components/schemas/serviceLevelEnum" shipDate: description: The date on which the shipment will be picked up. type: string format: date-time scheduledDeliveryDate: description: The date on which the shipment should be delivered. type: string format: date-time shippingPackages: description: Shipping info about the packages included in the shipment. type: array items: $ref: "#/components/schemas/packageShippingInfo" airWaybillNumber: description: The air waybill number for the shipment. type: string bookingNumber: $ref: "#/components/schemas/bookingNumber" shippingDocuments: description: Metadata returned from the carrier for any uploaded documents. type: array items: $ref: "#/components/schemas/documentInfo" referenceNumbers: description: Reference number objects pertaining to the whole order. type: array items: $ref: "#/components/schemas/referenceNumber" carrierMessages: description: Messages returned from the carrier(s). type: array items: $ref: "#/components/schemas/carrierMessage" packageShippingInfo: properties: id: type: string labels: type: array items: $ref: "#/components/schemas/packageLabel" rate: type: string rateCurrencyCode: type: string trackingNumber: type: string carrierMessage: properties: source: type: string carrier: type: string message: type: string packageLabel: properties: labelData: description: The base 64 encoded label data. type: string labelFormat: description: The format (PNG image, PDF document, etc.) of the label data. type: string enum: - PDF - PNG - GIF - ZPL # Zebra Printer Language document - EPL # Eltron Printer Language document - DPL # Datamax Printer Language document mimeType: description: The MIME type of the label data. type: string documentInfo: properties: fileName: type: string documentId: type: string documentGroupId: type: string #---Errors--------------------------------------------------------------------------------------------- error400: properties: message: type: string path: type: array items: type: string type: type: string context: type: object properties: child: type: string value: type: array items: type: object properties: type: type: string value: type: string key: type: string label: type: string error401: required: - statusCode - error - message properties: statusCode: type: integer description: Error code example: 401 error: type: string description: Detail about the error status code message: type: string description: Specifies issue attributes: type: object properties: error: type: string error403: required: - statusCode - error - message properties: statusCode: type: integer description: Error code example: 403 error: type: string description: detail about the error status code example: Forbidden message: type: string description: Specifies issue example: Invalid customerCode error404: required: - statusCode - error - message properties: statusCode: type: integer description: Error code example: 404 error: type: string description: Detail about the error status code example: Not Found message: type: string description: Specifies issue example: Not Found error422: required: - statusCode - error - message properties: statusCode: type: integer description: Error code example: 422 error: type: string description: Detail about the error status code example: Unprocessable Entity message: type: string description: Specifies issue example: Bin Cost is not valid. error424: required: - statusCode - error - message properties: statusCode: type: integer description: Failed Dependency example: 424 error: type: string description: Detail about the error status code message: type: string description: Specifies issue attributes: type: object properties: error: type: string #---Enums---------------------------------------------------------------------------------------------- packageCodeRatingEnum: type: string description: "C.H. Robinson defined code for packaging type/code. Here is a list of the most commonly used packagingCodes: \n\n`BAL` - Bale, `BAG` - Bags, `BIN` - Bin, `BOX` - Boxes, `CTN` - Cartons \n`CAS` - Case, `CRT` - Crates, `PKG` - Package, `EAC` - Eaches, `PLT` - Pallet, `PCS` - Pieces \n\nFor a detailed description of all enumerated codes please find them here. \n\n ### Required if quote will be used to create an Order." #$ref: '#/components/schemas/packageCodeEnumRate' enum: - BAL - BIN - BOT - BXT - JAR - LSE - LUG - OTHR - REL - SAK - SKD - SKE - SLP - TLD - TRY - Empty - BAG - BOX - BDL - CTN - CAS - CRT - DZ - DRM - EAC - GYL - HDW - LNFT - PKG - PAL - PLT - PCS - LBS - ROL - TOT - YD - Skids - GAL - KIT - FT - PAD - PR - SET - SHT - M - KG - IBC - BAT - AST - CUB - RKS - PCK - TH - 24BIN - 30BIN - 36BIN - 40BIN - BSHL - CLLPK - DRC - ECO - EURO - FLAT - HFBIN - HFCTN - HVYPK - IFCO - I6408 - I6411 - I6413 - I6416 - I6419 - I6423 - I6425 - I6428 - ORBIS - O6409 - O6411 - O6413 - O6416 - O6419 - O6425 - O6428 - P4311 - P4317 - P6408 - P6411 - P6413 - P6416 - P6419 - P6423 - P6425 - P6428 - RPC - R6411 - R6413 - R6416 - TNBIN - TOSCA - T6408 - T6411 - T6413 - T6416 - T6419 - T6423 - T6425 - T6428 - WDCRT - BRL - RCK - TUB - CG - DSP - SQF - CYL - KEG - IFCLB - PLT1 - PLT2 - PLT3 - CAR - COIL - PI - GOH - BLK - POG - L - IPLT packageCodeEnum: type: string description: "C.H. Robinson defined code for packaging type/code. Here is a list of the most commonly used packagingCodes: \n\n`BAL` - Bale, `BAG` - Bags, `BIN` - Bin, `BOX` - Boxes, `CTN` - Cartons \n`CAS` - Case, `CRT` - Crates, `PKG` - Package, `EAC` - Eaches, `PLT` - Pallet, `PCS` - Pieces \n\nFor a detailed description of all enumerated codes please find them here." # $ref: '#/components/schemas/packageCodeEnum' enum: - BAL - BIN - BOT - BXT - JAR - LSE - LUG - OTHR - REL - SAK - SKD - SKE - SLP - TLD - TRY - Empty - BAG - BOX - BDL - CTN - CAS - CRT - DZ - DRM - EAC - GYL - HDW - LNFT - PKG - PAL - PLT - PCS - LBS - ROL - TOT - YD - Skids - GAL - KIT - FT - PAD - PR - SET - SHT - M - KG - IBC - BAT - AST - CUB - RKS - PCK - TH - 24BIN - 30BIN - 36BIN - 40BIN - BSHL - CLLPK - DRC - ECO - EURO - FLAT - HFBIN - HFCTN - HVYPK - IFCO - I6408 - I6411 - I6413 - I6416 - I6419 - I6423 - I6425 - I6428 - ORBIS - O6409 - O6411 - O6413 - O6416 - O6419 - O6425 - O6428 - P4311 - P4317 - P6408 - P6411 - P6413 - P6416 - P6419 - P6423 - P6425 - P6428 - RPC - R6411 - R6413 - R6416 - TNBIN - TOSCA - T6408 - T6411 - T6413 - T6416 - T6419 - T6423 - T6425 - T6428 - WDCRT - BRL - RCK - TUB - CG - DSP - SQF - CYL - KEG - IFCLB - PLT1 - PLT2 - PLT3 - CAR - COIL - PI - GOH - BLK - POG - L - IPLT - RORO - 45HC - 45HR - 40HC - 40 - 40OT - 40HR - 40RF - 40FR - 20HC - 20 - 20OT - 20FR - 45GP parcelPackageCodeEnum: type: string default: CUSTPKG description: "Used to specify if carrier-specific branded packaging is used for a parcel shipment. \n\nFor a detailed description of all enumerated codes please find them here." # $ref: '#/components/schemas/parcelPackageCodeEnum' enum: - FDXNVLP - FDXPK - FDXBX - FDXTB - FDX10KGBX - FDX25KGBX - UPSLTTR - UPSTUB - UPSPK - UPSXPRSSBX - UPS25KGBX - UPS10KGBX - UPSPLLT - USPSPCKG - USPSCRD - USPSLTTR - USPSPRCL - USPSMDUMFLTRTBX - USPSFLTRTNVLP - USPSRRGULRPRCL - USPSLRGFLTRTBX - USPSLRGPRCL - USPSVRSZDPRCL - USPSSMLLFLTRTBX - USPSFLTRTLGLNVLP - USPSFLTRTPDDDNVLP - USPSFLTRTGFTCRDNVLP - USPSFLTRTWNDWNVLP - USPSFLTRTCRDBRDNVLP - USPSSMLLFLTRTNVLP - USPSDVDFLTRTBX - USPSLRGVDFLTRTBX - USPSRGNLRTBX - USPSRGNLRTBXB - DHLLBPK - DHLBX - DHLLTTR - CUSTPKG - UPSSmallExpressBox - UPSMediumExpressBox - UPSLargeExpressBox contactTypeEnum: type: string description: > Indicates the type of contact specified: * `Vendor` - Vendor party (Non Transportation Supplier) * `Buyer` - Buyer Party * `Contact` - Contact Party * `OrderedBy` - Ordered By Party on the Order or Load * `NotifyParty` - Notify Party * `OnlineContact` - CHRWOnline Contact * `SchedWith` - Scheduled With * `POCustomer` - Customer on the Purchase Order #$ref: '#/components/schemas/contactTypeEnum' enum: - "Vendor" - "Buyer" - "Contact" - "OrderedBy" - "NotifyParty" - "OnlineContact" - "SchedWith" - "POCustomer" contactPositionEnum: type: string description: "Indicates the type of contact. \n\nFor a detailed description of all enumerated codes please find them here. \n\n ### " #$ref: '#/components/schemas/contactPositionEnum' enum: - "AA" - "AM" - "AP" - "AR" - "AUD" - "BILL" - "CEO" - "CFO" - "CIO" - "Claims" - "CLERK" - "CM" - "CO" - "CONTROLLER" - "COO" - "CSR" - "DIF" - "DIR" - "DISP" - "EDI" - "EVP" - "EVPO" - "EVPSC" - "IO" - "IS" - "ITM" - "LAW" - "LP" - "Manager" - "MIS" - "OPM" - "OPS" - "OWN" - "PAY" - "Pchs" - "PM" - "PRES" - "RATES" - "Safety Ops" - "SALES" - "SM" - "TM" - "TRANMAN" - "TRM" - "TRSR" - "VP" - "VPSOUR" - "WHSE" - "WM" - "WO" - "WR" - "WS" contactMethodEnum: type: string description: > Indicates the best method for reaching the specified contact. #$ref: '#/components/schemas/contactMethodEnum' enum: - "Email" - "Phone" - "Fax" weightUomEnum: type: string description: "Unit of measure for weight parameters." #$ref: '#/components/schemas/weightUomEnum' enum: - "Pounds" - "Kilograms" volumeUomEnum: type: string description: "Unit of measure for volume parameters." #$ref: '#/components/schemas/volumeUomEnum' enum: - "CubicFeet" - "CubicMeters" linearUomEnum: type: string description: "Unit of measure for height, width, and length parameters." #$ref: '#/components/schemas/linearUomEnum' enum: - "Inches" - "Feet" - "Centimeters" - "Meters" temperatureUomEnum: type: string description: "Unit of measure for temperature parameters." #$ref: '#/components/schemas/temperatureUomEnum' enum: - "Fahrenheit" - "Celsius" - "Empty" temperatureSensitiveEnum: type: string description: > Indicates if temperature control is needed, and what level: * `Dry` - Dry * `Fresh` - Fresh (25 to 32 degrees) * `Frozen` - Frozen (-10 to 0 degrees) * `Chilled` - Chilled (40 to 60 degrees) * `DeepFrozen` - Deep Frozen (-20 to -20 degrees) * `Refrigerated` - Refrigerated (33 to 39 degrees) * `Protect` - Protect (33 to 60 degrees) * `Custom` - Custom * `Produce` - Produce * `Mixed` - Mixed * `Empty` - Empty #$ref: '#/components/schemas/temperatureSensitiveEnum' enum: - "Dry" - "Fresh" - "Frozen" - "Chilled" - "DeepFrozen" - "Refrigerated" - "Protect" - "Produce" - "Mixed" - "Empty" distanceUomEnum: type: string description: "Unit of measure for distance parameters." #$ref: '#/components/schemas/distanceUomEnum' enum: - "Miles" - "Kilometers" stateProvinceCodeEnum: type: string description: "Indicate the state or province of the location. \n\nFor a detailed description of all enumerated codes please find them here." #$ref: '#/components/schemas/stateProvinceEnum' enum: - "1" - "10" - "11" - "12" - "13" - "14" - "15" - "16" - "17" - "18" - "19" - "2" - "20" - "21" - "22" - "23" - "24" - "25" - "26" - "27" - "28" - "29" - "3" - "30" - "31" - "32" - "33" - "34" - "35" - "36" - "37" - "38" - "39" - "4" - "40" - "41" - "42" - "43" - "44" - "45" - "46" - "47" - "48" - "49" - "5" - "50" - "51" - "52" - "53" - "54" - "6" - "61" - "62" - "63" - "64" - "65" - "67" - "7" - "71" - "76" - "79" - "8" - "81" - "84" - "86" - "89" - "9" - "91" - "92" - "95" - "A" - "AA" - "AB" - "AC" - "AE" - "AG" - "AGU" - "AI" - "AK" - "AL" - "AM" - "AN" - "AO" - "AP" - "AQ" - "AR" - "AS" - "AT" - "AUK" - "AV" - "AZ" - "B" - "BA" - "BC" - "BCN" - "BCS" - "BG" - "BI" - "BL" - "BM" - "BN" - "BO" - "BOP" - "BR" - "BS" - "BT" - "BZ" - "C" - "CA" - "CAM" - "CAN" - "CB" - "CE" - "CH" - "CHH" - "CHP" - "CI" - "CL" - "CN" - "CO" - "COA" - "COL" - "CR" - "CS" - "CT" - "CZ" - "D" - "DC" - "DD" - "DE" - "DF" - "DL" - "DN" - "DUR" - "E" - "EN" - "ES" - "F" - "FC" - "FE" - "FG" - "FI" - "FL" - "FM" - "FR" - "G" - "GA" - "GE" - "GIS" - "GJ" - "GO" - "GR" - "GRO" - "GU" - "GUA" - "H" - "HI" - "HID" - "HKB" - "HP" - "HR" - "IA" - "ID" - "IL" - "IM" - "IN" - "IS" - "J" - "JAL" - "JH" - "JK" - "K" - "KA" - "KL" - "KR" - "KS" - "KY" - "L" - "LA" - "LC" - "LD" - "LE" - "LI" - "LL" - "LO" - "LT" - "LU" - "M" - "MA" - "MB" - "MBH" - "MC" - "MD" - "ME" - "MEX" - "MG" - "MH" - "MI" - "MIC" - "ML" - "MN" - "MO" - "MOR" - "MP" - "MS" - "MT" - "MWT" - "MZ" - "N" - "NA" - "NAY" - "NB" - "NC" - "ND" - "NE" - "NH" - "NJ" - "NL" - "NLE" - "NM" - "NO" - "NS" - "NSN" - "NSW" - "NT" - "NTL" - "NU" - "NV" - "NY" - "O" - "OAX" - "OG" - "OH" - "OI" - "OK" - "ON" - "OR" - "OT" - "OTA" - "P" - "PA" - "PB" - "PC" - "PD" - "PE" - "PG" - "PI" - "PN" - "PO" - "PR" - "PT" - "PU" - "PUE" - "PV" - "PY" - "PZ" - "Q" - "QC" - "QLD" - "QU" - "QUE" - "R" - "RA" - "RC" - "RE" - "RG" - "RI" - "RJ" - "RM" - "RN" - "RO" - "ROO" - "RR" - "RS" - "S" - "SA" - "SC" - "SD" - "SE" - "SI" - "SIN" - "SJ" - "SK" - "SLP" - "SO" - "SON" - "SP" - "SR" - "SS" - "STL" - "SV" - "T" - "TA" - "TAB" - "TAM" - "TAS" - "TE" - "TG" - "TKI" - "TLA" - "TN" - "TO" - "TP" - "TR" - "TS" - "TV" - "TX" - "U" - "UD" - "UL" - "UM" - "UP" - "UT" - "V" - "VA" - "VB" - "VC" - "VE" - "VER" - "VI" - "VIC" - "VR" - "VS" - "VT" - "VV" - "W" - "WA" - "WB" - "WGN" - "WI" - "WKO" - "WTC" - "WV" - "WY" - "X" - "Y" - "YT" - "YUC" - "Z" - "ZAC" stateProvinceCodeRatingEnum: type: string description: "Indicate the state or province of the location. \n\nFor a detailed description of all enumerated codes please find them here. \n\n ### Required if quote will be used to create an Order. \n\n ### **If you plan to provide this information on the order portion of the call, it is not required in the rating call." #$ref: '#/components/schemas/stateProvinceEnum' enum: - "A" - "B" - "C" - "D" - "E" - "F" - "G" - "H" - "J" - "K" - "L" - "M" - "N" - "P" - "Q" - "R" - "S" - "T" - "U" - "V" - "W" - "X" - "Y" - "Z" - "CT" - "NSW" - "NT" - "QLD" - "SA" - "TS" - "VIC" - "WA" - "O" - "AC" - "AL" - "AM" - "AP" - "BA" - "CE" - "DF" - "ES" - "GO" - "MA" - "MG" - "MS" - "MT" - "PA" - "PB" - "PE" - "PI" - "PR" - "RJ" - "RN" - "RO" - "RR" - "RS" - "SC" - "SE" - "SP" - "TO" - "AB" - "BC" - "MB" - "NB" - "NL" - "NS" - "NU" - "ON" - "QC" - "SK" - "YT" - "AI" - "AN" - "AR" - "AT" - "BI" - "CO" - "LI" - "LL" - "ML" - "RM" - "TA" - "VS" - "11" - "12" - "13" - "14" - "15" - "21" - "22" - "23" - "31" - "32" - "33" - "34" - "35" - "36" - "37" - "41" - "42" - "43" - "44" - "45" - "46" - "50" - "51" - "52" - "53" - "54" - "61" - "62" - "63" - "64" - "65" - "71" - "91" - "92" - "SJ" - "BL" - "BM" - "BS" - "CA" - "GA" - "OI" - "QU" - "AS" - "BR" - "CH" - "DD" - "DL" - "DN" - "GJ" - "HP" - "HR" - "JH" - "JK" - "KA" - "KL" - "LD" - "MH" - "MN" - "MP" - "MZ" - "OR" - "PY" - "TN" - "TR" - "UL" - "UP" - "WB" - "1" - "2" - "3" - "4" - "5" - "6" - "7" - "8" - "9" - "10" - "16" - "17" - "18" - "19" - "20" - "24" - "25" - "26" - "27" - "28" - "29" - "30" - "38" - "39" - "40" - "47" - "48" - "49" - "AGU" - "BCN" - "BCS" - "CAM" - "CHH" - "CHP" - "COA" - "COL" - "DUR" - "GRO" - "GUA" - "HID" - "JAL" - "MEX" - "MIC" - "MOR" - "NAY" - "NLE" - "OAX" - "PUE" - "QUE" - "ROO" - "SIN" - "SLP" - "SON" - "TAB" - "TAM" - "TLA" - "VER" - "YUC" - "ZAC" - "AUK" - "BOP" - "CAN" - "GIS" - "HKB" - "MBH" - "MWT" - "NSN" - "NTL" - "OTA" - "STL" - "TAS" - "TKI" - "WGN" - "WKO" - "WTC" - "67" - "76" - "79" - "81" - "84" - "86" - "89" - "95" - "AK" - "AZ" - "DC" - "DE" - "FL" - "GU" - "HI" - "IA" - "ID" - "IL" - "IN" - "KS" - "KY" - "LA" - "MD" - "ME" - "MI" - "MO" - "NC" - "ND" - "NE" - "NH" - "NJ" - "NM" - "NV" - "NY" - "OH" - "OK" - "RI" - "SD" - "TX" - "UM" - "UT" - "VA" - "VI" - "VT" - "WI" - "WV" - "WY" - "AG" - "AO" - "AV" - "BT" - "BN" - "BG" - "BO" - "BZ" - "CL" - "CB" - "CI" - "CZ" - "CS" - "CR" - "KR" - "CN" - "EN" - "FM" - "FE" - "FI" - "FG" - "FC" - "FR" - "GE" - "GR" - "IM" - "IS" - "AQ" - "LT" - "LE" - "LC" - "LO" - "LU" - "MC" - "NA" - "NO" - "OG" - "OT" - "PD" - "PV" - "PG" - "PU" - "PC" - "PT" - "PN" - "PZ" - "PO" - "RG" - "RA" - "RC" - "RE" - "SS" - "SV" - "SI" - "SO" - "SR" - "TE" - "TP" - "TV" - "UD" - "VE" - "VB" - "VC" - "VR" - "VV" - "TG" - "AA" - "AE" countryCodeEnum: type: string description: "Indicate the country of the location. \n\nFor a detailed description of all enumerated codes please find them here." #$ref: '#/components/schemas/countryCodeEnum' enum: - "AD" - "AE" - "AF" - "AG" - "AI" - "AL" - "AM" - "AO" - "AQ" - "AR" - "AS" - "AT" - "AU" - "AW" - "AZ" - "BA" - "BB" - "BD" - "BE" - "BF" - "BG" - "BH" - "BI" - "BJ" - "BM" - "BN" - "BO" - "BR" - "BS" - "BT" - "MM" - "BV" - "BW" - "BY" - "BZ" - "CA" - "CC" - "CD" - "CF" - "CG" - "CH" - "CI" - "CK" - "CL" - "CM" - "CN" - "CO" - "CR" - "RS" - "CU" - "CV" - "CX" - "CY" - "CZ" - "DE" - "DJ" - "DK" - "DM" - "DO" - "DZ" - "EC" - "EE" - "EG" - "EH" - "ER" - "ES" - "ET" - "FI" - "FJ" - "FK" - "FM" - "FO" - "FR" - "GA" - "GD" - "GE" - "GF" - "GH" - "GI" - "GL" - "GM" - "GN" - "GP" - "GQ" - "GR" - "GS" - "GT" - "GU" - "GW" - "GY" - "HK" - "HM" - "HN" - "HR" - "HT" - "HU" - "ID" - "IE" - "IL" - "IN" - "IO" - "IQ" - "IR" - "IS" - "IT" - "JM" - "JO" - "JP" - "KE" - "KG" - "KH" - "KI" - "KM" - "KN" - "KP" - "KR" - "KW" - "KY" - "KZ" - "LA" - "LB" - "LC" - "LI" - "LK" - "LR" - "LS" - "LT" - "LU" - "LV" - "LY" - "MA" - "MC" - "MD" - "MG" - "MH" - "MK" - "ML" - "MN" - "MO" - "MP" - "MQ" - "MR" - "MS" - "MT" - "MU" - "MV" - "MW" - "MX" - "MY" - "MZ" - "NA" - "NC" - "NE" - "NF" - "NG" - "NI" - "NL" - "NO" - "NP" - "NR" - "NU" - "NZ" - "OM" - "PA" - "PE" - "PF" - "PG" - "PH" - "PK" - "PL" - "PM" - "PN" - "PR" - "PS" - "PT" - "PW" - "PY" - "QA" - "RE" - "RO" - "RU" - "RW" - "SA" - "SB" - "SC" - "SD" - "SE" - "SG" - "SH" - "SI" - "SJ" - "SK" - "SL" - "SM" - "SN" - "SO" - "SR" - "ST" - "SV" - "SY" - "SZ" - "TC" - "TD" - "TF" - "TG" - "TH" - "TJ" - "TK" - "TL" - "TM" - "TN" - "TO" - "TP" - "TR" - "TT" - "TV" - "TW" - "TZ" - "UA" - "UG" - "GB" - "UM" - "US" - "UY" - "UZ" - "VA" - "VC" - "VE" - "VG" - "VI" - "VN" - "VU" - "WF" - "WS" - "YE" - "YT" - "ZA" - "ZM" - "ZR" - "ZW" - "AX" - "GG" - "IM" - "JE" - "ME" - "MF" - "CW" - "SX" - "SS" - "IC" - "XC" - "XL" countryCodeRatingEnum: type: string description: "Indicate the country of the location.\n\nFor a detailed description of all enumerated codes please find them here." #$ref: '#/components/schemas/countryCodeRatingEnum' enum: - "AD" - "AE" - "AF" - "AG" - "AI" - "AL" - "AM" - "AO" - "AQ" - "AR" - "AS" - "AT" - "AU" - "AW" - "AZ" - "BA" - "BB" - "BD" - "BE" - "BF" - "BG" - "BH" - "BI" - "BJ" - "BM" - "BN" - "BO" - "BR" - "BS" - "BT" - "MM" - "BV" - "BW" - "BY" - "BZ" - "CA" - "CC" - "CD" - "CF" - "CG" - "CH" - "CI" - "CK" - "CL" - "CM" - "CN" - "CO" - "CR" - "RS" - "CU" - "CV" - "CX" - "CY" - "CZ" - "DE" - "DJ" - "DK" - "DM" - "DO" - "DZ" - "EC" - "EE" - "EG" - "EH" - "ER" - "ES" - "ET" - "FI" - "FJ" - "FK" - "FM" - "FO" - "FR" - "GA" - "GD" - "GE" - "GF" - "GH" - "GI" - "GL" - "GM" - "GN" - "GP" - "GQ" - "GR" - "GS" - "GT" - "GU" - "GW" - "GY" - "HK" - "HM" - "HN" - "HR" - "HT" - "HU" - "ID" - "IE" - "IL" - "IN" - "IO" - "IQ" - "IR" - "IS" - "IT" - "JM" - "JO" - "JP" - "KE" - "KG" - "KH" - "KI" - "KM" - "KN" - "KP" - "KR" - "KW" - "KY" - "KZ" - "LA" - "LB" - "LC" - "LI" - "LK" - "LR" - "LS" - "LT" - "LU" - "LV" - "LY" - "MA" - "MC" - "MD" - "MG" - "MH" - "MK" - "ML" - "MN" - "MO" - "MP" - "MQ" - "MR" - "MS" - "MT" - "MU" - "MV" - "MW" - "MX" - "MY" - "MZ" - "NA" - "NC" - "NE" - "NF" - "NG" - "NI" - "NL" - "NO" - "NP" - "NR" - "NU" - "NZ" - "OM" - "PA" - "PE" - "PF" - "PG" - "PH" - "PK" - "PL" - "PM" - "PN" - "PR" - "PS" - "PT" - "PW" - "PY" - "QA" - "RE" - "RO" - "RU" - "RW" - "SA" - "SB" - "SC" - "SD" - "SE" - "SG" - "SH" - "SI" - "SJ" - "SK" - "SL" - "SM" - "SN" - "SO" - "SR" - "ST" - "SV" - "SY" - "SZ" - "TC" - "TD" - "TF" - "TG" - "TH" - "TJ" - "TK" - "TL" - "TM" - "TN" - "TO" - "TP" - "TR" - "TT" - "TV" - "TW" - "TZ" - "UA" - "UG" - "GB" - "UM" - "US" - "UY" - "UZ" - "VA" - "VC" - "VE" - "VG" - "VI" - "VN" - "VU" - "WF" - "WS" - "YE" - "YT" - "ZA" - "ZM" - "ZR" - "ZW" - "AX" - "GG" - "IM" - "JE" - "ME" - "MF" - "CW" - "SX" - "SS" - "IC" - "XC" - "XL" referenceNumber: type: object required: - type - value properties: type: type: string description: "C.H. Robinson defined code for reference number types. Here is a list of the most commonly used reference number types: \n\n`SHID` - Shipment ID #, `MBOL` - Master Bill of Lading #, `PO` - Purchase Order #, `BOL` - Bill of Lading #, `CRID` - Customer Specific Ref Number, `CUSTPO` - Customer PO Number, `DEL` - Delivery #, `JNO` - Job Number, `PU` - Pickup #, `CON` - Customer Order Number, `APPT` - Appointment Number \n\nFor a detailed description of all enumerated codes please find them here." #$ref: '#/components/schemas/referenceNumber' enum: - "SHID" - "MBOL" - "PO" - "BOL" - "CFRM" - "CRID" - "CUSTPO" - "DEL" - "DIST" - "FIN" - "GL" - "JNO" - "PU" - "RANumber" - "RLPRO" - "MREF" - "Empty" - "PRO" - "CCN" - "SBOL" - "CON" - "APPT" - "CHRW_ID" - "FDA" - "IREF" - "LIC" - "ORD" - "PLU" - "SCAC" - "SEAL" - "SKU" - "SREF" - "STCC" - "TEB" - "VPO" - "WB" - "XXXX" - "TRIA" - "TRANS" - "GCC" - "SDATE" - "CDATE" - "ACCT" - "CCTR" - "IGM" - "GIGM" - "LIGM" - "SMTP" - "PERMIT" - "RNO" - "DVCN" - "PRCL" - "CPUC" - "SHPMD" - "AFR" - "BUYID" - "VNDID" - "DIV" - "DEPT" - "POTYPE" - "GRGI" - "DUNS" - "PALLETREF" - "CITTN" - "CIN" - "SHIPWITH" - "PN" - "UPC" - "PRCD" - "VESSEL" - "VOYAGE" - "FN" - "FEEDVESS" - "FEEDVOY" - "SHIPREF" - "CBL" - "SPAC" - "POLN" - "VPOLN" - "EIN" - "CNSG" - "PROFITCTR" - "MFGPART" - "PACKSLIP" - "THIRDPRTY" - "DEFATTR" - "FSTRK" - "FOItemID" - "POLineNum" - "PARCELSPC" - "CNS1" - "CNS2" - "CNS3" - "CNS4" - "CNS5" - "CNS6" - "CNS7" - "TREF" - "VREF" - "UPRICE" - "FWPARTY" - "BYPARTY" - "HBL" - "CBP" - "TRANSFER" - "SO" - "ORDTRK" - "QUOTEID" - "EQT" - "BOOTH" - "TS" - "OH #" - "CNTNR" - "VAS" - "Size" - "Color" - "Style" - "HCERT" - "B#" - "ETMSID" - "214-IMO" - "SHPWeight" - "SHPVolume" - "SHPDims" - "SERIALIZED" - "SERIALNUM" - "CPSIA" - "EDIINVREF" - "SQID" - "QSeqNum" - "OuterPkStu" - "GLC" - "COMP" - "COST" - "DTYGL" - "DTYCC" - "BRKGL" - "BRKCC" - "GPS" - "IAC" - "WHRCT" - "ERGUID" - "SONUM" - "CCNUM" - "PrimCCNUM" - "PrevCCNUM" - "CMRN" - "TRANSSHIP" - "PGIDATE" - "AESFIL" - "CUSTQUOTID" - "QUOTETRACE" - "ODATE" - "FRCLS" - "NMFC" - "OrderItemId" value: type: string minimum: 1 maximum: 100 description: The actual value of the reference number. specialRequirementRating: type: object properties: liftGate: type: boolean description: Indicates that a lift gate is needed. insidePickup: type: boolean description: Indicates that inside pickup is needed. **Only used on the origin/pick stop** insideDelivery: type: boolean description: Indicates that inside delivery is needed. **Only used on the destination/drop stop** residentialNonCommercial: type: boolean description: Indicates that a stop is residential non-commercial. limitedAccess: type: boolean description: Indicates that stop has limited access. tradeShoworConvention: type: boolean description: Indicates that stop is a trade show or convention. constructionSite: type: boolean description: Indicates that stop is a construction site. dropOffAtCarrierTerminal: type: boolean description: Indicates that customer will drop off at carrier terminal. **Only used on the origin/pick stop** pickupAtCarrierTerminal: type: boolean description: Indicates that customer will pickup at carrier terminal. **Only used on the destination/drop stop** hasDropTrailer: type: boolean description: Indicates if this location is drop trailer. appointmentNotification: type: boolean description: Indicates that stop has an appointment notification. Only used on the destination/drop stop. rateCodeEnum: type: string description: "C.H. Robinson defined code for rating code. Here is a list of the most commonly used rate codes: \n\n`400` - Line Haul, `405` - Fuel Surchage, `260` - Deliver Surchage, `IDL` - Inside Delivery, `IPU` - Inside Pickup \n`LFT` - Lift Gate or Forklift Service, `DET` - Detention, `DLA` - Delivery Limited Access, `PLA` - Pickup Limited Access \n`RES` - Residential Delivery Fee, `REP` - Residential Pickup Fee, `CSD` - Construction Site Delivery here." #$ref: '#/components/schemas/rateCodeEnum' enum: - "Customer" - "20" - "55" - "65" - "115" - "170" - "180" - "205" - "215" - "230" - "260" - "275" - "280" - "285" - "300" - "315" - "350" - "360" - "365" - "370" - "385" - "400" - "405" - "420" - "425" - "445" - "450" - "455" - "470" - "485" - "495" - "497" - "510" - "520" - "540" - "545" - "590" - "593" - "605" - "635" - "665" - "670" - "685" - "690" - "695" - "740" - "761" - "800" - "801" - "802" - "803" - "804" - "898" - "899" - "900" - "901" - "902" - "903" - "904" - "905" - "906" - "907" - "908" - "909" - "910" - "911" - "ACC" - "AGR" - "AGS" - "AIR" - "ALH" - "AMC" - "AMS" - "APT" - "ATR" - "BAT" - "BIO" - "BLC" - "BLK" - "BND" - "BRD" - "BSC" - "CAA" - "CEX" - "CHE" - "CHN" - "CIS" - "CLA" - "CLN" - "CLS" - "CNS" - "COA" - "COL" - "COU" - "CPC" - "CPE" - "CRE" - "CRS" - "CSE" - "CTC" - "CTG" - "CTL" - "CUF" - "CUS" - "DAM" - "DCF" - "DEL" - "DEN" - "DEP" - "DET" - "DFD" - "DFG" - "DHF" - "DIC" - "DIS" - "DMC" - "DOC" - "DOV" - "DRC" - "DRF" - "DSC" - "DTC" - "DTL" - "DTU" - "DTV" - "DUT" - "DYA" - "EBD" - "EEX" - "EMT" - "ENC" - "ESD" - "EUC" - "EXC" - "EXD" - "EXL" - "EXM" - "EXP" - "EXR" - "EXW" - "FDA" - "FDT" - "FFR" - "FLP" - "FTH" - "FTW" - "FTZ" - "FWA" - "FWC" - "GST" - "HMF" - "HOL" - "HST" - "IDL" - "IFS" - "IHT" - "INC" - "INS" - "INV" - "IPU" - "ISO" - "IST" - "ITS" - "LAA" - "LAY" - "LEC" - "LFT" - "LMF" - "LOA" - "LOC" - "MIC" - "MPF" - "MRK" - "MSG" - "NDD" - "NYD" - "NYP" - "OFU" - "OHF" - "OPT" - "ORD" - "ORF" - "ORM" - "OVR" - "PAE" - "PCS" - "PEC" - "PER" - "PFA" - "PKG" - "PMT" - "POD" - "PPH" - "PPN" - "PRT" - "PSC" - "PSH" - "PSS" - "PST" - "PUC" - "QST" - "RAJ" - "RCC" - "RCL" - "REC" - "REF" - "REP" - "RES" - "RET" - "SAT" - "SCL" - "SCS" - "SDL" - "SEC" - "SEG" - "SER" - "SET" - "SOC" - "SPS" - "SPT" - "SRA" - "SRG" - "SUR" - "SYA" - "TAK" - "TAL" - "TAR" - "TDT" - "THC" - "TMF" - "TRC" - "TRL" - "TTC" - "UNL" - "URC" - "VOR" - "WAR" - "WBF" - "WBL" - "WCT" - "WDC" - "WFL" - "WHC" - "WHF" - "WIO" - "WIS" - "WKT" - "WLB" - "WLC" - "WLS" - "WMS" - "WOP" - "WOT" - "WPC" - "WPK" - "WPL" - "WPP" - "WRC" - "WRE" - "WRI" - "WRS" - "WSS" - "WSW" - "WTV" - "WWT" - "WXD" - "XTN" - "496" - "BYD" - "BYP" - "DCV" - "ICT" - "PDD" - "PDO" - "TSA" - "UND" - "HAZ" - "ISF" - "913" - "914" - "915" - "916" - "316" - "BPC" - "BPR" - "BPS" - "BPT" - "CEM" - "CMX" - "COT" - "CUV" - "MXC" - "MXH" - "MXR" - "MXV" - "OVT" - "PEN" - "CTS" - "LRC" - "AMF" - "BPI" - "SCR" - "AES" - "NAV" - "DLA" - "PLA" - "PSF" - "CSF" - "894" - "895" - "896" - "897" - "EMN" - "SPF" - "TSC" - "HCR" - "CNT" - "CMM" - "RNT" - "PRF" - "CSD" - "HCD" - "CSP" - "GVP" - "GVD" - "HCP" - "NCP" - "NCD" - "BUV" - "COW" - "HOS" - "INP" - "RAP" - "SIE" - "TAW" - "OTD" - "MES" - "ENS" - "ACF" - "SLF" - "BLR" - "FLT" - "917" - "FCP" - "GSI" - "SMA" - "CFI" - "EXT" - "EXY" - "AAI" - "CAS" - "CCF" - "CMC" - "DCC" - "DOF" - "EDC" - "EMS" - "ERF" - "FLC" - "FUC" - "GAS" - "GTA" - "HBL" - "LBE" - "LUC" - "MLC" - "PAC" - "PCH" - "PRC" - "PRS" - "PUD" - "SCH" - "STR" - "STU" - "TPA" - "OCT" - "STC" - "EPC" - "DPC" - "STD" - "RFC" - "SYC" - "SED" - "MEC" - "SUF" - "IAC" - "CFS" - "BTF" - "ESS" - "AMD" - "ORC" - "LIF" - "PCF" - "GIO" - "TLX" - "GAT" - "LBL" - "LCG" - "LBF" - "HLS" - "IMP" - "CIF" - "CCE" - "EDN" - "HET" - "PMU" - "HEL" - "STM" - "TOL" - "VAC" - "PRP" - "PDC" - "SBC" - "PFC" - "TDR" - "OTH" - "DTH" - "ODO" - "DDO" - "AWB" - "CYC" - "DEC" - "FAF" - "GRI" - "LCL" - "PCC" - "PPF" - "TPF" - "WVF" - "CSR" - "27" - "GSC" - "ATC" - "ECV" - "GAR" - "BTR" - "CRD" - "IVT" - "TAP" - "SEN" - "IVP" - "IBP" - "COC" - "DRY" - "FOB" - "EWC" - "HTS" - "DSB" - "HTC" - "FAH" - "EIC" - "NPC" - "LSF" - "AHD" - "ESV" - "FCC" - "PEP" - "OGA" - "MFE" - "CAH" - "GOA" - "75" - "CBT" - "DCT" - "921" - "922" - "COV" - "DBR" - "IAT" - "POM" - "ACI" - "ASF" - "BOK" - "CDD" - "CDF" - "COF" - "CVE" - "DCH" - "DDP" - "DKF" - "DMI" - "ESC" - "EXA" - "EXO" - "LCH" - "PES" - "VMS" - "SRC" - "CFE" - "CDA" - "IEC" - "DGS" - "HAS" - "701" - "750" - "751" - "753" - "754" - "755" - "756" - "1401" - "1402" - "1403" - "DTF" - "OTF" - "SRD" - "SRO" - "1900" - "2000" - "2100" - "INF" - "DDT" - "DUF" - "EMF" - "LYO" - "LYD" - "999" - "145" - "ADV" - "AMB" - "ARB" - "BEY" - "BKA" - "BSS" - "CBL" - "CFL" - "CTF" - "DAA" - "DEM" - "FAK" - "FCB" - "GSS" - "HAN" - "HHB" - "HRS" - "HZC" - "IFC" - "LAB" - "LFC" - "MIN" - "MNC" - "MSC" - "OCH" - "PIR" - "POS" - "PTS" - "PWT" - "PYS" - "RAM" - "RLS" - "RMC" - "SPC" - "SSF" - "STO" - "STP" - "SWC" - "TAY" - "TER" - "TRM" - "WEA" - "WFG" - "WFH" - "IFF" - "CME" - "MDF" - "CPV" - "EMA" - "EPF" - "TPC" - "GOF" - "LOM" - "ISE" - "STF" - "CSU" - "AHF" - "MEF" - "FID" - "LCK" - "BYC" - "BCD" - "SO1" - "SO2" - "SO3" - "COR" - "TRE" - "LSK" - "DON" - "CTM" - "DCK" - "RPK" - "FGT" - "CHF" - "BRF" - "MKF" - "FES" - "CLM" - "PDR" - "AVP" - "GBB" - "GLF" - "GLT" - "MOTLF" - "MOTMF" - "TROLF" - "TROMF" - "REBAT" - "ASCMB" - "SPCRV" - "SPCAS" - "PENNY" - "WELLF" - "WELMF" - "BAMLF" - "BAMMF" - "SWTLF" - "ECOLF" - "ECOMF" - "SRVLF" - "SRVMF" - "N22LF" - "N23LF" - "OURLF" - "GLYLF" - "GLYMF" - "PNKLF" - "PECLF" - "GRNLF" - "SWTMF" - "MKU" - "EVC" - "APA" - "ARA" - "GAV" - "REB" - "SEL" - "ABG" - "ICG" - "TET" - "PAF" - "OSO" - "RSP" - "MIF" - "SPL" - "SPA" - "SPO" - "AFS" - "NCH" - "ASM" - "LGP" - "444" - "CNA" - "DEB" - "DOM" - "EGY" - "FER" - "FIM" - "FOR" - "FRA" - "FUM" - "HRT" - "MAU" - "PCD" - "PNL" - "PPC" - "RED" - "REI" - "SLU" - "VET" - "WAS" - "WAT" - "BIN" - "206" - "PLS" - "OCS" - "TPS" - "BUP" - "RBU" - "CMR" - "SPQ" - "IMF" - "IMV" - "BLD" - "1404" - "1405" - "1406" - "ENF" - "ENV" - "PRO" - "PRV" - "WAF" - "WAV" - "EPS" - "AKS" - "CCT" - "ECC" - "HIS" - "PRD" - "TRR" - "RIT" - "GIT" - "BAC" - "CCR" - "CLC" - "DCR" - "SC1" - "FCH" - "AFC" - "WMF" - "IFP" - "OSP" - "OCP" - "DSP" - "DCP" - "CBC" - "BRT" - "ECH" - "OID" - "OCR" - "RPT" - "SOS" - "TGS" - "TKP" - "WSC" - "SFA" - "HHC" - "RHC" - "IFA" - "FLB" - "LWS" - "MFD" - "SEP" - "SCA" - "PHL" - "JAM" - "VGM" - "HSB" - "PFS" - "CCS" - "DTY" - "RNR" - "RCD" - "DRP" - "PKU" - "EBP" - "LFD" - "CPL" - "AGM" - "APH" - "FSI" - "FWS" - "NHT" - "EPA" - "CPS" - "USL" - "NMF" - "RCO" - "ROS" - "OVS" - "TIV" - "TMR" - "RER" - "FTA" - "RBY" - "RBI" - "RBV" - "RBE" - "WAC" - "ABT" - "CON" - "QCC" - "SUN" - "SBS" - "SDV" - "NGT" - "GTD" - "ASR" - "SGR" - "SOG" - "1013" - "101" - "1014" - "DTZ" - "919" - "923" - "WTT" currencyCodeEnum: type: string description: "Code to indicate the currency being used. The most common currently in use with C.H. Robinson:\n\n* `USD` - US Dollar\n* `CAD` - Canadian Dollar \n* `MXN` - Mexican Peso\n* `EUR` - European Euro\n\n\n\nFor a detailed description of all enumerated codes please find them here." #$ref: '#/components/schemas/currencyCodeEnum' enum: - USD - CAD - EUR - MXN - CHF - GBP - HUF - CZK - NZD - PLN - ZAR - VEB - VND - TWD - TRY - SEK - SGD - RUB - NOK - HKD - INR - JPY - CLP - CNY - DKK - AUD - BRL - AED - PEN - THB - ARS - MYR - VEF - SAR - BBD - BHD - BMD - BSD - ILS - ISK - KES - KRW - KWD - OMR - PHP - PKR - QAR - RON - TTD - UAH - LKR - XPF - UYU - COP - CRC - FJD freightTermEnum: type: string description: "Code to indicate the freight term type:\n\n* `CL` - Collect\n* `PP` - Prepaid \n* `TP` - Third Party\n* `PC` - Prepaid and Add\n* `CC` - The Bill To is paying via a Credit Card\n\n" #$ref: '#/components/schemas/freightTermEnum' enum: - "CL" - "PP" - "TP" - "PC" - "CC" lateCodeEnum: type: string description: "C.H. Robinson defined code for a carrier being late to a stop or reason to schedule new appiontment. Here is a list of the most commonly used late reason codes: \n* `1` - Missed Delivery - Transportation carrier missed customer delivery\n* `3` - Returned to Shipper\n* `9` - Mechanical breakdown\n* `14` - Weather or Natural Disaster Related - Shipment delayed by natural disaster or severe weather\n\nFor a detailed description of all enumerated codes please find them here." #$ref: '#/components/schemas/lateCodeEnum' enum: - "1" - "2" - "3" - "4" - "5" - "6" - "7" - "8" - "9" - "10" - "11" - "12" - "13" - "14" - "15" - "16" - "17" - "18" - "19" - "20" - "21" - "22" - "23" - "24" - "25" - "26" - "27" - "28" - "29" - "30" - "31" - "32" - "33" - "34" - "35" - "36" - "37" - "38" - "39" - "40" - "41" - "42" - "43" - "44" - "45" - "46" - "47" - "48" - "49" - "50" - "51" - "52" - "53" - "54" - "55" - "56" - "57" - "58" - "59" - "60" - "61" - "62" - "63" - "64" - "65" - "66" - "67" - "68" - "69" - "70" - "71" - "72" - "73" - "74" - "75" - "76" - "77" - "78" - "79" - "80" - "81" - "82" - "83" - "84" - "85" - "86" - "87" - "88" - "89" - "90" - "CSC" - "CSCCHR" - "91" - "92" - "AE" - "BH" - "BO" - "CA" - "CR" - "CSCCAR" - "CSCCUS" - "CSCEDI" - "CSCREQ" - "CSCWEA" - "DR" - "EE" - "MA" - "ME" - "VI" - "WR" - "93" - "94" - "95" - "96" - "97" - "98" - "99" - "100" - "0" tarpTypeEnum: type: string description: > Details the type of tarp required for flat bed trailer. * `10` - Ten Feet * `2` - Two Feet * `4` - Four Feet * `6` - Six Feet * `8` - Eight Feet * `MESH` - Nursery/Mesh * `NO TARP` - No Tarp Required * `SMOKE` - Smoke Tarp * `TOP` - Top #$ref: '#/components/schemas/tarpType' enum: - "10" - "2" - "4" - "6" - "8" - "MESH" - "NO TARP" - "SMOKE" - "TOP" loadingTypeEnum: type: string description: > Describes how trailer will need to be loaded. * `CRANE` - Top/crane * `REAR` - Rear * `SIDE` - Side * `REAR/SIDE` - Rear/side * `TOP/SIDE` - Top/side * `DOCK` - Dock * `STRING` - String * `STRING/TOW` - String/tow #$ref: '#/components/schemas/loadingType' enum: - "CRANE" - "REAR" - "SIDE" - "REAR/SIDE" - "TOP/SIDE" - "DOCK" - "STRING" - "STRING/TOW" itemEquipmentTypeEnum: type: string description: "Indicates the equipment type needed to move the item.\n\nFor a detailed description of all enumerated codes please find them here." enum: - "B" - "BT" - "CN" - "CV" - "DD" - "F" - "FA" - "FD" - "FO" - "FS" - "HS" - "MX" - "RGN" - "SD" - "SF" - "ST" - "SDC" - "DDC" - "V" - "W" - "STR" - "SS" - "TK" - "P" - "FV" - "R" - "IC" - "IR" - "IT" - "RM" - "BDPT" - "BEND" - "BFGD" - "BHOP" - "BST" - "BVT" - "BLAT" - "BLFGT" - "BLFRPT" - "BLRL" - "BLSS" - "PU" - "OT" - "TT" - "MF" - "SA" - "TP" - "TM" - "SSD" - "PRT" - "SETT" - "BEAM" - "BLADE" - "BARGE" - "VS" orderEventLocationType: type: string description: Identifies the type of stop the location is. enum: - Pick - Drop - Intermediate - OriginPort - DestinationPort - IntermediatePort #$ref: '#/components/schemas/orderEventLocationType' orderEventLocationStyle: type: string description: identifies the style of the stop. enum: - Customers - Distributor - Warehouse - Plant - Pool - CrossDock - WarehouseSpecial - Agent - Terminal - RailRamp - Port #$ref: '#/components/schemas/orderEventLocationStyle' orderEventServiceLevel: type: string description: Identifies the level of service. enum: - Standard - Expedited - TimeDefinite - SameDayNextFlightOut - SameDayCharter - NextDayDeliveryAM - NextDayDeliveryPM - ThreeDayDelivery - Economic - NextFlightOut - SameDayDelivery - NextDayCargoService - PriorityAM - SecondDayCargoService - SecondDayAM - SecondDayPM - NextDayTimeDefiniteDelivery - SecondDayTimeDefiniteDelivery - ThirdDayTimeDefiniteDelivery - EconomicTimeDefiniteDelivery - CharterService #$ref: '#/components/schemas/orderEventServiceLevel' serviceLevelEnum: type: string description: "C.H. Robinson defined code for a service offering.\n\nFor a detailed description of all enumerated codes please find them here." #$ref: '#/components/schemas/serviceOfferingEnum' enum: - "S" - "P" - "EXP" - "T/R" - "DED" - "TD" - "SD-NFO" - "SD-CH" - "ND-AM" - "ND-PM" - "3RD" - "ECON" - "BOX" - "BTC" - "HOP" - "ISO" - "COFC" - "TOFC" - "LB" - "PC" - "S-AIR" - "FCL" - "LCL" - "MCL" - "RORO" - "NFO" - "SAMEDAY" - "NEXT-CARGO" - "PRTY AM" - "SD-CARGO" - "SD-AM" - "SD-PM" - "TD-NEXT" - "TD-2D" - "TD-3D" - "TD-ECO" - "CHARTER" - "CORP-ND" - "SEC-ND" - "ECON-ND" - "DEF" - "PRTY" - "DC" - "OGC" - "CARGO" - "COMM" - "SD-US" - "ND-8" - "ND-10" - "ND-3" - "2D-AM" - "2D-PM" - "3D" - "DEF-R" - "DEF-G" - "DEF-CAD" - "INTL-S" - "INTL-3" - "INTL-5" - "FDXSTNDRDVRNGHT" - "FDXFRSTVRNGHT" - "FDX2DY" - "FDXXPRSSSVR" - "FDXINTLPRRTY" - "FDXINTLCNMY" - "FDXINTLFRST" - "FDX1DYFRGHT" - "FDX2DYFRGHT" - "FDX3DYFRGHT" - "FDXGRND" - "FDXGRNDHMDLVRY" - "FDXINTLPRRTYFRGHT" - "FDXINTLCNMYFRGHT" - "FDXRPFRSTINTLPRRTY" - "UPSNXTDYR" - "UPS2NDDYR" - "UPSGRUND" - "UPSWRLDWDXPRSSSM" - "UPSWRLDWDXPDTDSM" - "UPSSTNDRD" - "UPS3DYSLCT" - "UPSNXTDYRSVR" - "UPSNXTDYRRLY.M." - "UPSWRLDWDXPRSSPLUSSM" - "UPS2NDDYR.M." - "UPSSVR" - "USPSFRST-CLSSML" - "USPSPRRTYML" - "USPSMDML(SNGL-PC)" - "USPSNTLRMLM-BGS" - "USPSPRRTYMLINTL" - "USPSXPRSSML" - "DHLINTLDOCSRVC" - "DHLINTLDOCLTTRSRVC" - "DHLWRLDWDPRRTYXPRSS" - "PRLTRAIR9:00A" - "PRLTRAIR10:30A" - "PRLTRR" - "PRLTRGRND" - "PRLTRGRND9:00A" - "PRLTRGRND10:30A" - "PRLTRAIRUSA" - "PRLTRGRNDUSA" - "PRLTRINTLAIR" - "FDXPRRTYVRNGHT" - "Same" - "Next" - "2Day" - "3Day" - "Ground" - "FDXHOMEDEL" - "FDX2DYAM" - "UPSWRLDWDXPRSSS" - "UPSBSC" - "UPSSP" - "UPSSPU1LB" - "UPSSPM" - "UPSSPBPM" - "UPSRTRNSFLEX" - "USPSLibraryMail" - "USPSStandardPost" - "USPSFirstClassMailInt" - "USPSPriorityMailInt" - "USPSParcelSelect" - "USPSStandardMail" - "USPSCriticalMail" - "USPSFirstClassPkgInt" - "FDXSMPSTSELECT" - "FDXSMPSTMEDIA" - "FDXSMPSTBOUND" - "FDXSMPSTPRESORT" - "BARTOLINIXPRSS" - "SEURXPRSS" - "DHLDOMXPRSS" - "DHLDOMXPRSS9" - "DHLDOMXPRSS12" - "DHLXPRSS9" - "DHLXPRSS12" - "DHLECONSELECT" - "DHLXPRSSWWDOCECX" - "DHLXPRSSWWDOCDOX" - "DHLECONSELECTDOC" - "DHLXPRSS9DOC" - "DHLXPRSS12DOC" - "FDXINTLPRRTYDIRECT" - "TNTXPRSS9" - "TNTXPRSS10" - "TNTXPRSS12" - "TNTXPRSS" - "TNTECONXPRSS" - "TNTDOMXPRSS" - "TNTECONXPRSS12" - "TNTNEXTDAY9" - "TNTNEXTDAY10" - "TNTNEXTDAY12" - "TNTNEXTDAY" - "DHLPEPFORYOU" - "DHLPEPEUROPACK" - "DHLPEPEUROPLUS" - "DHLDOMECONSELECT" - "UPSEXPEDITED" - "SINGPOST" - "CORREIOS" - "TNTXPRSS8" - "TNTBUSPAK8" - "TNTBUSPAK9" - "TNTBUSPAK10" - "TNTBUSPAK12" - "TH" - "IHRC" - "IHPR" - "IHPA" - "QSEZPRRTYDM" - "SPPRRTYSGI" - "SPPRRTYSGO" - "SFXSTANDARD" - "SFXSSAMEDAY" - "SFXNEXTDAY" - "SFXECON" - "QSDSTD" - "CHD" - "OHD" hazardousGroupEnum: type: string description: > Dangerous goods are assigned into 3 packing groups (also known as UN Packing Group) in accordance with the degree of danger they present. * `I` - Group I - Major Danger * `II` - Group II - Medium Danger * `III` - Group III - Minor Danger #$ref: '#/components/schemas/hazardousGroupEnum' enum: - "I" - "II" - "III" hazmatCodeEnum: type: string description: > Defines the authorizing entity: * `C` - HazMat Canadian Regulatory Authority Codes * `D` - HazMat US Regulatory Authority Codes * `I` - HazMat MX/International Regulatory Authority Codes #$ref: '#/components/schemas/hazmatCodeEnum' enum: - "C" - "D" - "I" vesselStowageCategoryEnum: type: string description: > Indicates the HazMat Stowage category code according stowage requirements listed in the IMDG Code Dangerous Goods List. * `A` - Stowage category code A * `B` - Stowage category code B * `C` - Stowage category code C * `D` - Stowage category code D * `E` - Stowage category code E * `01` - Stowage category code 1 * `02` - Stowage category code 2 * `03` - Stowage category code 3 * `04` - Stowage category code 4 * `05` - Stowage category code 5 #$ref: '#/components/schemas/vesselStowageCategoryEnum' enum: - "A" - "B" - "C" - "D" - "E" - "01" - "02" - "03" - "04" - "05" marinePollutantCategory: type: string description: > Indicates the Marine Pollutant Category for Hazardous Materials. * `Severe Marine Pollutant` * `Marine Pollutant` # $ref: '#/components/schemas/marinePollutantCategory' enum: - "SevereMarinePollutant" - "MarinePollutant" additionalLocationTypeEnum: type: string description: > The additional locations types on the order. * `BailmentWarehouse` - Bailment Warehouse * `BillToParty` - Bill To Party * `Consignee` - Consignee * `DeliveryAddress` - Delivery Address * `Depositor` - Depositor * `Exporter` - Exporter * `NotifyParty1` - Notify Party 1 * `NotifyParty2` - Notify Party 2 * `PickupAddress` - Pickup Address * `Plant` - Plant * `SellingParty` - Selling Party * `ShipFrom` - Ship From * `ShipTo` - Ship To * `Shipper` - Shipper * `SoldToandShipTo` - Sold To and Ship To * `SoldTo` - Sold To if different from Bill To * `Supplier` - Supplier * `ThirdPartyAdministrator` - Third Party Administrator * `UltimateConsignee` - Ultimate Consignee * `Vendor` - Vendor * `Warehouse` - Warehouse #$ref: '#/components/schemas/additionalLocationTypeEnum' transportModeEnum: type: string description: > Defines the mode: * `LTL` - Less Than Truckload * `TL` - Truckload * `Air` - Air * `Ocean` - Ocean * `Bulk` - Bulk * `Consol` - Consolidated * `Flatbed` - Flatbed * `IMDL` - Intermodal #$ref: '#/components/schemas/transportModeEnum' enum: - "LTL" - "TL" - "Air" - "Ocean" - "Bulk" - "Consol" - "Flatbed" - "IMDL" condition: type: string description: Identifies the condition. enum: - Active - OnHold - PartiallyFinLocked - FinanciallyLocked - Rejected - Cancelled - WaitingAcceptance - WaitingRecommendation - NotShipReady - Unreleased #$ref: '#/components/schemas/condition' specialServicesEnum: type: string description: > Defines the specialServices: * `teamDriver` - indicates if truckload includes 2 drivers * `STF` - driver and equipment meet safe transportation of food standards * `tankerEndorsement` - driver is certified to move containers with liquids enum: - "teamDriver" - "STF" - "tankerEndorsement" #$ref: '#/components/schemas/specialServicesEnum' orderEventMode: type: string description: Identifies the mode of the service. enum: - Van - TemperatureControlled - Flatbed - Tank - Hopper - LessThanTruckload - LessThanTruckloadTemperatureControlled - LessThanTruckloadFlatbed - Parcel - HeavyAir - Carload - Intermodal - AllModes - Consolidation - ConsolidatedTemperatureControlled - Bulk - IntermodalTemperatureControlled - Air - Ocean - Tautliner #$ref: '#/components/schemas/orderEventMode' sellModeEnum: type: string description: > Defines the mode: * `LTL` - Less than Truckload Transportation * `TL` - Truckload Transportation * `DomesticAir` - Domestic Air Transportation * `Ocean` - Ocean Transportation * `IMDL` - Intermodal Full Container Transportation * `Bulk` - Bulk Transportation * `Consolidated` - Consolidated Transportation * `LTLFlatbed` - Less than Truckload Flatbed Transportation * `TLFlatbed` - Truckload Flatbed Transportation * `SmallParcel` - Small Parcel Transportation * `Tautliner` - Tatliner Transportation enum: - "LTL" - "TL" - "LTLFlatbed" - "TLFlatbed" - "IMDL" - "Bulk" - "Consolidated" - "DomesticAir" - "SmallParcel," - "Ocean" - "Tautliner" #$ref: '#/components/schemas/sellModeEnum' freightClassEnum: type: string description: "Indicates the freight class on this shipment. (Freight Class is a voluntary standard that provides a comparison of commodities moving in interstate, intrastate and foreign commerce. It is similar in concept to the groupings or grading systems that serve many other industries.)" enum: - "50" - "55" - "60" - "65" - "70" - "77.5" - "85" - "92.5" - "100" - "110" - "125" - "150" - "175" - "200" - "250" - "300" - "400" - "500" #$ref: '#/components/schemas/freightClassEnum' freightEstimateResponseEnum: type: number description: "Estimated freight class for the request. (Freight Class is a voluntary standard that provides a comparison of commodities moving in interstate, intrastate and foreign commerce. It is similar in concept to the groupings or grading systems that serve many other industries.)" enum: - 50 - 55 - 60 - 65 - 70 - 77.5 - 85 - 92.5 - 100 - 110 - 125 - 150 - 175 - 200 - 250 - 300 - 400 - 500 #$ref: '#/components/schemas/freightEstimateResponseEnum' availableShipmentEquipmentEnum: type: array description: "C.H. Robinson defined code for equipment.\n\nFor a detailed description of all enumerated codes please find them here." items: type: string enum: - "B" - "BARGE" - "BDPT" - "BEAM" - "BEND" - "BFGD" - "BHOP" - "BISO" - "BLADE" - "BLAT" - "BLFGT" - "BLFRPT" - "BLRL" - "BLSS" - "BST" - "BSTR" - "BT" - "BVT" - "BX50" - "BX50100S" - "BX50100SH" - "BX60" - "BX6070SC" - "CN" - "CO" - "CT" - "CV" - "DD" - "DDC" - "ET" - "F" - "FA" - "FC" - "FD" - "FO" - "FS" - "FV" - "GNDL" availableShipmentsModeEnum: type: array description: "C.H. Robinson defined code for mode.\n\nFor a detailed description of all enumerated codes please find them here." #$ref: '#/components/schemas/availableShipmentsModeEnum' items: type: string enum: - "A" - "B" - "D" - "F" - "H" - "I" - "J" - "L" - "M" - "O" - "P" - "R" - "S" - "T" - "V" - "W" - "Y" availableShipmentsRateEnum: type: string description: "C.H. Robinson defined rate code.\n\nFor a detailed description of all enumerated codes please find them here." #$ref: '#/components/schemas/availableShipmentsRateEnum' enum: - "C" - "CPU" - "CRI" - "CS" - "D" - "DE" - "E" - "FBL" - "FP" - "H" - "HV" - "IC" - "N" - "ND" - "P" - "S" - "SD" - "SH" - "TC" - "VC" specializedEquipmentCodeNAEnum: type: string description: "Code to indicate specialized equipment for NA. \n\nFor a detailed description of all enumerated codes please find them here." enum: - "2T" - "B" - "BARGE" - "BDPT" - "BEAM" - "BEND" - "BFGD" - "BHOP" - "BISO" - "BLADE" - "BLAT" - "BLFGT" - "BLFRPT" - "BLRL" - "BLSS" - "BST" - "BSTR" - "BT" - "BVT" - "BX50" - "BX50100S" - "BX50100SH" - "BX60" - "BX6070SC" - "CH" - "CN" - "CO" - "CT" - "CV" - "D" - "DAIR" - "DD" - "DDC" - "DR" - "ET" - "F" - "FC" - "FD" - "FO" - "FS" - "FV" - "GNDL" - "HFD" - "HFM" - "HOP" - "HS" - "IC" - "IR" - "IT" - "LT" - "LTL" - "MF" - "MT" - "MX" - "OCEAN" - "OT" - "P" - "PB" - "PLT" - "PO" - "PT" - "PU" - "QA" - "R" - "RGN" - "RM" - "SA" - "SD" - "SDC" - "SDD" - "SETT" - "SF" - "SFD" - "SFM" - "SRGN" - "SS" - "SSD" - "STR" - "TA" - "TK" - "TKR" - "TM" - "TP" - "TT" - "UC" - "V" - "VI" - "VS" - "VV" #$ref: '#/components/schemas/specializedEquipmentCodeNAEnum' specializedEquipmentCodeEUEnum: type: string description: "Code to indicate specialized equipment for EU. \n\nFor a detailed description of all enumerated codes please find them here." enum: - "AIR" - "B" - "BOAT" - "BX" - "CAR" - "COIL" - "DD" - "DDF" - "F" - "FO" - "FRI" - "IC" - "IR" - "IT" - "LTL" - "MT" - "MTIL" - "PT" - "RD" - "SIL" - "STK" - "T" - "TCOI" - "TIL" - "TIP" - "TK" - "TNK" - "V" - "WK" #$ref: '#/components/schemas/specializedEquipmentCodeEUEnum' roadMilestoneEventCodeEnum: type: string description: "Code that indicates the type of milestone being sent for a shipment being moved by truck. For a detailed description of all enumerated codes please find them here." #$ref: '#/components/schemas/roadMilestoneEventCodeEnum' enum: - "A3" - "A7" - "A9" - "AA" - "AB" - "AC" - "AF" - "AG" - "AH" - "AI" - "AJ" - "AM" - "AN" - "AP" - "AR" - "AV" - "B6" - "BA" - "BC" - "C1" - "CA" - "CD" - "CL" - "CP" - "D1" - "ED" - "EP" - "I1" - "J1" - "K1" - "L1" - "LD" - "LP" - "OA" - "OO" - "P1" - "PR" - "R1" - "RL" - "S1" - "SD" - "XA" - "X1" - "X2" - "X3" - "X4" - "X5" - "X6" - "X9" - "X8" - "XB" oceanMilestoneEventCodeEnum: type: string description: "Code that indicates the type of milestone being sent for a shipment being moved by boat. For a detailed description of all enumerated codes please find them here." #$ref: '#/components/schemas/ocentMilestoneEventCodeEnum' enum: - "2" - "3" - "A" - "A1" - "A2" - "A3" - "A4" - "AA" - "AC" - "AD" - "AE" - "AF" - "AG" - "AH" - "AI" - "AJ" - "AL" - "AM" - "AN" - "AO" - "AP" - "AR" - "AV" - "AW" - "B" - "BA" - "BC" - "BD" - "BE" - "BF" - "BR" - "C" - "C1" - "C2" - "CA" - "CB" - "CC" - "CD" - "CI" - "CO" - "CR" - "CS" - "CT" - "CU" - "CV" - "D" - "DA" - "DC" - "DN" - "DP" - "DR" - "DS" - "DT" - "E" - "EA" - "ED" - "EE" - "EP" - "ER" - "F" - "FP" - "FT" - "G" - "GI" - "GO" - "H" - "HA" - "HE" - "HF" - "HG" - "HH" - "HI" - "HR" - "I" - "IB" - "IR" - "J1" - "K1" - "L" - "LD" - "LP" - "MT" - "N" - "NC" - "ND" - "NF" - "NH" - "NO" - "NP" - "NR" - "NS" - "NT" - "NU" - "O" - "OA" - "OB" - "OF" - "OH" - "ON" - "P" - "PA" - "PB" - "PC" - "PD" - "PE" - "PF" - "PG" - "PH" - "PI" - "PJ" - "PK" - "PL" - "PM" - "PN" - "PO" - "PP" - "PQ" - "PR" - "PS" - "PT" - "PU" - "PV" - "PW" - "PX" - "R" - "RA" - "RB" - "RC" - "RD" - "RI" - "RL" - "RN" - "S" - "SA" - "SB" - "SC" - "SD" - "T" - "SI" - "SN" - "TC" - "TM" - "TO" - "U" - "UA" - "UB" - "UC" - "UD" - "UE" - "UP" - "UR" - "UV" - "UW" - "V" - "VA" - "VD" - "W" - "WH" - "WR" - "X" - "XA" - "X1" - "X2" - "X3" - "X4" - "X5" - "X6" - "X7" - "X9" - "X8" - "XB" - "Y" - "Z" railMilestoneEventCodeEnum: type: string description: "Code that indicates the type of milestone being sent for a shipment being moved by train. For a detailed description of all enumerated codes please find them here." #$ref: '#/components/schemas/railMilestoneEventCodeEnum' enum: - "3" - "6" - "7" - "9" - "A" - "B" - "C" - "D" - "E" - "F" - "G" - "I" - "J" - "K" - "L" - "M" - "P" - "Q" - "R" - "S" - "U" - "V" - "W" - "X" - "Y" - "Z" airMilestoneEventCodeEnum: type: string description: "Code that indicates the type of milestone being sent for a shipment being moved by plane. For a detailed description of all enumerated codes please find them here." #$ref: '#/components/schemas/airMilestoneEventCodeEnum' enum: - "ARR" - "AWD" - "AWR" - "BKD" - "CCD" - "CRC" - "DDL" - "DEP" - "DIS" - "DLV" - "FOH" - "MAN" - "NFD" - "OCI" - "OSI" - "PRE" - "RCF" - "RCS" - "RCT" - "TFD" - "TGC" - "TRM" - "ULD" milestoneStoptypeEnum: type: string description: "Identifies the type of stop the milestone is referencing.\n### If location is for a milestone that isn't tied to a stop then this field should be set to null. \n- 'P' - Pick \n- 'OA' - Origin Airport \n- 'OP' - Origin Port \n- 'OR' - Origin Ramp \n- 'OT' - Origin Terminal \n- 'D' - Drop \n- 'DA' - Destination Airport \n- 'DP' - Destination Port \n- 'DR' - Destination Ramp \n- 'DT' - Destination Terminal \n- 'IA' - Intermediate Airport \n- 'IP' - Intermediate Port \n- 'IR' - Intermediate Ramp \n- 'X' - Cross Dock \n- 'OF' - Origin Forwarder \n- 'OC' - Origin Crossdock \n- 'DF' - Destination Forwarder \n- 'DC' - Destination Crossdock \n- 'DY' - Dropyard" #$ref: '#/components/schemas/milestoneStoptypeEnum' enum: - P - OA - OP - OR - OT - D - DA - DP - DR - DT - IA - IP - IR - X - OF - OC - DF - DC - DY equipmentCodeEnum: type: string description: "### **Only one container type per rating request is currently supported." #$ref: '#/components/schemas/equipmentCodeEnum' enum: - "Van" - "Reefer" - "Flatbed" - "Lcl" - "StepDeck" - "FlatHotshot" - "Container20" - "Container40" - "Container40HighCube" - "Container45HighCube" - "Container20FlatRack" - "Container40FlatRack" - "Container40HighCubeFlatRack" - "Container45FlatRack" - "Container20OpenTop" - "Container40OpenTop" - "Container20Reefer" - "Container40Reefer" - "Container40HighCubeReefer" - "Container45Reefer" - "Container20ReeferDryUsage" - "Container40ReeferDryUsage" - "Container40HighCubeReeferDryUsage" - "Container45ReeferDryUsage" - "Container20Platform" invoiceMethodEnum: type: string description: > Method which customer will be invoiced. * `PP` - Pre-Paid * `CL` - Collect * `TP` - Third Party * `PC` - Pre-Paid and Add * `CC` - Credit Card enum: - "PP" - "CL" - "TP" - "PC" - "CC" #$ref: '#/components/schemas/invoiceMethodEnum' incoTermsEnum: type: string description: > The Incoterms or International Commercial Terms are a series of pre-defined commercial terms published by the International Chamber of Commerce (ICC) relating to international commercial law. * `DAT` - Delivered at Terminal * `DAP` - Delivered at Place * `CIF` - Cost Insurance & Freight * `CPT` - Carriage Paid To * `CIP` - Carriage & Insurance Paid To * `DDP` - Delivered duty paid * `EXW` - EX works * `FCA` - Free carrier at * `DPU` - Delivered at place unloaded * `FAS` - Free alongside ship * `FOB` - Free on Board * `CFR` - Cost and Freight * `PPD` - Prepaid * `COL` - Collect * `DAF` - Delivery at Frontier * `DDU` - Delivery Duty Unpaid * `DEQ` - Delivery Ex-Quay, Duty Unpaid * `DES` - Delivery Ex-Ship enum: - "DAT" - "DAP" - "CIF" - "CPT" - "CIP" - "DDP" - "EXW" - "FCA" - "DPU" - "FAS" - "FOB" - "CFR" - "PPD" - "COL" - "DAF" - "DDU" - "DEQ" - "DES" #$ref: '#/components/schemas/incoTermsEnum' movementTypeEnum: type: string description: > Specifies movement type of the shipment: * `OD` - "Origin Dray" * `DD` - "Destination Dray" * `OPDP` - "Origin Port to Destination Port" * `OPDD` - "Origin Port to Destination Door" * `ODDP` - "Origin Door to Destination Port" * `ODDD` - "Origin Door to Destination Door" * `ORDP` - "Origin Ramp to Destination Port" * `OPDR` - "Origin Port to Destination Ramp" * `ORDD` - "Origin Ramp to Destination Door " * `ODDR` - "Origin Door to Destination Ramp" * `ORDR` - "Origin Ramp to Destination Ramp" * `OADA` - "Origin Airport to Destination Airport" * `OADD` - "Origin Airport to Destination Door" * `ODDA` - "Origin Door to Destination Airport" * `ODOC` - "Origin Door to Origin CFS" * `ODDC` - "Origin Door to Destination CFS" * `OCDC` - "Origin CFS to Destination CFS" * `OCDD` - "Origin CFS to Destination Door" * `DCDD` - "Destination CFS to Destination Door" * `OCDP` - "Origin CFS to Destination Port" * `OPDC` - "Origin Port to Destination CFS" enum: - "OD" - "DD" - "OPDP" - "OPDD" - "ODDP" - "ODDD" - "ORDP" - "OPDR" - "ORDD" - "ODDR" - "ORDR" - "OADA" - "OADD" - "ODDA" - "ODOC" - "ODDC" - "OCDC" - "OCDD" - "DCDD" - "OCDP" - "OPDC" #$ref: '#/components/schemas/movementTypeEnum' shipmentContainerTypeEnum: type: string description: "Type of shipping container. \n\nFor a detailed description of all enumerated codes please find them here." enum: - 20CO - 20FR - 20FT - 20HC - 20HD - 20HP - 20IS - 20IT - 20NR - 20OT - 20PL - 20RE - 20RF - 20SD - 20SO - 20UG - 24FT - 24HC - 28FB - 30IS - 40CA - 40CO - 40DR - 40FB - 40FR - 40FT - 40H0 - 40HC - 40HD - 40HP - 40MA - 40NR - 40OT - 40RE - 40RF - 40RH - 40RR - 43FT - 45HC - 45HR - 45RF - 45TR - 48FB - 48TR - 53TR - 55TR - BBLK - LCL - PAR - RORO - 20GH - 40GH - 20FC - 20DR - 20FG - 20RH - 40FG - 40HF - 40HH - 40HL - 40HS - 40IN - 40RQ - 40TK - 42GP - 45DR - 45FR - 45GP - 45HD - 45HT - 45RH - 48HC - 53HC - 20PF - 20SL - 40HR - 42TR - LOLO - 20PW - 40PW - 40PH - 45PH - 40OH - 28TR #$ref: '#/components/schemas/shipmentContainerTypeEnum' docTypeEnum: type: string description: "C.H. Robinson codes for the different types of documents. \n\nFor a detailed description of all enumerated codes please find them here." enum: - ACCESSOR - AG - AGT_PRE - AS_CONFRM - AWBLABEL - BAD - BANKINGLC - BLINSTRUCT - BOL - BOOKADVICE - BOOKCONF - BOOKORDER - BROK_AN - CANADAA8A - CARARRNOT - CARBOOKNOT - CARGOREL - CARNOTIF - CARRPTHBL - CARRPTHBLR - CARSELFBIL - CBP28 - CBP29 - CBP301SEB - CBP3229 - CBP3299 - CBP3311 - CBP3461 - CBP349 - CBP3499 - CBP4811 - CBP5106 - CBP5297 - CBP7501 - CBP7512 - CBP7514 - CBP7551 - CBPADCVD - CBPCarnet - CBPCW - CBPMRK - CBPPEA - CBPPROTEST - CLAIM - CLN_CER - COA - COMDOCS - COMM_INV - CONFIRM - COO - COURTNOTE - CREDIT - CROSSTOWN - CUSFRTAV - CUST_AN - CUST_OTHER - CUST_PRE - CUSTDO - CUSTOMS - CUSTRATEAG - DAIRDALRT - DAIRPRDET - DAIRWAYBIL - DANGERCHK - DAWB - DE_ExportA - DE_ExportV - DE_Ocean - DE_OceanAB - DE_OceanAK - DE_OceanAT - DE_OceanGP - DE_OceanHZ - DE_OceanKN - DE_OceanKS - DE_OceanVN - DEDUCT - DELIVERY - DELORDER - DEMMURAGE - DESTCUST - DOCKRCPT - DRAFTHBL - DRAFTHBLR - EMLCOOR - EVENTNOTE - EXPHBL - EXPHBLR - EXPSHIPINV - FCONFIRM - FCR - FCRA - FF_BOL - FUMC - HAWB - HAZMAT - HAZMATDEC - IMPSHIPINV - INSDOCS - INSPC - INTL_10PLY - INTL_ACN - INTL_ARASL - INTL_BOL - INTL_BVA - INTL_CMR - INTL_POD - INTLOTHINV - INTLREL - INVOICE - ISFDOC - J1 - LINESREP - LUMPER - MANIFEST - MAWB - MBL - MBL_PROOF - MBL_RATE - MBL_UNRATE - MRN - MSDS - NA_INLAND - NONEHBL - NONEHBLR - NONNEGHBL - NONNEGHBLR - ODOMETER - OGA - ORGHBL - ORGHBLR - ORIGINCUST - OTHER - OVERDIM - PACK_LIST - PALLETS - PARCELLBL - PICKUP - PIXOS_EP - PO - POD - PROINV - PTT - PUORDER - RATEFILING - RCARD - RHC - SA_BACKUP - SACARINV - SEAWYHBL - SEAWYHBLR - SED - SELFBILL - SHIP - SHIPINST - SHIPINV - SQUOTE - SRNDRHBL - SRNDRHBLR - STATACCT - TELXHBL - TELXHBLR - TENDER - THERMO - TSACCSF - TSAKNOWN - TSAUNKNOWN - UNDET - WAYBILL - WHSE_OSD - WOODPACK - WT #$ref: '#/components/schemas/docTypePostEnum' #$ref: '#/components/schemas/gfBooking' gfBooking: { required: [ "customerCode", "customerReferenceNumber", "sellMode" ], type: "object", properties: { customerReferenceNumber: { minLength: 1, type: "string", description: "Indicates the customer's primary reference number." }, sellMode: { $ref: "#/components/schemas/BookingMode" }, customerCode: { maxLength: 50, minLength: 1, type: "string", description: "Indicates the customer's code." }, incoTerms: { $ref: "#/components/schemas/BookingIncoTerms" }, incoTermsNamedLocation: { minLength: 1, type: "string", nullable: true, description: "Indicates the Incoterms named location (e.g. Shanghai)." }, serviceLevel: { $ref: "#/components/schemas/BookingServiceLevel" }, freightTerms: { $ref: "#/components/schemas/BookingFreightTerm" }, shipperReadyByDateTime: { type: "string", nullable: true, description: "Indicates the date the shipper will have goods ready to ship in ISO8601 format.", format: "date-time" }, notes: { maxLength: 2000, minLength: 1, type: "string", nullable: true, description: "Indicates the booking level notes (maximum 2000 characters)." }, parties: { type: "array", nullable: true, items: { $ref: "#/components/schemas/BookingParty" }, description: "Indicates the parties on the order." }, locations: { maxItems: 4, minItems: 2, type: "array", nullable: true, items: { $ref: "#/components/schemas/BookingLocation" }, description: "Indicates the locations on the order (minimum 2, maximum 4)." }, containers: { minItems: 1, type: "array", nullable: true, items: { $ref: "#/components/schemas/BookingContainer" }, description: "Indicates the list of containers (minimum 1)." }, commodityItems: { type: "array", nullable: true, items: { $ref: "#/components/schemas/CommodityItem" }, description: "Indicates the item(s) on the order." }, referenceNumbers: { type: "array", nullable: true, items: { $ref: "#/components/schemas/ReferenceNumber" }, description: "Indicates additional reference number objects pertaining to the whole order." } }, additionalProperties: false, description: "Represents a GF Booking in C.H. Robinson's Navisphere®.", discriminator: { propertyName: "type" } } BookingAddress: { type: "object", properties: { address1: { maxLength: 200, minLength: 1, type: "string", nullable: true, description: "Indicates address line one of the location (maximum 200 characters)." }, address2: { maxLength: 200, minLength: 1, type: "string", nullable: true, description: "Indicates address line two of the location (maximum 200 characters)." }, address3: { maxLength: 200, minLength: 1, type: "string", nullable: true, description: "Indicates address line three of the location (maximum 200 characters)." }, address4: { maxLength: 200, minLength: 1, type: "string", nullable: true, description: "Indicates address line four of the location (maximum 200 characters)." }, city: { maxLength: 100, minLength: 1, type: "string", nullable: true, description: "Indicates the city of the location (maximum 100 characters)." }, county: { maxLength: 100, minLength: 1, type: "string", nullable: true, description: "Indicates the county of the location (maximum 100 characters)." }, lat: { maximum: 90, minimum: -90, type: "string", nullable: true, description: "Indicates the latitude of the location (minimum -90, maximum 90).", format: "float" }, long: { maximum: 180, minimum: -180, type: "string", nullable: true, description: "Indicates the longitude of the location (minimum -180, maximum 180).", format: "float" }, stateProvinceCode: { $ref: '#/components/schemas/stateProvinceCodeEnum' }, postalCode: { maxLength: 20, minLength: 1, type: "string", nullable: true, description: "Indicates the postal code of the location, sometimes referred to as the zip code (maximum 20 characters)." }, countryCode: { $ref: "#/components/schemas/countryCodeEnum" } }, additionalProperties: false, description: "Object that contains address specific information." } BookingMode: { enum: [ "Ocean", "Air" ], type: "string", description: "Indicates the requested mode of transportation." } CommodityItem: { required: [ "grossWeight", "grossWeightUnitOfMeasure", "packagingType", "quantity" ], type: "object", properties: { containerId: { type: "integer", nullable: true, description: "References the container to which this commodity group belongs.", format: "int32" }, packagingType: { $ref: "#/components/schemas/BookingPackageCode" }, quantity: { type: "number", description: "Indicates the total number of shipping units.", format: "float" }, pallets: { type: "number", nullable: true, description: "Indicates the number of pallets for the item.", format: "float" }, grossWeight: { type: "number", nullable: true, description: "Indicates the total weight of the line item. This represents the total weight of all quantities.", format: "float" }, grossWeightUnitOfMeasure: { $ref: "#/components/schemas/weightUomEnum" }, totalVolume: { type: "number", nullable: true, description: "Indicates the volume of the item.", format: "float" }, totalVolumeUnitOfMeasure: { $ref: "#/components/schemas/BookingVolumeUom" }, description: { minLength: 1, type: "string", nullable: true, description: "Indicates the general classification of the goods being shipped." }, descriptionOfGoods: { minLength: 1, type: "string", nullable: true, description: "Indicates the full description of the cargo contents." }, marksAndNumbers: { minLength: 1, type: "string", nullable: true, description: "Indicates the labeling or identifying marks printed on the cargo." }, skuNumber: { maxLength: 50, minLength: 1, type: "string", nullable: true, description: "Indicates the Stock Keeping Unit - a number assigned to a product by the customer (maximum 50 characters)." }, htCode: { type: "string", nullable: true, description: "Indicates the Harmonized Tariff Code for customs classification. This field can accept an HTS Code or an HS Code." }, isTemperatureSensitive: { type: "boolean", nullable: true, description: "Indicates a value indicating whether the item(s) need to be kept between specific temperatures." }, temperatureUnitOfMeasure: { $ref: '#/components/schemas/temperatureUomEnum' }, requiredTemperatureHigh: { type: "number", nullable: true, description: "Indicates the highest temperature the item(s) can be.", format: "float" }, requiredTemperatureLow: { type: "number", nullable: true, description: "Indicates the lowest temperature the item(s) can be.", format: "float" }, isHazardous: { type: "boolean", nullable: true, description: "Indicates a value indicating whether the item is hazardous." }, packagesDimensions: { type: "array", nullable: true, items: { $ref: "#/components/schemas/PackagesDimensions" }, description: "Indicates the packages dimensions." }, hazardousProperties: { $ref: "#/components/schemas/BookingHazardousProperties" }, referenceNumbers: { type: "array", nullable: true, items: { $ref: "#/components/schemas/ReferenceNumber" }, description: "Indicates additional reference number objects pertaining to this item." } }, additionalProperties: false, description: "Represents a commodity item in the shipment." } BookingContainer: { required: [ "quantity", type ], type: "object", properties: { "containerId": { type: "integer", nullable: true, description: "Indicates the identifier for a single container within the shipment and serves as the key used to group all related data elements.", format: "int32" }, type: { $ref: "#/components/schemas/BookingShipmentContainerType" }, quantity: { type: "integer", description: "Indicates the quantity, identifying how many containers need to be shipped.", format: "int32" }, containerNumber: { type: "string", nullable: true, description: "Indicates the industry identifying number assigned to the container. Format is SCAC######-CheckDigit." }, referenceNumbers: { type: "array", nullable: true, items: { $ref: "#/components/schemas/ReferenceNumber" }, description: "Indicates additional reference number objects pertaining to the container." } }, additionalProperties: false, description: "Container data." } BookingFreightTerm: { enum: [ "CL", "PP" ], type: "string", description: "Code to indicate the freight term type." } BookingHazardousProperties: { type: "object", properties: { "properName": { maxLength: 500, minLength: 1, type: "string", nullable: true, description: "Indicates the Proper Shipping Name (PSN) - the often broad name mandated for documentation and packaging." }, technicalName: { maxLength: 50, minLength: 1, type: "string", nullable: true, description: "Indicates the technical name - required for n.o.s. (Not Otherwise Specified) or generic entries. Also known as Chemical Name." }, subsidiaryHazmatClasses: { maxLength: 15, minLength: 1, type: "string", nullable: true, description: "Indicates the subsidiary hazmat classes (maximum 15 characters)." }, unNumber: { maxLength: 10, minLength: 1, type: "string", nullable: true, description: "Four-digit numbers prepended with 'UN' that identify dangerous goods, hazardous substances and articles\n(such as explosives, flammable liquids, toxic substances, etc.) in the framework of international transport." }, classCode: { maxLength: 10, minLength: 1, type: "string", nullable: true, description: "Indicates the code for hazardous material in the framework of international transport." }, packingGroup: { $ref: "#/components/schemas/hazardousGroupEnum" }, packingDetails: { maxLength: 15, minLength: 1, type: "string", nullable: true, description: "Indicates details about packing (maximum 15 characters)." }, emergencyPhone: { maxLength: 50, minLength: 1, type: "string", nullable: true, description: "Indicates the emergency phone number (maximum 50 characters)." }, isLimitedQuantities: { type: "boolean", nullable: true, description: "Indicates a value indicating whether the hazardous goods shipment is transported under the Limited Quantities (LQ) provisions." }, flashpoint: { type: "number", nullable: true, description: "Indicates the hazmat flash point.", format: "float" }, flashpointTemperatureUnit: { $ref: '#/components/schemas/temperatureUomEnum' }, marinePollutantCategory: { $ref: "#/components/schemas/marinePollutantCategory" } }, additionalProperties: false, description: "Object containing hazardous material information." } BookingIncoTerms: { enum: [ "DAT", "DAP", "CIF", "CPT", "CIP", "DDP", "EXW", "FCA", "DPU", "FAS", "FOB", "CFR", "DAF", "DDU", "DEQ", "DES" ], type: "string", description: "The Incoterms or International Commercial Terms." } InternalBooking: { type: "object", allOf: [ { $ref: "#/components/schemas/gfBooking" } ], additionalProperties: false, description: "Represents an internal booking that extends the base Booking class with additional internal-specific properties." } BookingLocation: { required: [ "type" ], type: "object", properties: { customerLocationId: { maxLength: 50, minLength: 1, type: "string", nullable: true, description: "Indicates the customer defined identifier associated to a specific location.\nIf C.H. Robinson maintains a list of the customer's location IDs, then customerLocationId can be provided in lieu of address information." }, type: { $ref: "#/components/schemas/BookingLocationType" }, name: { maxLength: 100, minLength: 1, type: "string", nullable: true, description: "Indicates the name of the location (maximum 100 characters).\nIf the address of the location is not in C.H. Robinson's system, it is mandatory to include the name parameter so C.H. Robinson can auto-create the location in our system on order create." }, openDateTime: { type: "string", nullable: true, description: "Indicates the Customer-preferred earliest date and time for location activity. ISO8601 format.", format: "date-time" }, closeDateTime: { type: "string", nullable: true, description: "Indicates the Customer-preferred latest date and time for location activity. ISO8601 format.", format: "date-time" }, address: { $ref: "#/components/schemas/BookingAddress" }, referenceNumbers: { type: "array", nullable: true, items: { $ref: "#/components/schemas/ReferenceNumber" }, description: "Indicates additional reference number objects pertaining to this location." } }, additionalProperties: false, description: "List of locations where freight is being transferred for this Booking." } BookingLocationType: { enum: [ "Pickup", "OriginPort", "DestinationPort", "Delivery" ], type: "string", description: "Location type enumeration." } BookingPackageCode: { enum: [ "BAG", "BAL", "BDL", "BIN", "BLK", "BOT", "BOX", "BXT", "CAR", "CAS", "CRT", "DRM", "DZ", "EAC", "GOH", "GYL", "HDW", "IBC", "JAR", "KG", "LBS", "LNFT", "LSE", "LUG", "M", "OTHR", "PAL", "PCS", "PKG", "PLT", "PR", "RCK", "REL", "ROL", "SAK", "SET", "SHT", "SKD", "SKE", "SLP", "TH", "TOT", "TRY", "YD", "AST", "ENV", "IMDLTRL", "JRYCN", "M2", "TUBE" ], type: "string", description: "C.H. Robinson defined code for packaging type/code." } PackagesDimensions: { required: [ "packagingType" ], type: "object", properties: { packagingType: { $ref: "#/components/schemas/BookingPackageCode" }, quantity: { type: "integer", nullable: true, description: "Indicates the quantity, identifying how many containers need to be shipped.", format: "int32" }, length: { type: "number", nullable: true, description: "Indicates the length of the line item packaging.", format: "float" }, width: { type: "number", nullable: true, description: "Indicates the width of the line item packaging.", format: "float" }, height: { type: "number", nullable: true, description: "Indicates the height of the line item packaging.", format: "float" }, linearUnitOfMeasure: { $ref: "#/components/schemas/linearUomEnum" }, volume: { type: "number", nullable: true, description: "Indicates the volume of the line item packaging.", format: "float" }, volumeOfMeasure: { $ref: "#/components/schemas/BookingVolumeUom" }, stackable: { $ref: "#/components/schemas/Stackable" } }, additionalProperties: false, description: "Details for packaging contained within each commodity item handling unit." } BookingParty: { required: [ type ], type: "object", properties: { customerPartyId: { maxLength: 50, minLength: 1, type: "string", nullable: true, description: "Indicates the customer defined identifier associated to a specific Party.\nIf C.H. Robinson maintains a list of the customer's party IDs, then customerPartyId can be provided to identify the party on the shipment." }, customerCode: { maxLength: 20, minLength: 1, type: "string", nullable: true, description: "Indicates the CHR Internal Customer Code." }, type: { $ref: "#/components/schemas/PartyType" }, name: { maxLength: 100, minLength: 1, type: "string", nullable: true, description: "Indicates the name of the party (maximum 100 characters)." }, address: { $ref: "#/components/schemas/BookingAddress" } }, additionalProperties: false, description: "Represents a party involved in the shipment." } PartyType: { enum: [ "Consignee", "BillTo", "Shipper", "NotifyParty" ], type: "string", description: "Party type enumeration." } ReferenceNumber: { required: [ type, "value" ], type: "object", properties: { type: { $ref: "#/components/schemas/BookingReferenceNumberType" }, value: { maxLength: 100, minLength: 1, type: "string", description: "Indicates the actual value of the reference number (maximum 100 characters)." } }, additionalProperties: false, description: "Represents a reference number with type and value." } BookingReferenceNumberType: { enum: [ "SHID", "MBOL", "PO", "BOL", "CFRM", "CRID", "CUSTPO", "DEL", "DIST", "FIN", "GL", "JNO", "PU", "RANumber", "RLPRO", "MREF", "Empty", "PRO", "CCN", "SBOL", "CON", "APPT", "CHRW_ID", "FDA", "IREF", "LIC", "ORD", "PLU", "SCAC", "SEAL", "SKU", "SREF", "STCC", "TEB", "VPO", "WB", "XXXX", "TRIA", "TRANS", "GCC", "SDATE", "CDATE", "ACCT", "CCTR", "IGM", "GIGM", "LIGM", "SMTP", "PERMIT", "RNO", "DVCN", "PRCL", "CPUC", "SHPMD", "AFR", "BUYID", "VNDID", "DIV", "DEPT", "POTYPE", "GRGI", "DUNS", "PALLETREF", "CITTN", "CIN", "SHIPWITH", "PN", "UPC", "PRCD", "VESSEL", "VOYAGE", "FN", "FEEDVESS", "FEEDVOY", "SHIPREF", "CBL", "SPAC", "POLN", "VPOLN", "EIN", "CNSG", "PROFITCTR", "MFGPART", "PACKSLIP", "THIRDPRTY", "DEFATTR", "FSTRK", "FOItemID", "POLineNum", "PARCELSPC", "CNS1", "CNS2", "CNS3", "CNS4", "CNS5", "CNS6", "CNS7", "TREF", "VREF", "UPRICE", "FWPARTY", "BYPARTY", "HBL", "CBP", "TRANSFER", "SO", "ORDTRK", "QUOTEID", "EQT", "BOOTH", "TS", "OH", "CNTNR", "VAS", "Size", "Color", "Style", "HCERT", "B", "ETMSID", "214-IMO", "SHPWeight", "SHPVolume", "SHPDims", "SERIALIZED", "SERIALNUM", "CPSIA", "EDIINVREF", "SQID", "QSeqNum", "OuterPkStu", "GLC", "COMP", "COST", "DTYGL", "DTYCC", "BRKGL", "BRKCC", "GPS", "IAC", "WHRCT", "ERGUID", "SONUM", "CCNUM", "PrimCCNUM", "PrevCCNUM", "CMRN", "TRANSSHIP", "PGIDATE", "AESFIL", "CUSTQUOTID", "QUOTETRACE", "ODATE", "FRCLS", "NMFC", "EXTQUOTEID", "KSMS", "LVSCONSOLID", "REN", "NCCID", "OH #", "B#", "OJobNum", "Plant", "TRNSPRTID", "VCTe" ], type: "string", description: "C.H. Robinson defined code for reference number types." } BookingServiceLevel: { enum: [ "DD", "PP", "DP", "PD" ], type: "string", description: "Specifies movement type of the shipment." } BookingShipmentContainerType: { enum: [ "20DR", "20FC", "20FG", "20FR", "20FT", "20GH", "20HC", "20HD", "20IT", "20OT", "20PF", "20RF", "20RH", "20SL", "40DR", "40FG", "40FR", "40FT", "40GH", "40HC", "40HF", "40HH", "40HL", "40HR", "40HS", "40IN", "40OT", "40RF", "40RH", "40RQ", "40TK", "45DR", "45FR", "45GP", "45HC", "45HD", "45HT", "45RF", "45RH", "45TR", "48HC", "48TR", "53HC", "53TR", "BBLK", "LCL", "RORO" ], type: "string", description: "Type of shipping container." } Stackable: { enum: [ "Yes", "No", "_1x", "_2x", "_3x", "TopLoadable" ], type: "string", description: "Indicates whether packages are stackable." } BookingVolumeUom: { enum: [ "CubicInches", "CubicFeet", "CubicMeters", "CubicCentimeters" ], type: "string", description: "Unit of measure for volume parameters." }