openapi: 3.2.0 info: version: 2.0.0 title: A guide to C.H. Robinson's REST Orders and Booking API description: '# Introduction Welcome to C.H.' servers: - url: https://sandbox-api.navisphere.com description: Test environment. - url: https://api.navisphere.com description: Production environment. security: - sandbox: [] tags: - 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. paths: /v1/orders: post: description: Allows partner to create an order in C.H. Robinson's Navisphere® Order Management system. operationId: OrderCreate 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\nvar 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\nrequest(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\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. summary: Order create x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: Order Create put: description: Allows partner to update an existing order in C.H. Robinson's Navisphere® Order Management system. operationId: OrderUpdate 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\nvar 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\nrequest(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\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. summary: Order update x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: Order Update /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 for more information on retrieving quotes. The 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: OrderCreateWithQuoteID 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\nrequest(options, function (error, response, body) {\n \tif (error) throw new Error(error);\n\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. summary: Order create with quote ID x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: Order Create with Quote ID /v1/orders/{orderNumber}: delete: description: Allows partner to delete an existing order in C.H. Robinson's Navisphere® Order Management system. operationId: OrderDelete 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\nrequest(options, function (error, response, body) { \n \tif (error) throw new Error(error); \n \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: null 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. summary: Order delete x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: Order Delete /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: BookingCreate 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: null 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. summary: Booking create x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: Booking Create put: description: Allows partner to send a Global Forwarding Booking request to CH Robinson's Navisphere system x-beta: true operationId: BookingUpdate 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: null 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. summary: Booking update x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: Booking Update /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: BookingDelete 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: null 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. summary: Booking delete x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: Booking Delete components: schemas: CommodityItem: required: - grossWeight - grossWeightUnitOfMeasure - packagingType - quantity type: object properties: containerId: type: - integer - 'null' 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 - 'null' description: Indicates the number of pallets for the item. format: float grossWeight: type: - number - 'null' 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 - 'null' description: Indicates the volume of the item. format: float totalVolumeUnitOfMeasure: $ref: '#/components/schemas/BookingVolumeUom' description: minLength: 1 type: - string - 'null' description: Indicates the general classification of the goods being shipped. descriptionOfGoods: minLength: 1 type: - string - 'null' description: Indicates the full description of the cargo contents. marksAndNumbers: minLength: 1 type: - string - 'null' description: Indicates the labeling or identifying marks printed on the cargo. skuNumber: maxLength: 50 minLength: 1 type: - string - 'null' description: Indicates the Stock Keeping Unit - a number assigned to a product by the customer (maximum 50 characters). htCode: type: - string - 'null' description: Indicates the Harmonized Tariff Code for customs classification. This field can accept an HTS Code or an HS Code. isTemperatureSensitive: type: - boolean - 'null' description: Indicates a value indicating whether the item(s) need to be kept between specific temperatures. temperatureUnitOfMeasure: $ref: '#/components/schemas/temperatureUomEnum' requiredTemperatureHigh: type: - number - 'null' description: Indicates the highest temperature the item(s) can be. format: float requiredTemperatureLow: type: - number - 'null' description: Indicates the lowest temperature the item(s) can be. format: float isHazardous: type: - boolean - 'null' description: Indicates a value indicating whether the item is hazardous. packagesDimensions: type: - array - 'null' items: $ref: '#/components/schemas/PackagesDimensions' description: Indicates the packages dimensions. hazardousProperties: $ref: '#/components/schemas/BookingHazardousProperties' referenceNumbers: type: - array - 'null' 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. 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. BookingFreightTerm: enum: - CL - PP type: string description: Code to indicate the freight term type. 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\n C.H. Robinson can auto-create the location in our system on order create.\n" 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) bookingNumber: type: string description: The booking number for FedEx heavy air shipments. volumeUomEnum: type: string description: Unit of measure for volume parameters. enum: - CubicFeet - CubicMeters 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." 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 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.\n * `I` - Group I - Major Danger\n * `II` - Group II - Medium Danger\n * `III` - Group III - Minor Danger\n" enum: - I - II - III 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. sellModeEnum: type: string description: "Defines the mode:\n * `LTL` - Less than Truckload Transportation\n * `TL` - Truckload Transportation\n * `DomesticAir` - Domestic Air Transportation\n * `Ocean` - Ocean Transportation\n * `IMDL` - Intermodal Full Container Transportation\n * `Bulk` - Bulk Transportation\n * `Consolidated` - Consolidated Transportation\n * `LTLFlatbed` - Less than Truckload Flatbed Transportation\n * `TLFlatbed` - Truckload Flatbed Transportation\n * `SmallParcel` - Small Parcel Transportation\n * `Tautliner` - Tatliner Transportation\n" enum: - LTL - TL - LTLFlatbed - TLFlatbed - IMDL - Bulk - Consolidated - DomesticAir - SmallParcel, - Ocean - Tautliner 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' PartyType: enum: - Consignee - BillTo - Shipper - NotifyParty type: string description: Party type enumeration. marinePollutantCategory: type: string description: "Indicates the Marine Pollutant Category for Hazardous Materials.\n * `Severe Marine Pollutant`\n * `Marine Pollutant`\n" enum: - SevereMarinePollutant - MarinePollutant 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. 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." 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. 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' 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. 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. 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' 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. 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. PackagesDimensions: required: - packagingType type: object properties: packagingType: $ref: '#/components/schemas/BookingPackageCode' quantity: type: - integer - 'null' description: Indicates the quantity, identifying how many containers need to be shipped. format: int32 length: type: - number - 'null' description: Indicates the length of the line item packaging. format: float width: type: - number - 'null' description: Indicates the width of the line item packaging. format: float height: type: - number - 'null' description: Indicates the height of the line item packaging. format: float linearUnitOfMeasure: $ref: '#/components/schemas/linearUomEnum' volume: type: - number - 'null' 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. serviceLevelEnum: type: string description: 'C.H. Robinson defined code for a service offering. For a detailed description of all enumerated codes please find them here.' 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 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. 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' 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' itemEquipmentTypeEnum: type: string description: 'Indicates the equipment type needed to move the item. For 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 order: type: object required: - customers - billTos - services properties: orderNumber: type: integer description: "C.H. Robinson order number received on successful order create.\n ### 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. Stackable: enum: - 'Yes' - 'No' - _1x - _2x - _3x - TopLoadable type: string description: Indicates whether packages are stackable. contactTypeEnum: type: string description: "Indicates the type of contact specified:\n * `Vendor` - Vendor party (Non Transportation Supplier)\n * `Buyer` - Buyer Party\n * `Contact` - Contact Party\n * `OrderedBy` - Ordered By Party on the Order or Load\n * `NotifyParty` - Notify Party\n * `OnlineContact` - CHRWOnline Contact\n * `SchedWith` - Scheduled With\n * `POCustomer` - Customer on the Purchase Order\n" enum: - Vendor - Buyer - Contact - OrderedBy - NotifyParty - OnlineContact - SchedWith - POCustomer BookingAddress: type: object properties: address1: maxLength: 200 minLength: 1 type: - string - 'null' description: Indicates address line one of the location (maximum 200 characters). address2: maxLength: 200 minLength: 1 type: - string - 'null' description: Indicates address line two of the location (maximum 200 characters). address3: maxLength: 200 minLength: 1 type: - string - 'null' description: Indicates address line three of the location (maximum 200 characters). address4: maxLength: 200 minLength: 1 type: - string - 'null' description: Indicates address line four of the location (maximum 200 characters). city: maxLength: 100 minLength: 1 type: - string - 'null' description: Indicates the city of the location (maximum 100 characters). county: maxLength: 100 minLength: 1 type: - string - 'null' description: Indicates the county of the location (maximum 100 characters). lat: maximum: 90 minimum: -90 type: - string - 'null' description: Indicates the latitude of the location (minimum -90, maximum 90). format: float long: maximum: 180 minimum: -180 type: - string - 'null' 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 - 'null' 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. 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. hazmatCodeEnum: type: string description: "Defines the authorizing entity:\n * `C` - HazMat Canadian Regulatory Authority Codes\n * `D` - HazMat US Regulatory Authority Codes\n * `I` - HazMat MX/International Regulatory Authority Codes\n" enum: - C - D - I 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' tarpTypeEnum: type: string description: "Details the type of tarp required for flat bed trailer.\n * `10` - Ten Feet\n * `2` - Two Feet\n * `4` - Four Feet\n * `6` - Six Feet\n * `8` - Eight Feet\n * `MESH` - Nursery/Mesh\n * `NO TARP` - No Tarp Required\n * `SMOKE` - Smoke Tarp\n * `TOP` - Top\n" enum: - '10' - '2' - '4' - '6' - '8' - MESH - NO TARP - SMOKE - TOP 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. 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." 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 payerTypeEnum: type: string description: Indicates which party involved in the shipment is responsible for payment. enum: - Sender - Recipient - Third_Party 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." 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 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 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 BookingMode: enum: - Ocean - Air type: string description: Indicates the requested mode of transportation. movementTypeEnum: type: string description: "Specifies movement type of the shipment:\n * `OD` - \"Origin Dray\"\n * `DD` - \"Destination Dray\"\n * `OPDP` - \"Origin Port to Destination Port\"\n * `OPDD` - \"Origin Port to Destination Door\"\n * `ODDP` - \"Origin Door to Destination Port\"\n * `ODDD` - \"Origin Door to Destination Door\"\n * `ORDP` - \"Origin Ramp to Destination Port\"\n * `OPDR` - \"Origin Port to Destination Ramp\"\n * `ORDD` - \"Origin Ramp to Destination Door \"\n * `ODDR` - \"Origin Door to Destination Ramp\"\n * `ORDR` - \"Origin Ramp to Destination Ramp\"\n * `OADA` - \"Origin Airport to Destination Airport\"\n * `OADD` - \"Origin Airport to Destination Door\"\n * `ODDA` - \"Origin Door to Destination Airport\"\n * `ODOC` - \"Origin Door to Origin CFS\"\n * `ODDC` - \"Origin Door to Destination CFS\"\n * `OCDC` - \"Origin CFS to Destination CFS\"\n * `OCDD` - \"Origin CFS to Destination Door\"\n * `DCDD` - \"Destination CFS to Destination Door\"\n * `OCDP` - \"Origin CFS to Destination Port\"\n * `OPDC` - \"Origin Port to Destination CFS\"\n" enum: - OD - DD - OPDP - OPDD - ODDP - ODDD - ORDP - OPDR - ORDD - ODDR - ORDR - OADA - OADD - ODDA - ODOC - ODDC - OCDC - OCDD - DCDD - OCDP - OPDC 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 contactMethodEnum: type: string description: 'Indicates the best method for reaching the specified contact. ' enum: - Email - Phone - Fax 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.\n * `DAT` - Delivered at Terminal\n * `DAP` - Delivered at Place\n * `CIF` - Cost Insurance & Freight\n * `CPT` - Carriage Paid To\n * `CIP` - Carriage & Insurance Paid To\n * `DDP` - Delivered duty paid\n * `EXW` - EX works\n * `FCA` - Free carrier at\n * `DPU` - Delivered at place unloaded\n * `FAS` - Free alongside ship\n * `FOB` - Free on Board\n * `CFR` - Cost and Freight\n * `PPD` - Prepaid\n * `COL` - Collect\n * `DAF` - Delivery at Frontier\n * `DDU` - Delivery Duty Unpaid\n * `DEQ` - Delivery Ex-Quay, Duty Unpaid\n * `DES` - Delivery Ex-Ship\n" enum: - DAT - DAP - CIF - CPT - CIP - DDP - EXW - FCA - DPU - FAS - FOB - CFR - PPD - COL - DAF - DDU - DEQ - DES countryCodeEnum: type: string description: "Indicate the country of the location. \n\nFor a detailed description of all enumerated codes please find them here." 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 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. 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' 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. 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 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 - 'null' description: Indicates the Incoterms named location (e.g. Shanghai). serviceLevel: $ref: '#/components/schemas/BookingServiceLevel' freightTerms: $ref: '#/components/schemas/BookingFreightTerm' shipperReadyByDateTime: type: - string - 'null' 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 - 'null' description: Indicates the booking level notes (maximum 2000 characters). parties: type: - array - 'null' items: $ref: '#/components/schemas/BookingParty' description: Indicates the parties on the order. locations: maxItems: 4 minItems: 2 type: - array - 'null' items: $ref: '#/components/schemas/BookingLocation' description: Indicates the locations on the order (minimum 2, maximum 4). containers: minItems: 1 type: - array - 'null' items: $ref: '#/components/schemas/BookingContainer' description: Indicates the list of containers (minimum 1). commodityItems: type: - array - 'null' items: $ref: '#/components/schemas/CommodityItem' description: Indicates the item(s) on the order. referenceNumbers: type: - array - 'null' 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 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." 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 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' BookingLocationType: enum: - Pickup - OriginPort - DestinationPort - Delivery type: string description: Location type enumeration. BookingLocation: required: - type type: object properties: customerLocationId: maxLength: 50 minLength: 1 type: - string - 'null' description: 'Indicates the 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.' type: $ref: '#/components/schemas/BookingLocationType' name: maxLength: 100 minLength: 1 type: - string - 'null' description: 'Indicates the name of the location (maximum 100 characters). 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.' openDateTime: type: - string - 'null' description: Indicates the Customer-preferred earliest date and time for location activity. ISO8601 format. format: date-time closeDateTime: type: - string - 'null' 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 - 'null' 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. 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. 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" enum: - CL - PP - TP - PC - CC 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 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. additionalLocationTypeEnum: type: string description: "The additional locations types on the order.\n * `BailmentWarehouse` - Bailment Warehouse\n * `BillToParty` - Bill To Party\n * `Consignee` - Consignee\n * `DeliveryAddress` - Delivery Address\n * `Depositor` - Depositor\n * `Exporter` - Exporter\n * `NotifyParty1` - Notify Party 1\n * `NotifyParty2` - Notify Party 2\n * `PickupAddress` - Pickup Address\n * `Plant` - Plant\n * `SellingParty` - Selling Party\n * `ShipFrom` - Ship From\n * `ShipTo` - Ship To\n * `Shipper` - Shipper\n * `SoldToandShipTo` - Sold To and Ship To\n * `SoldTo` - Sold To if different from Bill To\n * `Supplier` - Supplier\n * `ThirdPartyAdministrator` - Third Party Administrator\n * `UltimateConsignee` - Ultimate Consignee\n * `Vendor` - Vendor\n * `Warehouse` - Warehouse\n" 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 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' temperatureUomEnum: type: string description: Unit of measure for temperature parameters. enum: - Fahrenheit - Celsius - Empty 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. quotes: type: array minimum: 1 items: $ref: '#/components/schemas/quote' orderResponse: type: object description: Object containg the order response. properties: orderNumber: type: string description: C.H. Robinson order number that was created. example: '81134516' 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." 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 vesselStowageCategoryEnum: type: string description: "Indicates the HazMat Stowage category code according stowage requirements listed in the IMDG Code Dangerous Goods List.\n * `A` - Stowage category code A\n * `B` - Stowage category code B\n * `C` - Stowage category code C\n * `D` - Stowage category code D\n * `E` - Stowage category code E\n * `01` - Stowage category code 1\n * `02` - Stowage category code 2\n * `03` - Stowage category code 3\n * `04` - Stowage category code 4\n * `05` - Stowage category code 5\n" enum: - A - B - C - D - E - '01' - '02' - '03' - '04' - '05' exportReasonCode: type: string description: A value required for DHL international shipments indicating why the shipment is being exported. enum: - Permanent - Temporary - Re_Export BookingHazardousProperties: type: object properties: properName: maxLength: 500 minLength: 1 type: - string - 'null' description: Indicates the Proper Shipping Name (PSN) - the often broad name mandated for documentation and packaging. technicalName: maxLength: 50 minLength: 1 type: - string - 'null' 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 - 'null' description: Indicates the subsidiary hazmat classes (maximum 15 characters). unNumber: maxLength: 10 minLength: 1 type: - string - 'null' description: 'Four-digit numbers prepended with ''UN'' that identify dangerous goods, hazardous substances and articles (such as explosives, flammable liquids, toxic substances, etc.) in the framework of international transport.' classCode: maxLength: 10 minLength: 1 type: - string - 'null' 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 - 'null' description: Indicates details about packing (maximum 15 characters). emergencyPhone: maxLength: 50 minLength: 1 type: - string - 'null' description: Indicates the emergency phone number (maximum 50 characters). isLimitedQuantities: type: - boolean - 'null' description: Indicates a value indicating whether the hazardous goods shipment is transported under the Limited Quantities (LQ) provisions. flashpoint: type: - number - 'null' 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. BookingParty: required: - type type: object properties: customerPartyId: maxLength: 50 minLength: 1 type: - string - 'null' description: 'Indicates the customer defined identifier associated to a specific Party. If 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 - 'null' description: Indicates the CHR Internal Customer Code. type: $ref: '#/components/schemas/PartyType' name: maxLength: 100 minLength: 1 type: - string - 'null' 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. BookingVolumeUom: enum: - CubicInches - CubicFeet - CubicMeters - CubicCentimeters type: string description: Unit of measure for volume parameters. 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' shippingContainerItems: type: object required: - containerId - itemId properties: containerId: type: integer description: ID of the container. itemId: type: integer description: Indicates the item ID. 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' 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** 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 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. weightUomEnum: type: string description: Unit of measure for weight parameters. enum: - Pounds - Kilograms 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. 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 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' loadingTypeEnum: type: string description: "Describes how trailer will need to be loaded.\n * `CRANE` - Top/crane\n * `REAR` - Rear\n * `SIDE` - Side\n * `REAR/SIDE` - Rear/side\n * `TOP/SIDE` - Top/side\n * `DOCK` - Dock\n * `STRING` - String\n * `STRING/TOW` - String/tow\n" enum: - CRANE - REAR - SIDE - REAR/SIDE - TOP/SIDE - DOCK - STRING - STRING/TOW 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 BookingServiceLevel: enum: - DD - PP - DP - PD type: string description: Specifies movement type of the shipment. temperatureSensitiveEnum: type: string description: "Indicates if temperature control is needed, and what level:\n * `Dry` - Dry\n * `Fresh` - Fresh (25 to 32 degrees)\n * `Frozen` - Frozen (-10 to 0 degrees)\n * `Chilled` - Chilled (40 to 60 degrees)\n * `DeepFrozen` - Deep Frozen (-20 to -20 degrees)\n * `Refrigerated` - Refrigerated (33 to 39 degrees)\n * `Protect` - Protect (33 to 60 degrees)\n * `Custom` - Custom\n * `Produce` - Produce\n * `Mixed` - Mixed\n * `Empty` - Empty\n" enum: - Dry - Fresh - Frozen - Chilled - DeepFrozen - Refrigerated - Protect - Produce - Mixed - Empty BookingContainer: required: - quantity - type type: object properties: containerId: type: - integer - 'null' 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 - 'null' description: Indicates the industry identifying number assigned to the container. Format is SCAC######-CheckDigit. referenceNumbers: type: - array - 'null' items: $ref: '#/components/schemas/ReferenceNumber' description: Indicates additional reference number objects pertaining to the container. additionalProperties: false description: Container data. linearUomEnum: type: string description: Unit of measure for height, width, and length parameters. enum: - Inches - Feet - Centimeters - Meters securitySchemes: sandbox: type: http scheme: bearer bearerFormat: jwt bearerAuth: type: http scheme: bearer bearerFormat: jwt