{ "openapi": "3.0.4", "info": { "title": "TMS API", "version": "v1" }, "paths": { "/api/v1/IntegrationApi/BookBestwayCarrier": { "post": { "tags": [ "Rating and booking" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BookLoadCostRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookLoadCostRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookLoadCostRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BookLoadCostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookLoadCostResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookLoadCostResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookLoadCostResponse" } } } } }, "operationId": "BookBestwayCarrier", "summary": "Book the best-value carrier" } }, "/api/v1/IntegrationApi/UpdateAndReRateLoad": { "post": { "tags": [ "Rating and booking" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateReRateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReRateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateReRateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateReRateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QuoteEngineResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuoteEngineResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuoteEngineResponse" } } } } }, "operationId": "UpdateAndReRateLoad", "summary": "Update and re-rate a load" } }, "/api/v1/IntegrationApi/CreateRateOrBookLoad": { "post": { "tags": [ "Rating and booking" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BookLoadRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookLoadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookLoadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BookLoadRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QuoteEngineResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuoteEngineResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuoteEngineResponse" } } } } }, "operationId": "CreateRateOrBookLoad", "summary": "Create, rate or book a load" } }, "/api/v1/IntegrationApi/CreateLoad": { "post": { "tags": [ "Loads and quotes" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateLoadRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateLoadRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLoadRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLoadRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateLoadResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateLoadResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLoadResponseDto" } } } } }, "operationId": "CreateLoad", "summary": "Create a load" } }, "/api/v1/IntegrationApi/UpdateLoad": { "post": { "tags": [ "Loads and quotes" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateLoadRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLoadRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLoadRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLoadRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateLoadResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateLoadResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLoadResponseDto" } } } } }, "operationId": "UpdateLoad", "summary": "Update a load" } }, "/api/v1/IntegrationApi/GetLoadInfo": { "post": { "tags": [ "Loads and quotes" ], "summary": "Get load information", "description": "GetLoadInfo - Returns shipment information for the accounts tied to the supplied API key. Provide at least one of LoadsId, LoadsReference (e.g. PRO Number, PO Number, Billing Id), or StatusLoads.\r\n \r\n\r\nResult limit and historical data: Each search returns at most 200 loads. Matching loads are ordered by Ship Date, most recent first, so when more than 200 loads match, the oldest records are trimmed from the results. To retrieve older shipments, narrow the search (for example, by specific Load Ids or reference values) rather than relying on a broad status search.\r\n \r\n\r\nStatus searches: Searching by the Delivered or Canceled status only considers loads delivered within the last 14 days (by delivered date); other statuses are not restricted by date but are still capped at 200 most-recent results.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LoadRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LoadRequest" } } } }, "responses": { "200": { "description": "Request Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoadInformationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoadInformationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoadInformationResponse" } } } }, "400": { "description": "The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing)" }, "500": { "description": "Server error" } }, "operationId": "GetLoadInfo" } }, "/api/v1/IntegrationApi/GetQuote": { "post": { "tags": [ "Loads and quotes" ], "summary": "Get a quote", "description": "GetQuote - This call will return quotes based on today's rates per the load information and account credentials provided.\r\n \r\n \r\n This is used in cases of estimates for customer service, sales, or in store front applications. \r\n \r\n \r\n These quotes are not saved in our system but are for informational purposes only.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/QuoteEngineRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuoteEngineRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuoteEngineRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/QuoteEngineRequest" } } } }, "responses": { "200": { "description": "Request Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/QuoteEngineResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuoteEngineResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuoteEngineResponse" } } } }, "400": { "description": "The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing)" }, "500": { "description": "Server error" } }, "operationId": "GetQuote" } } }, "components": { "schemas": { "AccesorialDockType": { "enum": [ "BusinessWithDock", "BusinessWithOutDock", "Residence", "OtherLimitedAccess", "Construction", "Church", "Military", "StorageFacility", "School", "Farm", "Mine", "Prison", "Government", "Nuclear", "Hotel", "GroceryWarehouse" ], "type": "string", "description": "280 = BusinessWithDock, 281 = BusinessWithOutDock, 282 = Residence, 283 = OtherLimitedAccess, 284 = Construction, 285 = Church, 286 = Military, 287 = StorageFacility, 288 = School, 289 = Farm, 290 = Mine, 291 = Prison, 292 = Government, 293 = Nuclear, 294 = Hotel, 295 = GroceryWarehouse" }, "Accessorials": { "type": "object", "properties": { "doNotFreeze": { "type": "boolean" }, "overLength": { "type": "boolean" }, "sortAndSegregate": { "type": "boolean" }, "blindShipment": { "type": "boolean" }, "whiteGloveDelivery": { "type": "boolean" }, "expedite": { "type": "boolean" }, "insuranceRequired": { "type": "boolean" }, "falveyInsValue": { "type": "number", "format": "double" }, "volumeLoad": { "type": "boolean" }, "guaranteed": { "type": "boolean" }, "mabd": { "type": "boolean" }, "destinationNotification": { "type": "boolean" }, "originInsidePickup": { "type": "boolean" }, "originLiftGate": { "type": "boolean" }, "destinationInsideDelivery": { "type": "boolean" }, "destinationLiftGate": { "type": "boolean" }, "inBond": { "type": "boolean" } }, "additionalProperties": false }, "AccessoryListReRate": { "type": "object", "properties": { "blindShipment": { "type": "boolean" }, "doNotFreeze": { "type": "boolean" }, "guaranteed": { "type": "boolean" }, "notification": { "type": "boolean" }, "overLength": { "type": "boolean" }, "sortAndSegregate": { "type": "boolean" }, "volumeLoad": { "type": "boolean" }, "whiteGloveDelivery": { "type": "boolean" }, "expedite": { "type": "boolean" }, "originInsidePickup": { "type": "boolean" }, "destinationInsideDelivery": { "type": "boolean" }, "originLiftGate": { "type": "boolean" }, "destinationLiftGate": { "type": "boolean" }, "inBond": { "type": "boolean" } }, "additionalProperties": false }, "AttachmentDto": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "fileContent": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BillingLocation": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "stateProvince": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "description": "Possible values: USA, CAN, OTHER, MEX", "nullable": true } }, "additionalProperties": false }, "BillingLocationDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "stateProvince": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "description": "Possible values: USA, CAN, OTHER, MEX", "nullable": true } }, "additionalProperties": false }, "BillingReRateInformation": { "type": "object", "properties": { "terms": { "type": "string", "description": "Possible values: Prepaid, Collect, ThirdParty, PrepaidAdd", "nullable": true }, "role": { "type": "string", "description": "Possible values: Shipper, Consignee, ThirdParty", "nullable": true }, "billingID": { "type": "string", "nullable": true }, "poNumber": { "type": "string", "nullable": true }, "proNumber": { "type": "string", "nullable": true }, "customID": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "street1": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "country": { "type": "string", "description": "Possible values: USA, CAN, OTHER, MEX", "nullable": true } }, "additionalProperties": false }, "BookLoadASNTemplate": { "type": "object", "properties": { "isASNNeeded": { "type": "boolean" }, "asnTemplateName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BookLoadCostInformation": { "type": "object", "properties": { "resultCode": { "type": "string", "nullable": true }, "isPROchanged": { "type": "boolean" }, "isBooked": { "type": "boolean" }, "loadID": { "type": "string", "nullable": true }, "proNumber": { "type": "string", "nullable": true }, "poNumber": { "type": "string", "nullable": true }, "billingID": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BookLoadCostRequest": { "type": "object", "properties": { "loadId": { "type": "integer", "format": "int32" }, "proNumber": { "type": "string", "nullable": true }, "billingId": { "type": "string", "nullable": true }, "poNumber": { "type": "string", "nullable": true }, "isHotShipment": { "type": "boolean" } }, "additionalProperties": false }, "BookLoadCostResponse": { "type": "object", "properties": { "information": { "$ref": "#/components/schemas/BookLoadCostInformation" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorType" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningType" }, "nullable": true } }, "additionalProperties": false }, "BookLoadDetail": { "type": "object", "properties": { "terms": { "type": "string", "description": "Possible values: Prepaid, Collect, ThirdParty, PrepaidAdd", "nullable": true }, "billingID": { "type": "string", "nullable": true }, "poNumber": { "type": "string", "nullable": true }, "proNumber": { "type": "string", "nullable": true }, "customID": { "type": "string", "nullable": true }, "customerBilling": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BookLoadRequest": { "type": "object", "properties": { "mustArriveByDate": { "type": "string", "format": "date-time", "nullable": true }, "loadDetails": { "$ref": "#/components/schemas/BookLoadDetail" }, "billingLocation": { "$ref": "#/components/schemas/BillingLocation" }, "originLocation": { "$ref": "#/components/schemas/LocationLoad" }, "destinationLocation": { "$ref": "#/components/schemas/LocationLoad" }, "accessorials": { "$ref": "#/components/schemas/Accessorials" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDetailsInfo" }, "nullable": true }, "additionalLoadInfo": { "$ref": "#/components/schemas/LoadInformation" }, "scac": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClassifierFreightClass": { "enum": [ 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117 ], "type": "integer", "description": "100 = FreightClass50, 101 = FreightClass55, 102 = FreightClass60, 103 = FreightClass65, 104 = FreightClass70, 105 = FreightClass77_5, 106 = FreightClass85, 107 = FreightClass92_5, 108 = FreightClass100, 109 = FreightClass110, 110 = FreightClass125, 111 = FreightClass150, 112 = FreightClass175, 113 = FreightClass200, 114 = FreightClass250, 115 = FreightClass300, 116 = FreightClass400, 117 = FreightClass500", "format": "int32" }, "ClassifierHazClass": { "enum": [ 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234 ], "type": "integer", "description": "210 = HazClass1, 211 = HazClass1_1, 212 = HazClass1_2, 213 = HazClass1_3, 214 = HazClass1_4, 215 = HazClass1_5, 216 = HazClass1_6, 217 = HazClass2, 218 = HazClass2_1, 219 = HazClass2_2, 220 = HazClass2_3, 221 = HazClass3, 222 = HazClass4, 223 = HazClass4_1, 224 = HazClass4_2, 225 = HazClass4_3, 226 = HazClass5, 227 = HazClass5_1, 228 = HazClass5_2, 229 = HazClass6, 230 = HazClass6_1, 231 = HazClass6_2, 232 = HazClass7, 233 = HazClass8, 234 = HazClass9", "format": "int32" }, "ClassifierLoadShipLabelReport": { "enum": [ 800, 801, 802, 803, 804, 805, 806, 807, 808, 809, 813, 814, 815, 816 ], "type": "integer", "description": "800 = ShipLabel6x4Page1x4, 801 = ShipLabel8x11Page1x1, 802 = ShipLabel11x8Page4x1, 803 = ShipLabel6x4Page1x1, 804 = ShipLabel4x6Page1x4, 805 = ShipLabel4x6Page1x2, 806 = ShipLabel4x3Page1x4, 807 = ShipLabel4x2Page1x4, 808 = ShipLabel8x4Page1x1, 809 = ShipLabel11x8Page1x1, 813 = ShipLabel4x6Page1x1, 814 = ShipLabel2x4Page1x2, 815 = ShipLabel4x4Page1x4, 816 = ShipLabel4x7Page1x1", "format": "int32" }, "Countries": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "1 = USA, 2 = CAN, 3 = OTHER, 4 = MEX", "format": "int32" }, "CreateLoad - Country": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Countries" } }, "x-public-api-schema": true }, "CreateLoad - DockType": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AccesorialDockType" } }, "x-public-api-schema": true }, "CreateLoad - FreightClass": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ClassifierFreightClass" } }, "x-public-api-schema": true }, "CreateLoad - HazClass": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ClassifierHazClass" } }, "x-public-api-schema": true }, "CreateLoad - LabelTypeId": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ClassifierLoadShipLabelReport" } }, "x-public-api-schema": true }, "CreateLoad - LoadEquipmentType": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/EquipmentType" } }, "x-public-api-schema": true }, "CreateLoad - Packaging": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TypePackaging" } }, "x-public-api-schema": true }, "CreateLoad - PgCode": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PGType" } }, "x-public-api-schema": true }, "CreateLoad - ShippingUnits": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TypePackaging" } }, "x-public-api-schema": true }, "CreateLoad - SubClass": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/SubclassClassifier" } }, "x-public-api-schema": true }, "CreateLoad - UnNa": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/UNNAType" } }, "x-public-api-schema": true }, "CreateLoadActionOptionDto": { "type": "object", "properties": { "accountId": { "type": "integer", "format": "int32" }, "rate": { "type": "boolean" }, "book": { "type": "string", "nullable": true }, "proNumber": { "type": "boolean" }, "dispatch": { "type": "boolean" }, "errorEmailNotification": { "type": "string", "description": "Email address that receives the error notification when one of the requested actions fails. Multiple recipients are supported: separate the addresses with a comma, for example \"ops@company.com,support@company.com\". The comma is the only accepted separator (a semicolon is not), spaces around each address are ignored, and the whole value is limited to 500 characters.", "nullable": true } }, "additionalProperties": false }, "CreateLoadDetailDto": { "type": "object", "properties": { "billingID": { "type": "string", "nullable": true }, "poNumber": { "type": "string", "nullable": true }, "proNumber": { "type": "string", "nullable": true }, "customID": { "type": "string", "nullable": true }, "customerBilling": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateLoadRequestDto": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/CreateLoadActionOptionDto" }, "emailParameters": { "$ref": "#/components/schemas/EmailParametersDto" }, "loadDetails": { "$ref": "#/components/schemas/CreateLoadDetailDto" }, "billingLocation": { "$ref": "#/components/schemas/BillingLocationDto" }, "originLocation": { "$ref": "#/components/schemas/LocationLoadDto" }, "destinationLocation": { "$ref": "#/components/schemas/LocationLoadDto" }, "accessorials": { "$ref": "#/components/schemas/Accessorials" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDetailsInfo" }, "nullable": true }, "additionalLoadInfo": { "$ref": "#/components/schemas/LoadInformationDto" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "nullable": true } }, "additionalProperties": false }, "CreateLoadResponseDto": { "type": "object", "properties": { "information": { "$ref": "#/components/schemas/InformationDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/MessageDto" }, "nullable": true } }, "additionalProperties": false }, "EmailAttachementsDto": { "type": "object", "properties": { "bol": { "type": "boolean" }, "label": { "type": "boolean" }, "labelTypeId": { "type": "string", "description": "Possible values: ShipLabel6x4Page1x4, ShipLabel8x11Page1x1, ShipLabel11x8Page4x1, ShipLabel6x4Page1x1, ShipLabel4x6Page1x4, ShipLabel4x6Page1x2, ShipLabel4x3Page1x4, ShipLabel4x2Page1x4, ShipLabel8x4Page1x1, ShipLabel11x8Page1x1, ShipLabel4x6Page1x1, ShipLabel2x4Page1x2, ShipLabel4x4Page1x4, ShipLabel4x7Page1x1", "nullable": true }, "loadAttachments": { "type": "boolean" } }, "additionalProperties": false }, "EmailParametersDto": { "type": "object", "properties": { "emailFrom": { "type": "string", "nullable": true }, "emailTo": { "type": "string", "nullable": true }, "emailSubject": { "type": "string", "nullable": true }, "emailBody": { "type": "string", "nullable": true }, "emailAttachements": { "$ref": "#/components/schemas/EmailAttachementsDto" } }, "additionalProperties": false }, "EquipmentType": { "enum": [ "VanStandardTrailer", "CargoVan", "StraightTruck", "PartialTruckload", "DoubleDrop", "FlatBed", "LowBoy", "StepDeck", "Tanker", "Intermodal", "CurtainSide", "RGN", "Refrigerated", "Heated", "Other", "VanTrailer53ft", "Container20ft", "Container40ft", "DumpTruck", "Frozen", "Gooseneck", "HopperBottom", "MaxiTrailer", "RollOffTruck", "WalkingFloor", "PartialVanStandardTrailer", "PartialStepDeck", "PartialFlatBed", "Reefer53ft", "PowerOnly", "FlatbedPullCurtain53ft", "StepDeckPullCurtain53ft", "DoubleDropPullCurtain53ft", "Bulk", "SprinterVan", "HotShot" ], "type": "string", "description": "1 = VanStandardTrailer, 2 = CargoVan, 3 = StraightTruck, 4 = PartialTruckload, 5 = DoubleDrop, 6 = FlatBed, 7 = LowBoy, 8 = StepDeck, 9 = Tanker, 10 = Intermodal, 11 = CurtainSide, 12 = RGN, 13 = Refrigerated, 14 = Heated, 15 = Other, 16 = VanTrailer53ft, 17 = Container20ft, 18 = Container40ft, 19 = DumpTruck, 20 = Frozen, 21 = Gooseneck, 22 = HopperBottom, 23 = MaxiTrailer, 24 = RollOffTruck, 25 = WalkingFloor, 26 = PartialVanStandardTrailer, 27 = PartialStepDeck, 28 = PartialFlatBed, 29 = Reefer53ft, 30 = PowerOnly, 31 = FlatbedPullCurtain53ft, 32 = StepDeckPullCurtain53ft, 33 = DoubleDropPullCurtain53ft, 34 = Bulk, 35 = SprinterVan, 36 = HotShot" }, "ErrorType": { "type": "object", "properties": { "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FileInfo": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "extension": { "type": "string", "nullable": true }, "fileContent": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "HazMat": { "type": "object", "properties": { "isHazMat": { "type": "boolean" }, "unNa": { "type": "string", "description": "Possible values: U, N", "nullable": true }, "unNaNumber": { "type": "string", "nullable": true }, "hazClass": { "type": "string", "description": "Possible values: 1, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2, 2.1, 2.2, 2.3, 3, 4, 4.1, 4.2, 4.3, 5, 5.1, 5.2, 6, 6.1, 6.2, 7, 8, 9", "nullable": true }, "pgCode": { "type": "string", "description": "Possible values: None, PGI, PGII, PGIII", "nullable": true }, "subRisk": { "type": "number", "format": "double", "nullable": true }, "vol": { "type": "number", "format": "double" }, "limitedQuantity": { "type": "boolean" } }, "additionalProperties": false }, "Information": { "type": "object", "properties": { "resultCode": { "type": "string", "nullable": true }, "resultDescription": { "type": "string", "nullable": true }, "originPostalCode": { "type": "string", "nullable": true }, "destinationPostalCode": { "type": "string", "nullable": true }, "loadID": { "type": "string", "nullable": true }, "customerLoadID": { "type": "string", "nullable": true }, "proNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InformationDto": { "type": "object", "properties": { "loadId": { "type": "string", "nullable": true }, "proNumber": { "type": "string", "nullable": true }, "billingId": { "type": "string", "nullable": true }, "customId": { "type": "string", "nullable": true }, "poNumber": { "type": "string", "nullable": true }, "customerBilling": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ItemDetailsInfo": { "type": "object", "properties": { "qty": { "type": "string", "nullable": true }, "packaging": { "type": "string", "description": "Possible values: Bags, Bales, Barrels, Baskets, Boxes, Buckets, Bulkheads, Bundles, Carboys, Cartons, Cases, Chests, Coils, Crates, Cylinders, Drums, Feet, Firkins, Hampers, Hogsheads, Kegs, Packages, Pails, Pallets, Pieces, Racks, Reels, Rolls, Skids, SlipSheets, Sows, SuperSack, Totes, Trailers, Truckload, Trunks, Tubes, Unpackaged, FloorLoaded, Tanks, PackingSlip, ChepPallets, EmptyTotes, EmptyDrums, EmptyContainers, Carrier, Gaylords, PalletsStackable, PalletsNonStackable, Doors, Skins, Jambs, BasePlate, Carts, Eaches", "nullable": true }, "freightClass": { "type": "string", "description": "Possible values: 50, 55, 60, 65, 70, 77.5, 85, 92.5, 100, 110, 125, 150, 175, 200, 250, 300, 400, 500", "nullable": true }, "weight": { "type": "string", "nullable": true }, "nmfCnumber": { "type": "string", "nullable": true }, "subClass": { "type": "string", "description": "Possible values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20", "nullable": true }, "description": { "type": "string", "nullable": true }, "hazMat": { "$ref": "#/components/schemas/HazMat" }, "itemDimensions": { "$ref": "#/components/schemas/ItemDimensions" } }, "additionalProperties": false }, "ItemDimensions": { "type": "object", "properties": { "length": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" }, "width": { "type": "integer", "format": "int32" }, "shipQuantity": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "LoadASNTemplateDto": { "type": "object", "properties": { "isASNNeeded": { "type": "boolean" }, "asnTemplateName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LoadDetail": { "type": "object", "properties": { "loadID": { "type": "integer", "format": "int32" }, "shipDate": { "type": "string", "format": "date-time" }, "carrierBooked": { "type": "string", "nullable": true }, "scac": { "type": "string", "nullable": true }, "proNumber": { "type": "string", "nullable": true }, "confirmationNumber": { "type": "string", "nullable": true }, "trackingLink": { "type": "string", "nullable": true }, "loadStatusDetail": { "type": "string", "nullable": true }, "billingID": { "type": "string", "nullable": true }, "poNumber": { "type": "string", "nullable": true }, "customID": { "type": "string", "nullable": true }, "customerBilling": { "type": "string", "nullable": true }, "originInfo": { "$ref": "#/components/schemas/LocationDTO" }, "destinationInfo": { "$ref": "#/components/schemas/LocationDTO" }, "totalWeight": { "type": "integer", "format": "int32" }, "totalShippingQty": { "type": "integer", "format": "int32" }, "shippingUnit": { "type": "string", "nullable": true }, "specialInstructions": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "loadStatusId": { "$ref": "#/components/schemas/LoadStatusType" }, "ship": { "type": "string", "format": "date-time", "nullable": true }, "deliveryDate": { "type": "string", "format": "date-time", "nullable": true }, "custCharge": { "type": "number", "format": "double", "nullable": true }, "freightChange": { "type": "number", "format": "double", "nullable": true }, "access": { "type": "number", "format": "double" }, "base": { "type": "number", "format": "double" }, "fsc": { "type": "number", "format": "double", "nullable": true }, "insuranceFee": { "type": "number", "format": "double", "nullable": true }, "billOfLadingDocument": { "$ref": "#/components/schemas/FileInfo" }, "shippingLabelDocument": { "$ref": "#/components/schemas/FileInfo" }, "rateConfirmationDocument": { "$ref": "#/components/schemas/FileInfo" }, "carrieDocsFile": { "$ref": "#/components/schemas/FileInfo" }, "freightSnapDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/FileInfo" }, "nullable": true }, "mileage": { "type": "integer", "format": "int32" }, "trackingStatus": { "type": "array", "items": { "$ref": "#/components/schemas/TrackingStatusUpdate" }, "nullable": true } }, "additionalProperties": false }, "LoadInfoDocuments": { "type": "object", "properties": { "getBillOfLadingDocument": { "type": "boolean", "default": false }, "getShippingLabelDocument": { "$ref": "#/components/schemas/ShippingLabelDocument" }, "getRateConfirmationDocument": { "type": "boolean", "default": false }, "getCarrieDocsFile": { "type": "boolean", "default": false }, "getFreightSnapDocuments": { "type": "boolean", "default": false } }, "additionalProperties": false }, "LoadInfoReference": { "type": "object", "properties": { "billingId": { "type": "string", "nullable": true }, "poNumber": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "customerBillingId": { "type": "string", "nullable": true }, "proNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LoadInformation": { "type": "object", "properties": { "pickedUpDate": { "type": "string", "format": "date-time" }, "specialInstructions": { "type": "string", "nullable": true }, "shippingQuantity": { "type": "integer", "format": "int32" }, "loadEquipmentType": { "type": "string", "description": "Possible values: VanStandardTrailer, CargoVan, StraightTruck, PartialTruckload, DoubleDrop, FlatBed, LowBoy, StepDeck, Tanker, Intermodal, CurtainSide, RGN, Refrigerated, Heated, Other, VanTrailer53ft, Container20ft, Container40ft, DumpTruck, Frozen, Gooseneck, HopperBottom, MaxiTrailer, RollOffTruck, WalkingFloor, PartialVanStandardTrailer, PartialStepDeck, PartialFlatBed, Reefer53ft, PowerOnly, FlatbedPullCurtain53ft, StepDeckPullCurtain53ft, DoubleDropPullCurtain53ft, Bulk, SprinterVan, HotShot", "nullable": true }, "shippingUnits": { "type": "string", "description": "Possible values: Bags, Bales, Barrels, Baskets, Boxes, Buckets, Bulkheads, Bundles, Carboys, Cartons, Cases, Chests, Coils, Crates, Cylinders, Drums, Feet, Firkins, Hampers, Hogsheads, Kegs, Packages, Pails, Pallets, Pieces, Racks, Reels, Rolls, Skids, SlipSheets, Sows, SuperSack, Totes, Trailers, Truckload, Trunks, Tubes, Unpackaged, FloorLoaded, Tanks, PackingSlip, ChepPallets, EmptyTotes, EmptyDrums, EmptyContainers, Carrier, Gaylords, PalletsStackable, PalletsNonStackable, Doors, Skins, Jambs, BasePlate, Carts, Eaches", "nullable": true }, "asn": { "$ref": "#/components/schemas/BookLoadASNTemplate" }, "allStackable": { "type": "boolean", "nullable": true }, "loadNotes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LoadInformationDto": { "type": "object", "properties": { "pickedUpDate": { "type": "string", "format": "date-time" }, "mustArriveByDate": { "type": "string", "format": "date-time", "nullable": true }, "specialInstructions": { "type": "string", "nullable": true }, "shippingQuantity": { "type": "integer", "format": "int32" }, "loadEquipmentType": { "type": "string", "description": "Possible values: VanStandardTrailer, CargoVan, StraightTruck, PartialTruckload, DoubleDrop, FlatBed, LowBoy, StepDeck, Tanker, Intermodal, CurtainSide, RGN, Refrigerated, Heated, Other, VanTrailer53ft, Container20ft, Container40ft, DumpTruck, Frozen, Gooseneck, HopperBottom, MaxiTrailer, RollOffTruck, WalkingFloor, PartialVanStandardTrailer, PartialStepDeck, PartialFlatBed, Reefer53ft, PowerOnly, FlatbedPullCurtain53ft, StepDeckPullCurtain53ft, DoubleDropPullCurtain53ft, Bulk, SprinterVan, HotShot", "nullable": true }, "shippingUnits": { "type": "string", "description": "Possible values: Bags, Bales, Barrels, Baskets, Boxes, Buckets, Bulkheads, Bundles, Carboys, Cartons, Cases, Chests, Coils, Crates, Cylinders, Drums, Feet, Firkins, Hampers, Hogsheads, Kegs, Packages, Pails, Pallets, Pieces, Racks, Reels, Rolls, Skids, SlipSheets, Sows, SuperSack, Totes, Trailers, Truckload, Trunks, Tubes, Unpackaged, FloorLoaded, Tanks, PackingSlip, ChepPallets, EmptyTotes, EmptyDrums, EmptyContainers, Carrier, Gaylords, PalletsStackable, PalletsNonStackable, Doors, Skins, Jambs, BasePlate, Carts, Eaches", "nullable": true }, "allStackable": { "type": "boolean", "nullable": true }, "loadNotes": { "type": "string", "nullable": true }, "asn": { "$ref": "#/components/schemas/LoadASNTemplateDto" } }, "additionalProperties": false }, "LoadInformationResponse": { "type": "object", "properties": { "loadDetails": { "type": "array", "items": { "$ref": "#/components/schemas/LoadDetail" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningType" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorType" }, "nullable": true } }, "additionalProperties": false }, "LoadRequest": { "type": "object", "properties": { "loadsId": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "loadsReference": { "type": "array", "items": { "$ref": "#/components/schemas/LoadInfoReference" }, "nullable": true }, "statusLoads": { "type": "array", "items": { "$ref": "#/components/schemas/StatusLoad" }, "nullable": true }, "loadInfoDocuments": { "$ref": "#/components/schemas/LoadInfoDocuments" } }, "additionalProperties": false }, "LoadStatusType": { "enum": [ "Pending", "Quoted", "Booked", "Dispatched", "InTransit", "Delivered", "Exception", "Billed", "Paid", "Imported", "NIS", "Canceled", "None" ], "type": "string", "description": "1 = Pending, 2 = Quoted, 3 = Booked, 4 = Dispatched, 5 = InTransit, 6 = Delivered, 7 = Exception, 8 = Billed, 9 = Paid, 10 = Imported, 15 = NIS, 20 = Canceled, -1 = None" }, "LocationDTO": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "street1": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "countryId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "LocationInformation": { "type": "object", "properties": { "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "description": "Possible values: USA, CAN, OTHER, MEX", "nullable": true }, "notesNotOnBOL": { "type": "string", "nullable": true }, "dockType": { "type": "string", "description": "Possible values: BusinessWithDock, BusinessWithOutDock, Residence, OtherLimitedAccess, Construction, Church, Military, StorageFacility, School, Farm, Mine, Prison, Government, Nuclear, Hotel, GroceryWarehouse", "nullable": true } }, "additionalProperties": false }, "LocationLoad": { "type": "object", "properties": { "contact": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "other": { "type": "string", "nullable": true }, "type": { "type": "string", "description": "Possible values: BusinessWithDock, BusinessWithOutDock, Residence, OtherLimitedAccess, Construction, Church, Military, StorageFacility, School, Farm, Mine, Prison, Government, Nuclear, Hotel, GroceryWarehouse", "nullable": true }, "notes": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "dockOpen": { "type": "string", "format": "date-time" }, "dockClose": { "type": "string", "format": "date-time" }, "notesNotOnBOL": { "type": "string", "nullable": true }, "appointment": { "type": "boolean" }, "appointmentDate": { "type": "string", "format": "date-time" }, "freightReadyTime": { "type": "string", "format": "date-time" }, "name": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "stateProvince": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "description": "Possible values: USA, CAN, OTHER, MEX", "nullable": true } }, "additionalProperties": false }, "LocationLoadDto": { "type": "object", "properties": { "contact": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "phoneExtension": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "dockType": { "type": "string", "description": "Possible values: BusinessWithDock, BusinessWithOutDock, Residence, OtherLimitedAccess, Construction, Church, Military, StorageFacility, School, Farm, Mine, Prison, Government, Nuclear, Hotel, GroceryWarehouse", "nullable": true }, "notes": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "dockOpen": { "type": "string", "format": "date-time" }, "dockClose": { "type": "string", "format": "date-time" }, "notesNotOnBOL": { "type": "string", "nullable": true }, "appointment": { "type": "boolean" }, "appointmentDate": { "type": "string", "format": "date-time" }, "freightReadyTime": { "type": "string", "format": "date-time" }, "acceptGoogleSuggestions": { "type": "boolean" }, "acceptAddyBookSuggestion": { "type": "boolean" }, "acceptAccessorialSuggestions": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "stateProvince": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "description": "Possible values: USA, CAN, OTHER, MEX", "nullable": true } }, "additionalProperties": false }, "MessageDto": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Notification": { "type": "object", "properties": { "notificationID": { "type": "integer", "format": "int32" }, "emails": { "type": "string", "nullable": true }, "potentialLate": { "type": "boolean" }, "loadException": { "type": "boolean" }, "rateChange": { "type": "boolean" }, "delivery": { "type": "boolean" }, "weatherDelay": { "type": "boolean" }, "reweigh": { "type": "boolean" } }, "additionalProperties": false }, "PGType": { "enum": [ "None", "PGI", "PGII", "PGIII" ], "type": "string", "description": "0 = None, 1 = PGI, 2 = PGII, 3 = PGIII" }, "QuoteEngineRequest": { "type": "object", "properties": { "mustArriveByDate": { "type": "string", "format": "date-time", "nullable": true }, "originLocation": { "$ref": "#/components/schemas/LocationInformation" }, "destinationLocation": { "$ref": "#/components/schemas/LocationInformation" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDetailsInfo" }, "nullable": true }, "totalDetail": { "$ref": "#/components/schemas/TotalDetail" }, "accessorials": { "$ref": "#/components/schemas/Accessorials" } }, "additionalProperties": false }, "QuoteEngineResponse": { "type": "object", "properties": { "information": { "$ref": "#/components/schemas/Information" }, "quotes": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteInfoDetail" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningType" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorType" }, "nullable": true }, "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" }, "nullable": true } }, "additionalProperties": false }, "QuoteInfoDetail": { "type": "object", "properties": { "carrier": { "type": "string", "nullable": true }, "scac": { "type": "string", "nullable": true }, "customerCharge": { "type": "string", "nullable": true }, "freightCharge": { "type": "string", "nullable": true }, "transitTime": { "type": "string", "nullable": true }, "indirect": { "type": "boolean" }, "notes": { "type": "string", "nullable": true }, "pricingOwnershipID": { "type": "integer", "format": "int32" }, "access": { "type": "number", "format": "double" }, "base": { "type": "number", "format": "double" }, "fsc": { "type": "number", "format": "double" }, "totalCharge": { "type": "number", "format": "double" }, "serviceLevel": { "type": "string", "nullable": true }, "tenantPricing": { "type": "boolean" }, "insuranceFee": { "type": "number", "format": "double" }, "mode": { "type": "string", "nullable": true }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "performance": { "type": "string", "nullable": true }, "smartSelect": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShippingLabelDocument": { "type": "object", "properties": { "isRequiered": { "type": "boolean", "default": false }, "reportTypeId": { "type": "integer", "format": "int32", "default": 802 } }, "additionalProperties": false }, "StatusLoad": { "enum": [ "Pending", "Quoted", "Booked", "Dispatched", "InTransit", "Delivered", "Canceled" ], "type": "string", "description": "1 = Pending, 2 = Quoted, 3 = Booked, 4 = Dispatched, 5 = InTransit, 6 = Delivered, 20 = Canceled" }, "SubclassClassifier": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ], "type": "integer", "description": "1 = Subclass1, 2 = Subclass2, 3 = Subclass3, 4 = Subclass4, 5 = Subclass5, 6 = Subclass6, 7 = Subclass7, 8 = Subclass8, 9 = Subclass9, 10 = Subclass10, 11 = Subclass11, 12 = Subclass12, 13 = Subclass13, 14 = Subclass14, 15 = Subclass15, 16 = Subclass16, 17 = Subclass17, 18 = Subclass18, 19 = Subclass19, 20 = Subclass20", "format": "int32" }, "TotalDetail": { "required": [ "quantity", "units" ], "type": "object", "properties": { "customerLoadID": { "type": "string", "nullable": true }, "proNumber": { "type": "string", "nullable": true }, "quantity": { "minLength": 1, "type": "string" }, "units": { "minLength": 1, "type": "string" }, "linFt": { "type": "integer", "format": "int32" }, "linIn": { "type": "integer", "format": "int32" }, "includeVol": { "type": "boolean" }, "includeGuar": { "type": "boolean" }, "includeMABDProgram": { "type": "boolean" }, "equipment": { "type": "string", "description": "Possible values: VanStandard, VanTrailer53ft, Container20ft, Container40ft, DoubleDrop, DumpTruck, FlatBed, Frozen, Gooseneck, HopperBottom, LowBoy, MaxiTrailer, Other, Refrigerated, RollOffTruck, StepDeck, Tanker, WalkingFloor, Intermodal, PartialTruckload, CargoVan, StraightTruck, Heated, PartialVanStandardTrailer, PartialStepDeck, PartialFlatBed, Reefer53ft, PowerOnly, CurtainSide", "nullable": true }, "allStackable": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TrackingStatusUpdate": { "type": "object", "properties": { "time": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "weight": { "type": "number", "format": "double" }, "cost": { "type": "number", "format": "double" }, "carrierETA": { "type": "string", "nullable": true }, "updatedOn": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "TypePackaging": { "enum": [ "Bags", "Bales", "Barrels", "Baskets", "Boxes", "Buckets", "Bulkheads", "Bundles", "Carboys", "Cartons", "Cases", "Chests", "Coils", "Crates", "Cylinders", "Drums", "Feet", "Firkins", "Hampers", "Hogsheads", "Kegs", "Packages", "Pails", "Pallets", "Pieces", "Racks", "Reels", "Rolls", "Skids", "SlipSheets", "Sows", "SuperSack", "Totes", "Trailers", "Truckload", "Trunks", "Tubes", "Unpackaged", "FloorLoaded", "Tanks", "PackingSlip", "ChepPallets", "EmptyTotes", "EmptyDrums", "EmptyContainers", "Carrier", "Gaylords", "PalletsStackable", "PalletsNonStackable", "Doors", "Skins", "Jambs", "BasePlate", "Carts", "Eaches" ], "type": "string", "description": "10 = Bags, 11 = Bales, 12 = Barrels, 13 = Baskets, 14 = Boxes, 15 = Buckets, 16 = Bulkheads, 17 = Bundles, 18 = Carboys, 19 = Cartons, 20 = Cases, 21 = Chests, 22 = Coils, 23 = Crates, 24 = Cylinders, 25 = Drums, 26 = Feet, 27 = Firkins, 28 = Hampers, 29 = Hogsheads, 30 = Kegs, 31 = Packages, 32 = Pails, 33 = Pallets, 34 = Pieces, 35 = Racks, 36 = Reels, 37 = Rolls, 38 = Skids, 39 = SlipSheets, 40 = Sows, 41 = SuperSack, 42 = Totes, 43 = Trailers, 44 = Truckload, 45 = Trunks, 46 = Tubes, 47 = Unpackaged, 48 = FloorLoaded, 49 = Tanks, 50 = PackingSlip, 51 = ChepPallets, 52 = EmptyTotes, 53 = EmptyDrums, 54 = EmptyContainers, 55 = Carrier, 56 = Gaylords, 57 = PalletsStackable, 58 = PalletsNonStackable, 59 = Doors, 60 = Skins, 61 = Jambs, 62 = BasePlate, 63 = Carts, 71 = Eaches" }, "UNNAType": { "enum": [ "U", "N" ], "type": "string", "description": "0 = U, 1 = N" }, "UpdateLoad - Country": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Countries" } }, "x-public-api-schema": true }, "UpdateLoad - DockType": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AccesorialDockType" } }, "x-public-api-schema": true }, "UpdateLoad - FreightClass": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ClassifierFreightClass" } }, "x-public-api-schema": true }, "UpdateLoad - HazClass": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ClassifierHazClass" } }, "x-public-api-schema": true }, "UpdateLoad - LabelTypeId": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ClassifierLoadShipLabelReport" } }, "x-public-api-schema": true }, "UpdateLoad - LoadEquipmentType": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/EquipmentType" } }, "x-public-api-schema": true }, "UpdateLoad - Packaging": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TypePackaging" } }, "x-public-api-schema": true }, "UpdateLoad - PgCode": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PGType" } }, "x-public-api-schema": true }, "UpdateLoad - ShippingUnits": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TypePackaging" } }, "x-public-api-schema": true }, "UpdateLoad - SubClass": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/SubclassClassifier" } }, "x-public-api-schema": true }, "UpdateLoad - UnNa": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/UNNAType" } }, "x-public-api-schema": true }, "UpdateLoadActionOptionDto": { "type": "object", "properties": { "loadId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "rate": { "type": "boolean" }, "book": { "type": "string", "nullable": true }, "proNumber": { "type": "boolean" }, "dispatch": { "type": "boolean" }, "errorEmailNotification": { "type": "string", "description": "Email address that receives the error notification when one of the requested actions fails. Multiple recipients are supported: separate the addresses with a comma, for example \"ops@company.com,support@company.com\". The comma is the only accepted separator (a semicolon is not), spaces around each address are ignored, and the whole value is limited to 500 characters.", "nullable": true } }, "additionalProperties": false }, "UpdateLoadDetailDto": { "type": "object", "properties": { "billingID": { "type": "string", "nullable": true }, "poNumber": { "type": "string", "nullable": true }, "proNumber": { "type": "string", "nullable": true }, "customID": { "type": "string", "nullable": true }, "customerBilling": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateLoadRequestDto": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/UpdateLoadActionOptionDto" }, "emailParameters": { "$ref": "#/components/schemas/EmailParametersDto" }, "loadDetails": { "$ref": "#/components/schemas/UpdateLoadDetailDto" }, "billingLocation": { "$ref": "#/components/schemas/BillingLocationDto" }, "originLocation": { "$ref": "#/components/schemas/LocationLoadDto" }, "destinationLocation": { "$ref": "#/components/schemas/LocationLoadDto" }, "accessorials": { "$ref": "#/components/schemas/Accessorials" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDetailsInfo" }, "nullable": true }, "additionalLoadInfo": { "$ref": "#/components/schemas/LoadInformationDto" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "nullable": true } }, "additionalProperties": false }, "UpdateReRateRequest": { "type": "object", "properties": { "mustArriveByDate": { "type": "string", "format": "date-time", "nullable": true }, "loadId": { "type": "integer", "format": "int32" }, "billingInformation": { "$ref": "#/components/schemas/BillingReRateInformation" }, "originLocation": { "$ref": "#/components/schemas/LocationLoad" }, "destinationLocation": { "$ref": "#/components/schemas/LocationLoad" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDetailsInfo" }, "nullable": true }, "accessorials": { "$ref": "#/components/schemas/Accessorials" }, "additionalLoadInfo": { "$ref": "#/components/schemas/LoadInformation" }, "accessories": { "$ref": "#/components/schemas/AccessoryListReRate" } }, "additionalProperties": false }, "WarningType": { "type": "object", "properties": { "warning": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "apikey", "description": "Your API key, sent in the `apikey` header on every request. Copy or generate it on Your Profile in the TMS; see Authentication." } } }, "tags": [ { "name": "Loads and quotes", "description": "Create and update loads, look them up, and price shipments.", "x-zudoku-seo": { "title": "Loads and quotes - API Reference" } }, { "name": "Rating and booking", "description": "Create, rate and book in one call, re-rate a changed load, and book the best-value carrier.", "x-zudoku-seo": { "title": "Rating and booking - API Reference" } } ], "servers": [ { "url": "https://tmstest.reconex.io", "description": "Test (sandbox for building and testing your integration)" }, { "url": "https://tms.reconex.io", "description": "Production" } ], "security": [ { "ApiKey": [] } ] }