openapi: 3.0.1 info: title: Loadsmart API x-logo: altText: Loadsmart API url: https://developer.loadsmart.com/logo.svg description: | Loadsmart API provides endpoints to quote, book and track shipments autonomously. # Authentication Loadsmart API supports JWT tokens for authentication, signed using public/private key pairs (RSA 4096). ## What is JWT? JSON Web Token (JWT) is an [open standard](https://tools.ietf.org/html/rfc7519) used to create access tokens that contain some number of claims and is cryptographically signed by the issuer, so its integrity can be verified without an auth server. ## Token algorithm We support JWT tokens signed using RS256 algorithm: ``` { "alg": "RS256", "typ": "JWT" } ``` ## Required Claims For the token payload, we require at least the following claims: - `sub`: Identifies the subject of the API call. This could be either `sys` (without any user or client context) or `usr:UUID`, where `UUID` is the uuid of the user that will provide the context for the API call. - `iss`: Identifies who issued the token. This will be provided by Loadsmart when setting up the integration. - `iat`: Standard "issued at" claim; should be an unix timestamp. - `exp`: Standard "expires at" claim; should be an unix timestamp. We recomend to keep the token as short-lived as possible - ideally it should not be valid for more than 1 minute. In the future, Loadsmart could reject tokens with high expiration times. ## Using the token The token must be present in the `Authorization` header on all requests, following the format: ``` Authorization: JWT ``` Each part of the token is encoded in base64 and joined with a dot separating each encoded part - if you use a library to generate it (which is recommended), you don't need to worry about it. **Important: Authorization header value must have the prefix `JWT`**. See an example: ``` Authorization: JWT eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.TCYt5XsITJX1CxPCT8yAV-TVkIEq_PbChOMqsLfRoPsnsgw5WEuts01mq-pQy7UJiN5mgRxD-WUcX16dUEMGlv50aqzpqh4Qktb3rk-BuQy72IFLOqV0G_zS245-kronKb78cPN25DGlcTwLtjPAYuNzVBAh4vGHSrQyHUdBBPM ``` ## Available contexts Each token has an implicit context associated with it (usually depending on the value of `sub` claim). This context identifies to the API if the entity doing an action is an user or a system. Loadsmart API has different token contexts depending on the endpoint being called. Each endpoint will specify the supported contexts (and required scopes) in `AUTHORIZATIONS` section. ## API Access To start using Loadsmart API, please get in touch through your point of contact. They will direct you through the proper flow. ### Creating a public/private key pair For JWT tokens, you should provide your *public key*. To generate a public and private key pair, you can use OpenSSL: ```bash $ openssl genpkey -algorithm RSA -out private_key.pem -pkeyopt rsa_keygen_bits:4096 $ openssl rsa -in private_key.pem -pubout -out public_key.pem ``` *Never* reuse keys between multiple systems. For more information, checkout the [official JWT website](https://jwt.io/). version: 1.0.0 components: securitySchemes: Application-JWT: type: http scheme: bearer bearerFormat: JWT description: | Authorize the request with the application context (preferred for the endpoints that support it): ``` { "sub": "sys", "iss": "token-issuer", "exp": 1626239022, "iat": 1517239022 } ``` User-JWT: type: http scheme: bearer bearerFormat: JWT description: | Authorize the request with an user context. A payload example would be: ``` { "sub": "usr:87127882-d1db-4e50-8f7c-c792a80d7c49", "iss": "token-issuer", "iat": 1517239022, "exp": 1626239022 } ``` schemas: ShipmentMode: type: string default: FTL enum: - FTL - LTL - PTL - RAIL description: | The transportation mode of the load. Allowed values are: - FTL: Full Truckload - LTL: Less-than-Truckload - PTL: Partial Truckload - RAIL: Intermodal rail (53' containers) InternalShipmentMode: type: string default: FTL enum: - ANY - EXP - FCL - FTL - LTL - PTL - RAIL - VLTL description: | The transportation mode of the load. Allowed values are: - ANY - EXP: Expedited - FTL: Full Truckload - FCL: Ful Container Load - LTL: Less-than-Truckload - PTL: Partial Truckload - RAIL: Intermodal rail (53' containers) - VLTL: Volume Less-than-Truckload TenderExternalShipmentMode: type: string default: FTL enum: - FTL - LTL description: | The transportation mode of the load. Allowed values are: - FTL: Full Truckload - LTL: Less-than-Truckload QuoteRequestEquipmentTypes: type: string enum: - DRV - FBE - RFR - IMC description: | Equipment required to transport the shipment. Recognized equipments are: - DRV: Dry Van - FBE: Flatbed - RFR: Reefer - IMC: Intermodal InternalQuoteRequestEquipmentTypes: type: string enum: - BTR - CGV - DRV - dry - FBE - HOT - IMC - reefer - RFR - SPR - STR description: | Equipment required to transport the shipment. Recognized equipments are: - BTR: Box Truck - CGV: Cargo Van - DRV: Dry Van - dry: Dry Container - FBE: Flatbed - HOT: Hotshot - IMC: Intermodal - reefer: Reefer Container - RFR: Reefer - SPR: Sprinter Van - STR: Straight Truck EquipmentType: type: string enum: - DRV - FBE - RFR - CON - CUR - DDP - IMC - SDK - STK - BLK - TNK - OTH description: | Equipment required to transport the shipment. Recognized equipments are: - DRV: Dry Van - FBE: Flatbed - RFR: Reefer - CON: Conestoga - CUR: Curtainside - DDP: Double Drop - IMC: Intermodal - SDK: Step Deck - STK: Straight truck - BLK: Bulk - TNK: Tanker - OTH: Other equipment not explicited listed PhoneNumber: type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) TotalWidth: type: number description: The load total width expressed in 'ft' minimum: 0 TotalLength: type: number description: The load total length expressed in 'ft' minimum: 0 TotalHeight: type: number description: The load total height expressed in 'ft' minimum: 0 Requirements: type: object description: Requirements that needs to be fulfilled in order to transport the load properties: hazmat: type: boolean description: The commodity being moved consists of hazard material tarp: type: object description: If present in 'requirements', it means the shipment needs a tarp properties: size: type: number format: float minimum: 0 description: size in expressed in 'ft' type: type: string enum: - lumber - steel - smoke - parachute - machinery - canvas - hay - poly required: - size dunnage: type: boolean description: Extra rack added to the truck beer: type: boolean description: The carrier must be able to transport alcohool teams: type: boolean description: If it requires a team of drivers servers: - url: https://api.loadsmart.com description: Production server - url: https://api.sandbox.loadsmart.com description: Sandbox environment paths: /api/v2/carrier/search: get: summary: Search a carrier tags: - Carrier security: - Application-JWT: - carrier_search description: | Search a carrier by dot or mc parameters: - in: query name: mc schema: description: Carrier mc type: string format: integer required: false - in: query name: dot schema: description: Carrier dot type: string format: integer required: false responses: "200": description: Success content: application/json: schema: type: object properties: id: type: string name: type: string mc: type: string dot: type: string eligible: type: bool description: | Flag that report if the Carrier is eligible to carry loads status: type: string enum: - NEW - PENDING - READY description: | Onboarding process status: `NEW` means that Carrier is New `PENDING` means that Onboard Process is under review `READY` means that Carrier is successfully onboarded example: id: 9b739d7a-b4db-45f7-a61b-990c7ac77082 dot: "2953461" mc: "456" status: New eligible: false name: J R T TRANS CORP "400": description: Invalid parameters content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: missing_parameters: - query must have mc or dot fields "404": description: Carrier not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found /api/v2/carrier/integrations: get: summary: List of integrations tags: - Carrier security: - Application-JWT: - carrier_read description: | List the integrations that the intermediary have with loadsmart responses: "200": description: Success content: application/json: schema: type: object properties: data: type: array description: An array of integrations items: type: object properties: id: type: string format: uuid count: type: integer next: type: string previous: type: string example: count: 2 next: null previous: null data: - id: f0c1b42c-9f8b-434e-9971-ae1c527e2680 - id: d11a1f7c-fad9-4ff9-b0ba-34fc93f63c3f /api/v2/carrier/integration-request: post: summary: Request Integration for a Carrier description: | 3PP can integrate a carrier and create a Carrier Account security: - Application-JWT: - request_integration_write requestBody: required: true content: application/json: schema: type: object properties: carrier_id: type: string description: Carrier UUID maxLength: 255 owner: type: object description: Company main contact information. properties: first_name: type: string description: First Name maxLength: 255 last_name: type: string description: Last Name maxLength: 255 email: type: string description: Email Address maxLength: 255 phone_number: type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) phone_number_extension: type: string description: Phone Number Extension maxLength: 255 required: - first_name - last_name - email required: - carrier_id example: carrier_id: 9f87d040-f843-42e7-887a-45bea55e76f3 owner: first_name: John last_name: Doe email: john.doe@email.com phone_number: "+1111111111" phone_number_extension: "123" responses: "200": description: Integration Request with same data already exists content: application/json: schema: type: object properties: id: type: string description: Unique Identifier of the Integration Request account_id: type: string description: Unique Identifier of the Account carrier: type: object properties: id: type: string description: Unique Identifier of the Carrier on Loadsmart mc: type: string description: Carrier Interstate Operating Authority (MC number) dot: type: string description: Carrier US DOT Number name: type: string description: Carrier legal name eligible: type: bool description: Flag that report if the Carrier is eligible to carry loads status: type: string enum: - New - Pending - Ready - Inactive description: Carrier status on Loadsmart status: type: string enum: - pending - accepted - rejected description: | Status of the Integration Request - pending: waiting/under evaluation from Carrier owner and/or Loadsmart - accepted: Integration Request accepted - rejected: Integration Request rejected by Carrier owner and/or Loadsmart documents: type: array description: List of required documents and its status items: type: object properties: type: type: string description: Document type (Form W9, Insurance or Authority) status: type: string enum: - missing - under-review - accepted example: id: fe17b7e7-6453-4520-b99d-2d2b44972468 account_id: bc32c4d4-5732-7845-aa32-132cdab5467b carrier: id: 9f87d040-f843-42e7-887a-45bea55e76f3 mc: "12345" dot: "54321" name: John Doe Freights status: new eligible: false status: PENDING documents: - type: w9 status: missing - type: insurance status: under-review - type: authority status: accepted "201": description: Integration Request successfully created content: application/json: schema: type: object properties: id: type: string description: Unique Identifier of the Integration Request account_id: type: string description: Unique Identifier of the Account carrier: type: object properties: id: type: string description: Unique Identifier of the Carrier on Loadsmart mc: type: string description: Carrier Interstate Operating Authority (MC number) dot: type: string description: Carrier US DOT Number name: type: string description: Carrier legal name eligible: type: bool description: Flag that report if the Carrier is eligible to carry loads status: type: string enum: - New - Pending - Ready - Inactive description: Carrier status on Loadsmart status: type: string enum: - pending - accepted - rejected description: | Status of the Integration Request - pending: waiting/under evaluation from Carrier owner and/or Loadsmart - accepted: Integration Request accepted - rejected: Integration Request rejected by Carrier owner and/or Loadsmart documents: type: array description: List of required documents and its status items: type: object properties: type: type: string description: Document type (Form W9, Insurance or Authority) status: type: string enum: - missing - under-review - accepted example: id: fe17b7e7-6453-4520-b99d-2d2b44972468 account_id: bc32c4d4-5732-7845-aa32-132cdab5467b carrier: id: 9f87d040-f843-42e7-887a-45bea55e76f3 mc: "12345" dot: "54321" name: John Doe Freights status: new eligible: false status: PENDING documents: - type: w9 status: missing - type: insurance status: under-review - type: authority status: accepted "404": description: Carrier not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found "422": description: Integration already requested content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. tags: - Carrier get: summary: List Carrier Integration Request status description: | List partner's integration requests security: - Application-JWT: - request_integration_read responses: "200": description: Success content: application/json: schema: type: object properties: data: type: array description: An array of integrations items: type: object properties: id: type: string description: Unique Identifier of the Integration Request carrier_id: type: string description: Unique Identifier of the Carrier on Loadsmart mc: type: string description: Carrier Interstate Operating Authority (MC number) dot: type: string description: Carrier US DOT Number name: type: string description: Carrier legal name status: type: string enum: - pending - accepted - rejected description: | Status of the Integration Request - pending: waiting/under evaluation from Carrier owner and/or Loadsmart - accepted: Integration Request accepted - rejected: Integration Request rejected by Carrier owner and/or Loadsmart count: type: integer next: type: string previous: type: string example: count: 1 next: null previous: null data: - id: fe17b7e7-6453-4520-b99d-2d2b44972468 carrier_id: bc32c4d4-5732-7845-aa32-132cdab5467b mc: "12345" dot: "54321" name: John Doe Freights status: pending "404": description: No integration requests found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found tags: - Carrier "/api/v2/carrier/integration-request/{id}": get: summary: Detail Carrier Integration Request status description: | 3PP can check the Integrate Status of a Carrier security: - Application-JWT: - request_integration_read parameters: - in: path name: id schema: description: Unique Integration Request identifier type: string format: uuid required: true responses: "200": description: Success content: application/json: schema: type: object properties: id: type: string description: Unique Identifier of the Integration Request account_id: type: string description: Unique Identifier of the Account carrier: type: object properties: id: type: string description: Unique Identifier of the Carrier on Loadsmart mc: type: string description: Carrier Interstate Operating Authority (MC number) dot: type: string description: Carrier US DOT Number name: type: string description: Carrier legal name eligible: type: bool description: Flag that report if the Carrier is eligible to carry loads status: type: string enum: - New - Pending - Ready - Inactive description: Carrier status on Loadsmart status: type: string enum: - pending - accepted - rejected description: | Status of the Integration Request - pending: waiting/under evaluation from Carrier owner and/or Loadsmart - accepted: Integration Request accepted - rejected: Integration Request rejected by Carrier owner and/or Loadsmart documents: type: array description: List of required documents and its status items: type: object properties: type: type: string description: Document type (Form W9, Insurance or Authority) status: type: string enum: - missing - under-review - accepted example: id: fe17b7e7-6453-4520-b99d-2d2b44972468 account_id: bc32c4d4-5732-7845-aa32-132cdab5467b carrier: id: 9f87d040-f843-42e7-887a-45bea55e76f3 mc: "12345" dot: "54321" name: John Doe Freights status: new eligible: false status: PENDING documents: - type: w9 status: missing - type: insurance status: under-review - type: authority status: accepted "404": description: Integrate Request not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found tags: - Carrier /api/v2/carrier/documents: post: summary: Upload document description: Uploads Carrier related documents, such as Form W9, Insurance and security: - User-JWT: - carrier_write requestBody: required: true content: multipart/form-data: schema: type: object properties: document_type: type: string enum: - w9 - insurance - authority description: | Type of document: `w9`: Form W9 `insurance`: Certificate of Insurance `authority`: Letter of Authority document: type: string format: binary responses: "200": description: File successfully uploaded content: application/json: schema: type: object properties: document_url: type: string description: File URL type: type: string enum: - w9 - insurance - authority description: | Type of document: `w9`: Form W9 `insurance`: Certificate of Insurance `authority`: Letter of Authority verified: type: boolean description: File has been verified "422": description: Invalid or missing data content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. tags: - Carrier /api/v2/carrier/drivers: get: summary: List drivers tags: - Carrier description: List drivers for this carrier. security: - User-JWT: - carrier_read responses: "200": description: Success content: application/json: schema: type: object properties: data: type: array description: List of drivers items: type: object properties: id: type: string description: Unique identifier for this driver format: uuid readOnly: true name: type: string description: Driver's full name phone_number: nullable: true type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) sms_enabled: type: boolean description: If this driver can receive Loadsmart text messages default: true location: type: object description: Driver's last location readOnly: true required: - id - name count: type: integer description: The number of results in the payload. next: type: string format: uri description: An URL for the next result page. previous: type: string format: uri description: An URL for the previous result page. required: - data example: data: - id: a1336ea6-cf21-4515-a1fa-ab1d0153ef5b name: Doralin Secret phone_number: "+162331747869" sms_enabled: true location: null owner_operator_id: null - id: a392494b-50f7-47f3-8125-bbf63ba930fa name: Lorinda Jeyness phone_number: +171 588 992 8431 sms_enabled: false location: null owner_operator_id: c75077fa-de83-45eb-b95a-0eb1fd4a2d77 count: 2 next: null previous: null post: summary: Create driver tags: - Carrier security: - User-JWT: - carrier_write requestBody: required: true content: application/json: schema: type: object properties: id: type: string description: Unique identifier for this driver format: uuid readOnly: true name: type: string description: Driver's full name phone_number: nullable: true type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) sms_enabled: type: boolean description: If this driver can receive Loadsmart text messages default: true location: type: object description: Driver's last location readOnly: true required: - id - name example: name: Zebulon Pighills phone_number: "+19772914537" sms_enabled: true responses: "201": description: Driver was created content: application/json: schema: type: object properties: data: type: object properties: id: type: string description: Unique identifier for this driver format: uuid readOnly: true name: type: string description: Driver's full name phone_number: nullable: true type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) sms_enabled: type: boolean description: If this driver can receive Loadsmart text messages default: true location: type: object description: Driver's last location readOnly: true required: - id - name example: data: id: 9ba86ef0-7c8f-487e-a7f9-60515078d9a2 name: Zebulon Pighills phone_number: "+19772914537" sms_enabled: true location: null owner_operator_id: 13e32bca-178f-439c-b6e5-3348602f6b2c "422": description: Invalid or missing data content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. "/api/v2/carrier/{driver_id}": get: summary: Retrieve driver tags: - Carrier security: - User-JWT: - carrier_read responses: "200": description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string description: Unique identifier for this driver format: uuid readOnly: true name: type: string description: Driver's full name phone_number: nullable: true type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) sms_enabled: type: boolean description: If this driver can receive Loadsmart text messages default: true location: type: object description: Driver's last location readOnly: true required: - id - name example: data: id: 9ba86ef0-7c8f-487e-a7f9-60515078d9a2 name: Zebulon Pighills phone_number: "+19772914537" sms_enabled: true location: null owner_operator_id: null "404": description: Driver not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found put: summary: Update driver tags: - Carrier security: - User-JWT: - carrier_write requestBody: required: true content: application/json: schema: type: object properties: id: type: string description: Unique identifier for this driver format: uuid readOnly: true name: type: string description: Driver's full name phone_number: nullable: true type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) sms_enabled: type: boolean description: If this driver can receive Loadsmart text messages default: true location: type: object description: Driver's last location readOnly: true required: - id - name example: name: Flobbidinous Floop phone_number: "+19772914537" responses: "201": description: Driver was updated content: application/json: schema: type: object properties: data: type: object properties: id: type: string description: Unique identifier for this driver format: uuid readOnly: true name: type: string description: Driver's full name phone_number: nullable: true type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) sms_enabled: type: boolean description: If this driver can receive Loadsmart text messages default: true location: type: object description: Driver's last location readOnly: true required: - id - name example: data: id: 9ba86ef0-7c8f-487e-a7f9-60515078d9a2 name: Flobbidinous Floop phone_number: "+19772914537" sms_enabled: true location: null owner_operator_id: 13e32bca-178f-439c-b6e5-3348602f6b2c "404": description: Driver not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found "422": description: Invalid or missing data content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. delete: summary: Delete a driver tags: - Carrier security: - User-JWT: - carrier_write responses: "204": description: Driver was deleted "404": description: Driver not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found "/api/v2/shipments/{shipment_id}/empty_location": post: summary: Set empty location description: | Allows a three party partner to set an empty location for a taken load. tags: - Shipments security: - User-JWT: - shipment_write parameters: - in: path name: shipment_id required: true schema: description: Shipment UUID type: string format: uuid requestBody: required: true content: application/json: schema: type: object properties: city: type: string description: Truck empty location's city state: type: string description: Truck empty location's state zipcode: type: string description: Truck empty location's zipcode (first five digits) available_date: type: string description: The date and time the truck is going to be available (UTC) format: date-time pattern: YYYY-MM-DDThh:mm:ssZ required: - city - state - zipcode - available_date example: - city: New York state: NY availability_date: 2016-07-22T12:00:00-03:00 zipcode: "10007" responses: "201": description: All provided data is valid and the empty location was set. "403": description: Logged carrier is not related to the shipment and empty location can't be set. content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: forbiden_access error_description: An user is trying to access a not authorized resource. "422": description: Payload is invalid or shipment doesn't exist and the empty location can't be set. content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. "/api/v2/shipments/{shipment_id}/assign_driver": post: summary: Assign Driver description: | Allows a three party partner to set a driver for a taken load. tags: - Shipments security: - User-JWT: - shipment_write parameters: - in: path name: shipment_id required: true schema: description: Shipment UUID type: string format: uuid requestBody: required: true content: application/json: schema: type: object properties: driver_id: type: string description: Unique identifier for the driver. required: - driver example: - driver_id: 63bb49f7-b98c-4a24-8f58-be8b96b5953d responses: "204": description: All provided data is valid and the driver was set. "403": description: Logged carrier is not related to the driver or is not related to the shipment and driver can't be assign. content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: forbiden_access error_description: An user is trying to access a not authorized resource. "404": description: Shipment doesn't exist. content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found /api/v2/shippers: post: summary: Create shipper tags: - Shippers security: - Application-JWT: - shipper_write requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: uuid description: Unique identifier for this shipper readOnly: true company_name: type: string description: Company name minLength: 10 maxLength: 255 account: type: object writeOnly: true properties: email: type: string format: email description: User's email address maxLength: 100 first_name: type: string description: User's first name maxLength: 255 last_name: type: string description: User's last name maxLength: 255 phone_number: nullable: true type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) verification_channel: type: string enum: - email - sms description: Channel selected to send the verification code required: - email required: - company_name example: company_name: Shipper Ship Inc. responses: "201": description: Shipper was created content: application/json: schema: type: object properties: data: type: object properties: id: type: string format: uuid description: Unique identifier for this shipper readOnly: true company_name: type: string description: Company name minLength: 10 maxLength: 255 required: - company_name example: data: id: 6faebc3d-4423-45eb-bce6-ee6601b155f9 company_name: Shipper Ship Inc. "422": description: Payload is invalid and a shipper can't be created content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. "/api/v2/shippers/{shipper_id}": patch: summary: Update shipper tags: - Shippers security: - Application-JWT: - shipper_write parameters: - in: path name: shipper_id required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: uuid description: Unique identifier for this shipper readOnly: true company_name: type: string description: Company name minLength: 10 maxLength: 255 required: - company_name example: company_name: Some Shipper Ship Inc. responses: "200": description: Shipper was updated content: application/json: schema: type: object properties: data: type: object properties: id: type: string format: uuid description: Unique identifier for this shipper readOnly: true company_name: type: string description: Company name minLength: 10 maxLength: 255 required: - company_name example: data: id: ad5aa25c-3e20-4de8-aeba-3a71d3c3242c company_name: Some Shipper Ship Inc. "422": description: Payload is invalid and a shipper can't be updated content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. /api/v2/shippers/accounts: post: summary: Create account tags: - Shipper Accounts security: - Application-JWT: - user_write requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: uuid description: Unique identifier for this user readOnly: true shipper_id: type: string format: uuid description: Unique identifier for the shipper who this user belongs to email: type: string format: email description: User's email address maxLength: 100 first_name: type: string description: User's first name maxLength: 255 last_name: type: string description: User's last name maxLength: 255 phone_number: nullable: true type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) verification_channel: type: string enum: - email - sms description: Channel selected to send the verification code password: type: string description: Password the user will use to log into Loadsmart's website or in OAuth requests maxLength: 255 required: - shipper_id - email examples: minimal: summary: Minimal value: shipper_id: ba0c0ff4-1db4-48e5-893d-a334dbae0000 email: john@example.com complete: summary: Complete value: shipper_id: ba0c0ff4-1db4-48e5-893d-a334dbae0000 email: johndoe@example.com first_name: John last_name: Doe phone_number: "+19995551234" verification_code: email password: my-strong-password responses: "201": description: Account was created content: application/json: schema: type: object properties: data: type: object properties: id: type: string format: uuid description: Unique identifier for this user readOnly: true shipper_id: type: string format: uuid description: Unique identifier for the shipper who this user belongs to email: type: string format: email description: User's email address maxLength: 100 first_name: type: string description: User's first name maxLength: 255 last_name: type: string description: User's last name maxLength: 255 phone_number: nullable: true type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) verification_channel: type: string enum: - email - sms description: Channel selected to send the verification code password: type: string description: Password the user will use to log into Loadsmart's website or in OAuth requests maxLength: 255 required: - shipper_id - email example: data: id: 6c082402-afe2-4130-bb23-20fb6f01b27f shipper_id: ba0c0ff4-1db4-48e5-893d-a334dbae0000 email: johndoe@example.com first_name: John last_name: Doe phone_number: "+19995551234" "409": description: An account with this email or phone number already exists content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: user_duplicated_data error_description: Can't create the user "422": description: Account wasn't created because some data is missing or incorrect content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. "/api/v2/shippers/accounts/{account_id}": get: summary: Retrieve account description: Returns shipper account details tags: - Shipper Accounts security: - Application-JWT: - account_read responses: "200": description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string format: uuid description: Unique identifier for this user readOnly: true shipper_id: type: string format: uuid description: Unique identifier for the shipper who this user belongs to email: type: string format: email description: User's email address maxLength: 100 first_name: type: string description: User's first name maxLength: 255 last_name: type: string description: User's last name maxLength: 255 phone_number: nullable: true type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) verification_channel: type: string enum: - email - sms description: Channel selected to send the verification code password: type: string description: Password the user will use to log into Loadsmart's website or in OAuth requests maxLength: 255 required: - shipper_id - email example: data: avatar_url: 4b3abdd5-8a0f-4803-abab-d354704ebe3c.jpg email: johndoe@email.com first_name: John last_name: Doe id": 9ba86ef0-7c8f-487e-a7f9-60515078d9a2 phone_number": "+12345678901" active": true "403": description: Logged shipper is not related to the uuid in the url content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: forbiden_access error_description: An user is trying to access a not authorized resource. "404": description: Shipper account not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found patch: summary: Update account description: Updates data of the current account (according to the token). tags: - Shipper Accounts security: - Application-JWT: - user_write parameters: - in: path name: account_id required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: type: object properties: id: type: string format: uuid description: Unique identifier for this user readOnly: true shipper_id: type: string format: uuid description: Unique identifier for the shipper who this user belongs to email: type: string format: email description: User's email address maxLength: 100 first_name: type: string description: User's first name maxLength: 255 last_name: type: string description: User's last name maxLength: 255 phone_number: nullable: true type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) verification_channel: type: string enum: - email - sms description: Channel selected to send the verification code password: type: string description: Password the user will use to log into Loadsmart's website or in OAuth requests maxLength: 255 required: - shipper_id - email example: email: johndoe@example.com first_name: John last_name: Doe phone_number: 19995551234 responses: "200": description: Account updated content: application/json: schema: type: object properties: data: type: object properties: id: type: string format: uuid description: Unique identifier for this user readOnly: true shipper_id: type: string format: uuid description: Unique identifier for the shipper who this user belongs to email: type: string format: email description: User's email address maxLength: 100 first_name: type: string description: User's first name maxLength: 255 last_name: type: string description: User's last name maxLength: 255 phone_number: nullable: true type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) verification_channel: type: string enum: - email - sms description: Channel selected to send the verification code password: type: string description: Password the user will use to log into Loadsmart's website or in OAuth requests maxLength: 255 required: - shipper_id - email example: data: id: 6c082402-afe2-4130-bb23-20fb6f01b27f shipper_id: ba0c0ff4-1db4-48e5-893d-a334dbae0000 email: johndoe@example.com first_name: John last_name: Doe phone_number: 19995551234 "409": description: Another account with this email or phone number already exists content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: user_duplicated_data error_description: Can't update the user "422": description: Informed account data is invalid content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. "/api/v2/shippers/{shipper_id}/info": post: summary: Create shipper billing info tags: - Shipper Accounting Info security: - Application-JWT: - user_write requestBody: required: true content: application/json: schema: type: object properties: billing_name: type: string billing_address: type: string billing_city: type: string billing_zip_code: type: string billing_country: type: string billing_state: type: string tax_id: type: string contact_name: type: string contact_email: type: string contact_phone: type: string terms: type: integer notes: type: string required: - billing_name - billing_address - billing_city - billing_zip_code - billing_country - billing_state - contact_name - contact_email - contact_phone - terms - notes examples: minimal: summary: Minimal value: billing_name: Trunks Williams billing_address: Color St. billing_city: Pallet Ville billing_state: CA billing_zip_code: 99999 billing_country: USA contact_name: John Doe contact_email: John@doe.com contact_phone: null notes: notes complete: summary: Complete value: billing_name: Trunks Williams billing_address: Color St. billing_city: Pallet Ville billing_state: CA billing_zip_code: 99999 tax_id: 123-456789 billing_country: USA contact_name: John Doe contact_email: John@doe.com contact_phone: null notes: notes responses: "201": description: Accounting Info created content: application/json: schema: type: object properties: data: type: object properties: billing_name: type: string billing_address: type: string billing_city: type: string billing_zip_code: type: string billing_country: type: string billing_state: type: string tax_id: type: string contact_name: type: string contact_email: type: string contact_phone: type: string terms: type: integer notes: type: string required: - billing_name - billing_address - billing_city - billing_zip_code - billing_country - billing_state - contact_name - contact_email - contact_phone - terms - notes example: data: billing_name: Trunks Williams billing_address: Color St. billing_city: Pallet Ville billing_state: CA billing_zip_code: 99999 tax_id: 123-456789 billing_country: USA contact_name: John Doe contact_email: John@doe.com contact_phone: null notes: notes get: summary: Retrieve Shipper Accounting Info tags: - Shipper Accounting Info security: - OAuth: - shipper_read responses: "200": description: Retrieve shipper accounting info content: application/json: schema: type: object properties: data: type: object properties: billing_name: type: string billing_address: type: string billing_city: type: string billing_zip_code: type: string billing_country: type: string billing_state: type: string tax_id: type: string contact_name: type: string contact_email: type: string contact_phone: type: string terms: type: integer notes: type: string required: - billing_name - billing_address - billing_city - billing_zip_code - billing_country - billing_state - contact_name - contact_email - contact_phone - terms - notes example: data: billing_name: Trunks Williams billing_address: Color St. billing_city: Pallet Ville billing_state: CA billing_zip_code: 99999 tax_id: 123-456789 billing_country: USA contact_name: John Doe contact_email: John@doe.com contact_phone: null notes: notes put: summary: Update shipper billing info tags: - Shipper Accounting Info security: - Application-JWT: - user_write requestBody: required: true content: application/json: schema: type: object properties: billing_name: type: string billing_address: type: string billing_city: type: string billing_zip_code: type: string billing_country: type: string billing_state: type: string tax_id: type: string contact_name: type: string contact_email: type: string contact_phone: type: string terms: type: integer notes: type: string required: - billing_name - billing_address - billing_city - billing_zip_code - billing_country - billing_state - contact_name - contact_email - contact_phone - terms - notes example: billing_name: Trunks Williams billing_address: Color St. billing_city: Pallet Ville billing_state: CA billing_zip_code: 99999 tax_id: 123-456789 billing_country: USA contact_name: John Doe contact_email: John@doe.com contact_phone: null notes: notes responses: "200": description: Accounting Info updated content: application/json: schema: type: object properties: data: type: object properties: billing_name: type: string billing_address: type: string billing_city: type: string billing_zip_code: type: string billing_country: type: string billing_state: type: string tax_id: type: string contact_name: type: string contact_email: type: string contact_phone: type: string terms: type: integer notes: type: string required: - billing_name - billing_address - billing_city - billing_zip_code - billing_country - billing_state - contact_name - contact_email - contact_phone - terms - notes example: data: billing_name: Trunks Williams billing_address: Color St. billing_city: Pallet Ville billing_state: CA billing_zip_code: 99999 tax_id: 123-456789 billing_country: USA contact_name: John Doe contact_email: John@doe.com contact_phone: null notes: notes "/api/v2/shipments/{shipment_id}": delete: summary: Cancel a shipment tags: - Shipments security: - User-JWT: - shipment_write responses: "204": description: Shipment was canceled "404": description: Shipment not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found get: summary: Retrieve details from a shipment tags: - Shipments security: - User-JWT: - shipment_read parameters: [] responses: "200": description: Shipment was found content: application/json: schema: type: object properties: id: type: string format: uuid description: Unique identifier for this shipment readOnly: true ref_number: type: string maxLength: 255 description: Internal client's reference, such as an ID, of the load bol_number: type: string maxLength: 255 description: The bill of lading number purchase_order_numbers: type: array description: Purchase Orders (PO numbers) associated with this shipment. items: type: string stops: type: array description: Points of interest where the truck makes a stop to either pickup or deliver a shipment. Usually a load has one pickup stop and one delivery stop, but in some cases there will be multiple delivery stops. items: type: object properties: stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. address: type: string city: type: string state: type: string zipcode: type: string minItems: 2 requirements: type: object description: Requirements that needs to be fulfilled in order to transport the load properties: hazmat: type: boolean description: The commodity being moved consists of hazard material tarp: type: object description: If present in 'requirements', it means the shipment needs a tarp properties: size: type: number format: float minimum: 0 description: size in expressed in 'ft' type: type: string enum: - lumber - steel - smoke - parachute - machinery - canvas - hay - poly required: - size dunnage: type: boolean description: Extra rack added to the truck beer: type: boolean description: The carrier must be able to transport alcohool teams: type: boolean description: If it requires a team of drivers example: data: bol_number: "31871465" ref_number: "24577100" purchase_order_numbers: - abc123 - 321cba stops: - address: 2814 S SECOND ST city: St. Louis stop_index: 0 state: MO zipcode: "63118" - address: 825 STONE AVE city: Monroe stop_index: 1 state: LA zipcode: "71201" requirements: hazmat: false beer: false dunnage: true tarp: size: 10 type: lumber id: 2d490b57-6c77-4ee7-8d14-cb9d8d89923d "404": description: Shipment not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found "/api/v2/shipments/{shipment_id}/interested": post: summary: Show interest in a shipment. description: Inform us about interest in a shipment and request a call. tags: - Shipments security: - User-JWT: - shipment_read parameters: - in: path name: shipment_id required: true schema: description: Shipment UUID type: string format: uuid responses: "200": description: Shipment was found and the message was sent. "404": description: Shipment not found. content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found "/api/v2/shipments/{shipment_id}/events": post: summary: Create shipment event description: When moving the load always start the flow with the shipment:en-route-to-pickup event. security: - User-JWT: - shipment_write parameters: - in: path name: shipment_id required: true schema: description: Shipment UUID type: string format: uuid requestBody: content: application/json: schema: allOf: - type: object properties: type: type: string description: Event type enum: - shipment:en-route-to-pickup - shipment:check-in-pickup - shipment:check-out-pickup - shipment:check-in-delivery - shipment:check-out-delivery - shipment:incident - shipment:carrier-updated event_date: type: string format: date-time description: The date and time of the event (if not informed, current date is used) stop_index: type: integer description: Corresponds to the number of the stop, being 0-based for pickup details: oneOf: - title: shipment:check-in-pickup type: object properties: late-reason: type: string description: The reason which caused the delay enum: - accident - address_corrected_delivery_attempted - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - customer_wanted_earlier_delivery - driver_not_available - driver_related - held_per_shipper - hold_due_customs_documentation_problems - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - past_cut_off_time - previous_stop - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - title: shipment:check-out-pickup type: object properties: late-reason: type: string description: The reason which caused the delay enum: - accident - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - consignee_related - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_per_shipper - hold_due_customs_documentation_problems - improper_unloading_facility_or_equipment - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - past_cut_off_time - previous_stop - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - waiting_shipping_instructions - title: shipment:check-in-delivery type: object properties: late-reason: type: string description: The reason which caused the delay enum: - accident - address_corrected_delivery_attempted - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - customer_wanted_earlier_delivery - driver_not_available - driver_related - held_per_shipper - hold_due_customs_documentation_problems - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - past_cut_off_time - previous_stop - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - title: shipment:check-out-delivery type: object properties: late-reason: type: string description: The reason which caused the delay enum: - accident - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - consignee_related - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_per_shipper - hold_due_customs_documentation_problems - improper_unloading_facility_or_equipment - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - past_cut_off_time - previous_stop - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - waiting_shipping_instructions - type: object title: shipment:incident properties: type: type: string description: The type of the incident enum: - detention_loading - detention_unloading - truck_breakdown - driver_late_shipper - driver_late_receiver - TONU - transit_check - OSD - misc - lumper - no_contact_with_dispatcher - no_contact_with_driver - driver_risk_miss_appointment - rejected_load - truck_overweight - other reason: type: string description: The reason which caused the incident enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions eta: type: string format: date-time description: A new ETA after the incident notes: type: string description: Any additional information required: - type - type: object title: shipment:carrier-updated properties: tractor_number: type: string maxLength: 70 nullable: true trailer_number: type: string maxLength: 70 nullable: true required: - type example: type: shipment:check-in-pickup event_date: 2018-06-19T14:30:00.000Z stop_index: 0 required: true responses: "201": description: Event successfully created "404": description: Shipment not found "409": description: Load status transition not allowed. "422": description: Payload is invalid and the event can't be created content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. tags: - Shipment Events get: summary: List shipment events. description: List shipment events. security: - User-JWT: - shipment_read parameters: - in: path name: shipment_id required: true schema: description: Shipment or Load UUID type: string format: uuid - in: query name: offset schema: description: The initial item number, starting at 0 (zero) type: integer format: int32 - in: query name: limit schema: description: The number of items per page type: integer format: int32 - in: query name: type schema: description: A filter by the event type type: string responses: "200": description: Success content: application/json: schema: type: object properties: data: type: array description: An array of events items: oneOf: - type: object title: shipment:appointment-pickup properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: appointment: type: object description: The date and time interval of the appointment and its confirmation flag properties: start: type: date-time description: Appointment start timestamp end: type: date-time description: Appointment end timestamp confirmed: deprecated: true type: boolean description: Will always be true event_date: deprecated: true format: date-time description: The date and time of the event stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. reason: type: string description: The reason for changing the appointment enum: - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - driver_not_available - insufficient_pickup_time - load_shifted - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - other - other_carrier_related - past_cut_off_time - refused_by_customer - road_conditions - shipment_overweight - shipper_related - suspended_at_customer_request - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - waiting_shipping_instruction shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:appointment-delivery properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: appointment: type: object description: The date and time interval of the appointment and its confirmation flag properties: start: type: date-time description: Appointment start timestamp end: type: date-time description: Appointment end timestamp confirmed: type: boolean description: Appointment confirmation event_date: deprecated: true format: date-time description: The date and time of the event stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. reason: type: string description: The reason for changing the appointment enum: - address_corrected_delivery_attempted - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - driver_not_available - held_per_shipper - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - other - other_carrier_related - past_cut_off_time - recipient_unavailable_delivery_delayed - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - suspended_at_customer_request - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - waiting_shipping_instructions shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:en-route-to-pickup properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:check-in-pickup properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. is_late: type: boolean description: Indicate if the check in/out event is late. late_reason: description: Indicate the reason which caused the delay. nullable: true enum: - accident - address_corrected_delivery_attempted - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - customer_wanted_earlier_delivery - driver_not_available - driver_related - held_per_shipper - hold_due_customs_documentation_problems - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - past_cut_off_time - previous_stop - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product is_last_stop: type: boolean description: Indicate if the stop is the last one. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:check-out-pickup properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. is_late: type: boolean description: Indicate if the check in/out event is late. late_reason: description: Indicate the reason which caused the delay. nullable: true enum: - accident - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - consignee_related - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_per_shipper - hold_due_customs_documentation_problems - improper_unloading_facility_or_equipment - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - past_cut_off_time - previous_stop - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - waiting_shipping_instructions is_last_stop: type: boolean description: Indicate if the stop is the last one. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:check-in-delivery properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. is_late: type: boolean description: Indicate if the check in/out event is late. late_reason: description: Indicate the reason which caused the delay. nullable: true enum: - accident - address_corrected_delivery_attempted - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - customer_wanted_earlier_delivery - driver_not_available - driver_related - held_per_shipper - hold_due_customs_documentation_problems - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - past_cut_off_time - previous_stop - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product is_last_stop: type: boolean description: Indicate if the stop is the last one. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:check-out-delivery properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. is_late: type: boolean description: Indicate if the check in/out event is late. late_reason: description: Indicate the reason which caused the delay. nullable: true enum: - accident - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - consignee_related - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_per_shipper - hold_due_customs_documentation_problems - improper_unloading_facility_or_equipment - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - past_cut_off_time - previous_stop - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - waiting_shipping_instructions is_last_stop: type: boolean description: Indicate if the stop is the last one. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: "[DEPRECATED] shipment:pickup-late" properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: "[DEPRECATED] shipment:delivery-late" properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:carrier-updated properties: details: type: object properties: carrier: type: object properties: id: type: string format: uuid name: type: string maxLength: 255 mc_number: type: string maxLength: 255 nullable: true dot_number: type: string maxLength: 255 nullable: true tractor_number: type: string maxLength: 70 nullable: true trailer_number: type: string maxLength: 70 nullable: true shipment: type: object properties: loadsmart_ref_number: type: string description: Internal identifier ref_number: type: string description: Reference number shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:carrier-dropped properties: details: type: object nullable: true shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:location-updated properties: details: type: object properties: shipment: type: object properties: loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: properties: latitude: type: number format: float description: The location latitude nullable: true longitude: type: number format: float description: The location longitude nullable: true city: type: string description: City name of the last tracked location minLength: 1 maxLength: 40 state: type: string description: State of the last tracked location minLength: 2 maxLength: 2 country: type: string description: Country of the last tracked location. Based on ISO 3166 - Alpha 3 code minLength: 3 maxLength: 3 direction: type: string enum: - NE - SE - NW - SW event_date: type: string format: date-time description: The date and time the carrier was tracked, using actual time if not informed. eta: type: string format: date-time description: The estimated time of arrival. late_reason: description: Indicate the reason which caused the delay. nullable: true enum: - accident - carrier_dispatch_error - carrier_keying_error - closed_holiday - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - hold_due_customs_documentation_problems - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_delivery - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - previous_stop - reconsigned - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - unable_locate - waiting_inspection shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:driver-assigned properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: sender_id: type: string nullable: true receiver_id: type: string nullable: true driver: type: object properties: id: type: string format: uuid name: type: string maxLength: 255 phone_number: type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:driver-unassigned properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: sender_id: type: string nullable: true receiver_id: type: string nullable: true shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:canceled properties: details: type: object properties: reason: type: string enum: - shipper - carrier - loadsmart - other details: type: string shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:incident properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object title: shipment:incident properties: type: type: string description: The type of the incident enum: - detention_loading - detention_unloading - truck_breakdown - driver_late_shipper - driver_late_receiver - TONU - transit_check - OSD - misc - lumper - no_contact_with_dispatcher - no_contact_with_driver - driver_risk_miss_appointment - rejected_load - truck_overweight - other reason: type: string description: The reason which caused the incident enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions eta: type: string format: date-time description: A new ETA after the incident notes: type: string description: Any additional information required: - type shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:invoice properties: details: type: object properties: event: type: object properties: invoice_number: type: string description: The invoice identifier number weight: type: integer description: The shipment weight lading_quantity: type: integer description: The amount of lading in the shipment invoice_date: type: string format: date-time description: The date and time of the invoice pu_appointment: type: string format: date-time description: The pickup appointment date and time pu_checkin: type: string format: date-time description: The check in at pickup date and time pu_checkout: type: string format: date-time description: The check out from pickup date and time del_appointment: type: string format: date-time description: The delivery appointment date and time del_checkin: type: string format: date-time description: The check in at delivery date and time del_checkout: type: string format: date-time description: The check out from delivery date and time total_invoice_amount: type: number description: The total amount of the invoice bill_to: deprecated: true type: object description: Address information for where to bill the shipment properties: company_name: type: string description: Company name address1: type: string description: Address line 1 address2: type: string description: Address line 2 city: type: string description: City zipcode: type: string description: Zipcode state: type: string description: State (e.g. MI, FL...) country: type: string description: Country (e.g. USA, CAN...) lines: type: array description: A list of all the invoice items items: type: object properties: item_no: type: string description: The type of the item enum: - all_in_rate - accessorial - detention - lumper_fee - tonu - layover - stop_off - rate_adjustment - claim - other - quickpay - demurrage - fuel_surcharge description: type: string description: A description of the item unit_price: type: number description: The price of the item stop_index: type: integer nullable: true description: Indicate the stop number, being 0-based for pickup shipment: type: object properties: bol_number: type: string description: Bill of Lading number commodity: type: string description: The shipment commodity id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier miles: type: double description: Total miles between origin and destination purchase_order_number: type: string description: Purchase order number purchase_order_numbers: type: array description: A list of all shipment's purchase order numbers items: type: string ref_number: type: string description: Reference number stops: type: array description: A list of all shipment stops items: type: object properties: address: type: string description: Stop address city: type: string description: Stop city country: type: string description: Stop country. Ex. USA stop_customer_ref: type: string description: Shipper identifier for the stop company_name: type: string description: Company name stop_index: type: integer description: Indicate the stop number, being 0-based for pickup state: type: string description: Stop state type: type: string description: Stop type enum: - pickup - delivery zipcode: type: string description: Stop zipcode facility: description: Facility information properties: company_name: type: string description: Facility's company name ref: type: string description: Facility's identifier number address: type: string description: Facility's address city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string tractor_number: type: string description: Tractor number trailer_number: type: string description: Trailer number properties: type: object description: Shipment misc properties bill_to: type: object description: Address information for where to bill the shipment properties: company_name: type: string description: Company name address1: type: string description: Address line 1 address2: type: string description: Address line 2 city: type: string description: City zipcode: type: string description: Zipcode state: type: string description: State (e.g. MI, FL...) country: type: string description: Country (e.g. USA, CAN...) contracted: type: boolean description: True whether the shipment was booked through a contract with the Shipper shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:created properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions event: type: object title: shipment:created shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:updated properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. stops: type: array minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string event: type: object title: shipment:updated shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type previous: type: string description: The url for the previous page nullable: true next: type: string description: The url for the next page nullable: true count: type: integer description: The total of events for the shipment example: data: - type: shipment:en-route-to-pickup shipment_id: ad5aa25c-3e20-4de8-aeba-3a71d3c3242c created_at: 2018-06-19T10:30:00.000Z details: event_date: 2018-06-10T09:00:00.000Z stop_index: 0 - type: shipment:driver-assigned shipment_id: ad5aa25c-3e20-4de8-aeba-3a71d3c3242c created_at: 2018-06-19T14:30:00.000Z details: driver: id: eb68a884-0c00-40bb-89e1-629e7397f90f name: David previous: https://api.sandbox.loadsmart.com/api/v2/shipments/ad5aa25c-3e20-4de8-aeba-3a71d3c3242c/events?limit=2 next: null count: 20 "403": description: Permission denied content: application/json: schema: type: object properties: error: type: string error_description: type: string example: error: permission_denied error_description: You do not have permission to perform this action. "404": description: Shipment not found tags: - Shipment Events "/api/v2/shipments/{shipment_id}/action-logs": post: summary: Create shipment action log entry description: | Appends an action to the shipment's action log. security: - Application-JWT: - shipment_action_log parameters: - in: path name: shipment_id required: true schema: description: Shipment or Load UUID type: string format: uuid requestBody: required: true content: application/json: schema: type: object description: | Request body to create a shipment action log entry. The `action` text is combined with the caller's client name when persisted. properties: action: type: string maxLength: 255 description: Action text to record for this shipment (max 255 characters). required: - action example: action: Manual gate check completed at pickup responses: "201": description: Action log entry was created "403": description: Permission denied content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: forbiden_access error_description: An user is trying to access a not authorized resource. "404": description: Shipment not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found "422": description: | Shipment is not eligible for action logs. content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. tags: - Shipments "/api/v2/shipments/{shipment_id}/stops/{stop_id}/confirm_appointment": put: summary: Confirm stop appointment tags: - Shipment Stops description: Confirm the time and date of the appointment for the stop security: - Application-JWT: - shipment_write parameters: - in: path name: shipment_id required: true schema: description: Shipment UUID type: string format: uuid - in: path name: stop_id required: true schema: description: Stop UUID type: string format: uuid requestBody: content: application/json: schema: type: object properties: confirmed: description: If it is confirmed type: boolean window_start: description: A datetime that represents the start of a time window for this appointment. In UTC time. type: string format: date-time window_end: description: A datetime that represents the end of a time window for this appointment. In UTC time. type: string format: date-time scheduler_appt_id: description: An ID that represents this appointment. type: string format: uuid confirmation_number: description: A number that identifies this appointment. type: string contact_name: description: The contact name responsible for this appointment. type: string example: confirmed: true window_start: 2020-02-14T08:00:00.000Z window_end: 2020-02-14T09:00:00.000Z scheduler_appt_id: 029a8462-a04e-4ad8-80d8-e6978db2fb55 confirmation_number: 123456789 contact_name: Joe Smith required: true responses: "200": description: Success content: application/json: schema: type: object properties: data: type: object properties: confirmed: description: If it is confirmed type: boolean window_start: description: A datetime that represents the start of a time window for this appointment. In UTC time. type: string format: date-time window_end: description: A datetime that represents the end of a time window for this appointment. In UTC time. type: string format: date-time scheduler_appt_id: description: An ID that represents this appointment. type: string format: uuid confirmation_number: description: A number that identifies this appointment. type: string contact_name: description: The contact name responsible for this appointment. type: string example: confirmed: true window_start: 2020-02-14T08:00:00.000Z window_end: 2020-02-14T09:00:00.000Z scheduler_appt_id: 029a8462-a04e-4ad8-80d8-e6978db2fb55 confirmation_number: 123456789 contact_name: Joe Smith "404": description: Shipment or stop not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found "422": description: Payload is invalid and the confirmation can't be made content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. /api/v2/shipment-documents: post: summary: Create shipment document description: Send a shipment document for audit it can be a proof of delivery, carrier invoice or any other document. tags: - Shipments security: - User-JWT: - submitted_shipment_document_write requestBody: required: true content: multipart/form-data: schema: type: object properties: shipment: type: string description: The shipment UUID or Loadsmart ref number. file_obj: type: binary description: The shipment pdf file. file_name: type: string description: The file name. type: type: string description: The file type. enum: - carrier-invoice - proof-of-delivery - other required: - shipment - file_obj - file_name - type example: shipment: ac483d72-83c5-41cd-97bf-ce94517e7bc5 file_obj: (binary) file_name: 9444666.pdf type: carrier-invoice responses: "201": description: Shipment document successfully created. "403": description: Logged carrier is incorrect. content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: forbiden_access error_description: An user is trying to access a not authorized resource. "422": description: Payload is invalid and the document wasn't created for the shipment content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. "/api/v2/shipment-documents/?shipment=${shipment}": get: summary: List shipment documents description: List of shipment documents sent via shipment-documents. tags: - Shipments security: - User-JWT: - submitted_shipment_document_read parameters: - in: path name: shipment_uuid_or_loadsmart_ref_number required: true schema: description: Shipment's UUID or internal ref number in Loadsmart type: string responses: "200": description: Success list of shipment documents sent via shipment-documents. content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: integer description: Unique identifier for the document. shipment: type: string description: shipment UUID. shipment_loadsmart_ref_number: type: string description: shipment's internal ref number in Loadsmart. created_at: type: string description: Datetime when the document was created. format: date-time type: type: enum description: Document type. file_name: type: string description: File name for document sent. url: type: enum description: Url with a expiration time for the document. example: data: - id: "444" created_at: 2024-01-01T00:00:00Z shipment: ac483d72-83c5-41cd-97bf-ce94517e7bc5 shipment_loadsmart_ref_number: "9444666" type: carrier-invoice file_name: 9444666.pdf url: https://my.com/submitted-shipment-documents/9444666/carrier-invoice/9444666.pdf "403": description: Logged carrier is incorrect. content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: forbiden_access error_description: An user is trying to access a not authorized resource. /api/v2/quotes-request: post: summary: Create quote request description: | Request quotes for a future shipment. Returns a unique identifier (`id`) for the quote request. After creating the quote request, the [Retrieve details from a quote request](#tag/Quotes/paths/~1api~1v2~1quotes-request~1{uuid}/get) endpoint must be polled in order to retrieve the result of this quote request. security: - User-JWT: - quote_write requestBody: required: true content: application/json: schema: type: object properties: shipment_mode: allOf: - type: array items: type: object properties: type: type: string default: FTL enum: - FTL - LTL - PTL - RAIL description: | The transportation mode of the load. Allowed values are: - FTL: Full Truckload - LTL: Less-than-Truckload - PTL: Partial Truckload - RAIL: Intermodal rail (53' containers) x-external: true equipments: allOf: - type: array items: type: object properties: type: type: string enum: - DRV - FBE - RFR - IMC description: | Equipment required to transport the shipment. Recognized equipments are: - DRV: Dry Van - FBE: Flatbed - RFR: Reefer - IMC: Intermodal maxItems: 1 minItems: 1 x-external: true total_width: type: number description: The load total width expressed in 'ft' minimum: 0 total_length: type: number description: The load total length expressed in 'ft' minimum: 0 total_height: type: number description: The load total height expressed in 'ft' minimum: 0 requirements: nullable: true type: object description: Requirements that needs to be fulfilled in order to transport the load properties: hazmat: type: boolean description: The commodity being moved consists of hazard material tarp: type: object description: If present in 'requirements', it means the shipment needs a tarp properties: size: type: number format: float minimum: 0 description: size in expressed in 'ft' type: type: string enum: - lumber - steel - smoke - parachute - machinery - canvas - hay - poly required: - size dunnage: type: boolean description: Extra rack added to the truck beer: type: boolean description: The carrier must be able to transport alcohool teams: type: boolean description: If it requires a team of drivers customer_reference: type: string maxLength: 255 description: Internal client's reference, such as an ID, of the load accessorials: type: array description: Accessorials are extra charges/services that exist outside the 'normal' standard operating procedure. They are upcharged by the Carriers, and are qualifiers for Carrier Eligibility. FTL loads do not accept accessorials on the quote request. items: type: string enum: - protect_from_freeze - lift-gate-pickup - residential-pickup - inside-pickup - tradeshow_pickup - limited-access-pickup - construction-site-pickup - non-commercial-pickup-storage-facility - appointment-pickup - notify-prior-to-arrival-delivery - lift-gate-delivery - residential-delivery - inside-delivery - limited-access-delivery - non-commercial-delivery-storage-facility - tradeshow_delivery - construction-site-delivery - appointment-delivery - sort-and-segregate - notify-prior-to-arrival stops: type: array description: Points of interest where the truck makes a stop to either pickup or deliver a shipment. Usually a quote has one pickup stop and one delivery stop, but in some cases there will be multiple delivery stops. items: oneOf: - type: object title: Zipcode; Window properties: type: type: string enum: - PU - DEL description: The type of the stop, can be PU (Pickup) or DEL (Delivery) address: type: string zipcode: type: string country: type: string pattern: ^[A-Z]{3}$ description: 3-letter country code, uppercase (ISO 3166-1 alpha-3) drop_trailer: type: boolean description: Indicates whether the truck will drop the trailer at the stop window: type: object description: | A time window indicating when the truck should be at the stop. If the stop date is not defined in the request payload, the API will estimate it based on the trip duration. This will only occur when: i) pickup date is undefined and all delivery dates are defined ii) pickup date is defined and any delivery date is undefined. If a request does not define all stop dates and does not comply with i or ii, then a validation error will be returned properties: start: type: string format: date-time end: type: string format: date-time required: - start - end required: - zipcode - country - type: object title: City & State; Window properties: type: type: string enum: - PU - DEL description: The type of the stop, can be PU (Pickup) or DEL (Delivery) address: type: string city: type: string state: type: string country: type: string pattern: ^[A-Z]{3}$ description: 3-letter country code, uppercase (ISO 3166-1 alpha-3) window: type: object description: | A time window indicating when the truck should be at the stop. If the stop date is not defined in the request payload, the API will estimate it based on the trip duration. This will only occur when: i) pickup date is undefined and all delivery dates are defined ii) pickup date is defined and any delivery date is undefined. If a request does not define all stop dates and does not comply with i or ii, then a validation error will be returned properties: start: type: string format: date-time end: type: string format: date-time required: - start - end drop_trailer: type: boolean description: Indicates whether the truck will drop the trailer at the stop accessorials: type: array items: type: string enum: - protect_from_freeze - lift-gate-pickup - residential-pickup - inside-pickup - tradeshow_pickup - limited-access-pickup - construction-site-pickup - non-commercial-pickup-storage-facility - appointment-pickup - notify-prior-to-arrival-delivery - lift-gate-delivery - residential-delivery - inside-delivery - limited-access-delivery - non-commercial-delivery-storage-facility - tradeshow_delivery - construction-site-delivery - appointment-delivery - sort-and-segregate - notify-prior-to-arrival required: - city - state - country - window - type: object title: Zipcode; Window Start properties: type: type: string enum: - PU - DEL description: The type of the stop, can be PU (Pickup) or DEL (Delivery) address: type: string zipcode: type: string country: type: string pattern: ^[A-Z]{3}$ description: 3-letter country code, uppercase (ISO 3166-1 alpha-3) date: type: string format: date description: A date indicating when the truck should be at the stop. window_start: type: string format: date-time description: A date-time indicating when the truck should be at the stop. This field is required for the pickup stop if "window" is not provided. The next stops can use "date". drop_trailer: type: boolean description: Indicates whether the truck will drop the trailer at the stop accessorials: type: array items: type: string enum: - protect_from_freeze - lift-gate-pickup - residential-pickup - inside-pickup - tradeshow_pickup - limited-access-pickup - construction-site-pickup - non-commercial-pickup-storage-facility - appointment-pickup - notify-prior-to-arrival-delivery - lift-gate-delivery - residential-delivery - inside-delivery - limited-access-delivery - non-commercial-delivery-storage-facility - tradeshow_delivery - construction-site-delivery - appointment-delivery - sort-and-segregate - notify-prior-to-arrival required: - zipcode - country - window_start - type: object title: City & State; Window Start properties: type: type: string enum: - PU - DEL description: The type of the stop, can be PU (Pickup) or DEL (Delivery) address: type: string city: type: string state: type: string country: type: string pattern: ^[A-Z]{3}$ description: 3-letter country code, uppercase (ISO 3166-1 alpha-3) date: type: string format: date description: A date indicating when the truck should be at the stop. window_start: type: string format: date-time description: A date-time indicating when the truck should be at the stop. This field is required for the pickup stop if "window" is not provided. The next stops can use "date". drop_trailer: type: boolean description: Indicates whether the truck will drop the trailer at the stop accessorials: type: array items: type: string enum: - protect_from_freeze - lift-gate-pickup - residential-pickup - inside-pickup - tradeshow_pickup - limited-access-pickup - construction-site-pickup - non-commercial-pickup-storage-facility - appointment-pickup - notify-prior-to-arrival-delivery - lift-gate-delivery - residential-delivery - inside-delivery - limited-access-delivery - non-commercial-delivery-storage-facility - tradeshow_delivery - construction-site-delivery - appointment-delivery - sort-and-segregate - notify-prior-to-arrival required: - city - state - country - window_start minItems: 2 items: type: array description: A list of actual packages that will be moved within the load. One quote - that later will become a shipment - may have none or many Items. These Items will have a lot of different attributes related to it, but specially Dimensions, Weight, Freight Class among some others items: type: object properties: items_count: oneOf: - type: number - type: string description: How many of this specific item we will have. This is not the quantity of records in the database. length: oneOf: - type: number - type: string description: Length of the shipping item width: oneOf: - type: number - type: string description: Width of the shipping item height: oneOf: - type: number - type: string description: Height of the shipping item classification: type: string description: Classification representing the Class of the shipping item enum: - "50" - "55" - "60" - "65" - "70" - "77.5" - "85" - "92.5" - "100" - "110" - "125" - "150" - "175" - "200" - "250" - "300" - "400" - "500" nmfc_code: type: string description: The NMFC Number associated with the shipping item package_type: type: string description: Package type enum: - std_pallets - pallets_non_std - bags - bales - boxes - bunches - carpets - coils - crates - cylinders - drums - pails - reels - rolls - tubes_pipes - loose - ubox hazmat: type: boolean description: The commodity being moved consists of hazard material hazmat_class: type: string description: Hazmat class enum: - explosive_non_specified - mass_explosive - projection_explosive - minor_fire_explosive - minor_explosive - insensitive_mass_explosive - insensitive_minor_explosive - gas_non_specified - flammable_gas - non_flammable_non_poisonous_or_oxygen_gas - poison_gas - flammable_liquid - solid_non_specified - flammable_solid - spontaneously_combustible_solid - dangerous_when_wet - oxidizer_non_specified - oxidizer - organic_peroxide - poison - radioactive un_number: type: string description: UN numbers are four-digit numbers that identify hazardous materials, and articles in the framework of international transport. stackable: type: boolean description: Indicates if the item is stackable on the truck description: type: string maxLength: 255 description: Name of the commodity that will be shipped weight: oneOf: - type: number - type: string description: | The total weight, in pounds, of the shipment. Acceptable values must be positive numbers with up to 2 decimal digits. Any other type will cause a validation error. Note that the minimum value is 1 and the maximum value depends on the chosen equipment_type: 45000 for DRV, 43000 for RFR and 50000 for FBE. If the weight is not provided, it is set to the maximum allowed for the equipment_type. minimum: 1 maximum: 50000 required: - items_count - length - width - height - classification - description - package_type - hazmat - stackable - weight properties: {} properties: type: object description: | General information about the load. This is an open JSON field that allows passing special properties with meaning on the customer context, such as the order numbers, must_arrive_by_date, priority and others. required: - shipment_mode - equipments - stops examples: Request: value: shipment_mode: - LTL equipments: - type: DRV - type: FBE customer_reference: a reference for the quote total_height: 10.5 total_length: 52 total_width: 7 requirements: hazmat: false stops: - type: PU address: 12345 E 16th avenue city: Miami Beach state: FL drop_trailer: true zipcode: "33140" country: USA window: start: 2018-06-20T09:00:00 end: 2018-06-20T11:00:00 accessorials: - sort-and-segregate - inside-pickup - type: DEL address: 54321 E 16th avenue city: New York state: NY drop_trailer: false zipcode: "33140" country: USA items: - items_count: 1 length: 12 width: 18 height: 24 classification: "80" nmfc_code: 19874 package_type: std_pallets hazmat: true hazmat_class: mass_explosive un_number: 1485 stackable: false description: apples weight: 20000 responses: "202": description: Quote request was accepted content: application/json: schema: type: object properties: data: type: object properties: id: type: string description: A unique identifier for the quote request required: - id required: - data examples: AcceptedQuote: value: data: id: 3802fab9-bcbe-42b4-9132-2e0a65c11e1d RejectedQuote: value: data: id: 3802fab9-bcbe-42b4-9132-2e0a65c11e1d "422": description: Invalid or missing data content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. tags: - Quotes "/api/v2/quotes-request/{uuid}": get: summary: Retrieve details from a quote request description: | A quote can either be `available`, `rejected`, `expired` or `booked`. If it's available, a price and expiration date will be returned. In the case the quote is rejected, the reason will be detailed in the response. Rejections could be a temporary condition. Retrying the request may or may not provide the caller with an available quote. #### List of possible reject reasons **Note**: we constantly add and remove reject reasons from this list. To make sure the client will continue to work properly in case a new reject reason is added, you can use the message on `reject_description` field to show to users what happened. * forbidden-date: Date is valid but not allowed * price-unavailable: Could not get price * shipper-over-capacity: Shipper over Capacity * lane-not-permitted: Lane not Permitted * shipper-daily-quotes-over-capacity: Shipper daily quotes over capacity * mileage-unavailable: Could not get mileage * next-day-shipment-not-allow: Next day quotes are not allowed * inactive-shipper-daily-quotes-over-capacity: Inactive shipper daily quotes over capacity * weekend-pickup-not-allowed: Pickups are not allowed to happen on weekends * same-day-shipment-not-allow: Same day quote is not allowed * market-size-too-large: Market Size too Large * flatbed-not-allowed: Flatbed not allowed * shipper-profile-is-incomplete: Shipper profile is incomplete tags: - Quotes security: - User-JWT: - quote_write parameters: - in: path name: uuid schema: description: Unique Quote Request identifier type: string format: uuid required: true responses: "200": description: Success content: application/json: schema: type: object properties: data: type: object properties: id: type: string format: uuid status: type: string reject_reason: type: string mileage: type: number quotes: type: array items: type: object properties: quote_id: type: string maxLength: 40 description: Reference for the quote that should be used to book the load asset_carrier_quote_id: type: string maxLength: 64 description: Reference for the asset carrier quote. expires_at: type: datetime status: enum: - pending - available - rejected shipment_mode: type: array items: type: string default: FTL enum: - FTL - LTL - PTL - RAIL description: | The transportation mode of the load. Allowed values are: - FTL: Full Truckload - LTL: Less-than-Truckload - PTL: Partial Truckload - RAIL: Intermodal rail (53' containers) customer_reference: type: string maxLength: 255 description: Internal client's reference, such as an ID, of the quote service_level: type: string maxLength: 255 description: A guarantee given by the carrier of deliverying the load on the specified time. Often a higher service level means a higher price carriers: type: array items: type: object properties: name: type: string uuid: type: string format: uuid priority: type: string enum: - favorited - restricted - neutral scac: type: string maxLength: 4 description: Standard Carrier Alpha Code (for `LTL`/`VLTL` quotes only) price: type: object properties: total: type: number components: type: array items: type: object properties: type: type: string price: type: number equipment: type: string enum: - DRV - FBE - RFR description: The type of truck used to transport the shipment. Allowed values are DRV (dry van), FBE (flatbed) and RFR (reefer) stops: type: array description: Points of interest where the truck makes a stop to either pickup or deliver a shipment. Usually a quote has one pickup stop and one delivery stop, but in some cases there will be multiple delivery stops. items: oneOf: - type: object title: Zipcode properties: type: type: string enum: - PU - DEL description: The type of the stop, can be PU (Pickup) or DEL (Delivery) facility_name: type: string description: Name of the facility at this stop contacts: type: array items: type: object properties: name: type: string description: Name of the person who is the contact at this stop maxLength: 255 email: type: string format: email description: Email of the contact. Required if no phone number is provided maxLength: 254 phone_number: description: Phone number of the contact. Required if email is provided type: string pattern: \+\d{4,15} maxLength: 16 required: - name city: type: string state: type: string address: type: string country: type: string zipcode: type: string pattern: ^[A-Z]{3}$ description: 3-letter country code, uppercase (ISO 3166-1 alpha-3) window: type: array items: type: object properties: start: type: string format: naive date-time description: A window start indicating the start local time of the truck at the stop (required for first stop) end: type: string format: naive date-time description: A window end indicating the end local time of the truck stop at the stop instructions: type: string description: Instructions for the driver required: - zipcode - country - window_start - type: object title: City & State properties: type: type: string enum: - PU - DEL description: The type of the stop, can be PU (Pickup) or DEL (Delivery) facility_name: type: string description: Name of the facility at this stop contacts: type: array items: type: object properties: name: type: string description: Name of the person who is the contact at this stop maxLength: 255 email: type: string format: email description: Email of the contact. Required if no phone number is provided maxLength: 254 phone_number: description: Phone number of the contact. Required if email is provided type: string pattern: \+\d{4,15} maxLength: 16 required: - name city: type: string state: type: string address: type: string country: type: string zipcode: type: string pattern: ^[A-Z]{3}$ description: 3-letter country code, uppercase (ISO 3166-1 alpha-3) window_start: description: A window start indicating the start local time of the truck at the stop (required for first stop) type: string format: naive date-time window_end: description: A window end indicating the end local time of the truck stop at the stop type: string format: naive date-time instructions: type: string description: Instructions for the driver required: - city - state - country - window_start - window_end required: - id - status items: type: array items: type: object properties: items_count: oneOf: - type: number - type: string description: How many of this specific item we will have. This is not the quantity of records in the database. length: oneOf: - type: number - type: string description: Length of the shipping item width: oneOf: - type: number - type: string description: Width of the shipping item height: oneOf: - type: number - type: string description: Height of the shipping item classification: type: string description: Classification representing the Class of the shipping item enum: - "50" - "55" - "60" - "65" - "70" - "77.5" - "85" - "92.5" - "100" - "110" - "125" - "150" - "175" - "200" - "250" - "300" - "400" - "500" nmfc_code: type: string description: The NMFC Number associated with the shipping item package_type: type: string description: Package type enum: - std_pallets - pallets_non_std - bags - bales - boxes - bunches - carpets - coils - crates - cylinders - drums - pails - reels - rolls - tubes_pipes - loose - ubox hazmat: type: boolean description: The commodity being moved consists of hazard material hazmat_class: type: string description: Hazmat class enum: - explosive_non_specified - mass_explosive - projection_explosive - minor_fire_explosive - minor_explosive - insensitive_mass_explosive - insensitive_minor_explosive - gas_non_specified - flammable_gas - non_flammable_non_poisonous_or_oxygen_gas - poison_gas - flammable_liquid - solid_non_specified - flammable_solid - spontaneously_combustible_solid - dangerous_when_wet - oxidizer_non_specified - oxidizer - organic_peroxide - poison - radioactive un_number: type: string description: UN numbers are four-digit numbers that identify hazardous materials, and articles in the framework of international transport. stackable: type: boolean description: Indicates if the item is stackable on the truck description: type: string maxLength: 255 description: Name of the commodity that will be shipped weight: oneOf: - type: number - type: string description: | The total weight, in pounds, of the shipment. Acceptable values must be positive numbers with up to 2 decimal digits. Any other type will cause a validation error. Note that the minimum value is 1 and the maximum value depends on the chosen equipment_type: 45000 for DRV, 43000 for RFR and 50000 for FBE. If the weight is not provided, it is set to the maximum allowed for the equipment_type. minimum: 1 maximum: 50000 required: - items_count - length - width - height - classification - description - package_type - hazmat - stackable - weight stops: type: array items: oneOf: - type: object title: Zipcode properties: type: type: string enum: - PU - DEL description: The type of the stop, can be PU (Pickup) or DEL (Delivery) facility_name: type: string description: Name of the facility at this stop contacts: type: array items: type: object properties: name: type: string description: Name of the person who is the contact at this stop maxLength: 255 email: type: string format: email description: Email of the contact. Required if no phone number is provided maxLength: 254 phone_number: description: Phone number of the contact. Required if email is provided type: string pattern: \+\d{4,15} maxLength: 16 required: - name city: type: string state: type: string address: type: string country: type: string zipcode: type: string pattern: ^[A-Z]{3}$ description: 3-letter country code, uppercase (ISO 3166-1 alpha-3) window: type: array items: type: object properties: start: type: string format: naive date-time description: A window start indicating the start local time of the truck at the stop (required for first stop) end: type: string format: naive date-time description: A window end indicating the end local time of the truck stop at the stop instructions: type: string description: Instructions for the driver required: - zipcode - country - window_start - type: object title: City & State properties: type: type: string enum: - PU - DEL description: The type of the stop, can be PU (Pickup) or DEL (Delivery) facility_name: type: string description: Name of the facility at this stop contacts: type: array items: type: object properties: name: type: string description: Name of the person who is the contact at this stop maxLength: 255 email: type: string format: email description: Email of the contact. Required if no phone number is provided maxLength: 254 phone_number: description: Phone number of the contact. Required if email is provided type: string pattern: \+\d{4,15} maxLength: 16 required: - name city: type: string state: type: string address: type: string country: type: string zipcode: type: string pattern: ^[A-Z]{3}$ description: 3-letter country code, uppercase (ISO 3166-1 alpha-3) window_start: description: A window start indicating the start local time of the truck at the stop (required for first stop) type: string format: naive date-time window_end: description: A window end indicating the end local time of the truck stop at the stop type: string format: naive date-time instructions: type: string description: Instructions for the driver required: - city - state - country - window_start - window_end suggested_mode: type: string enum: - LTL - PTL - FTL equipments: type: array items: type: object properties: type: type: string enum: - DRV - FBE - RFR - CON - CUR - DDP - IMC - SDK - STK - BLK - TNK - OTH description: | Equipment required to transport the shipment. Recognized equipments are: - DRV: Dry Van - FBE: Flatbed - RFR: Reefer - CON: Conestoga - CUR: Curtainside - DDP: Double Drop - IMC: Intermodal - SDK: Step Deck - STK: Straight truck - BLK: Bulk - TNK: Tanker - OTH: Other equipment not explicited listed total_width: type: number description: The load total width expressed in 'ft' minimum: 0 total_length: type: number description: The load total length expressed in 'ft' minimum: 0 total_height: type: number description: The load total height expressed in 'ft' minimum: 0 requirements: nullable: true type: object description: Requirements that needs to be fulfilled in order to transport the load properties: hazmat: type: boolean description: The commodity being moved consists of hazard material tarp: type: object description: If present in 'requirements', it means the shipment needs a tarp properties: size: type: number format: float minimum: 0 description: size in expressed in 'ft' type: type: string enum: - lumber - steel - smoke - parachute - machinery - canvas - hay - poly required: - size dunnage: type: boolean description: Extra rack added to the truck beer: type: boolean description: The carrier must be able to transport alcohool teams: type: boolean description: If it requires a team of drivers required: - data example: data: id: 3802fab9-bcbe-42b4-9132-2e0a65c11e1d status: available reject_reason: null mileage: 1453 suggested_mode: LTL equipments: - type: DRV quotes: - quote_id: quote_a844d1dfef1bed1ba777 asset_carrier_quote_id: JDHFK832748 expires_at: 2018-10-26T17:00:00Z status: available shipment_mode: LTL service_level: Standard customer_reference: AB123CD carriers: - name: ABC Freight uuid: c4e81940-fd8e-44ff-81f0-6d178489db0d priority: neutral scac: ABCF price: total: 1543.45 components: - type: haul price: 1543.45 equipment: type: DRV stops: - type: PU facility_name: Brothers & Sons Inc. contacts: - name: John Doe email: john@example.com phone_number: "+17895551234" city: Miami Beach state: FL address: 12345 E 16th avenue country: USA zipcode: 33139 window: start: 2020-06-20T09:00:00 end: 2020-06-20T11:00:00 instructions: Driver must arrive on time. These instructions will be sent to driver. - type": DEL facility_name: Space Ghost Coast to Coast Inc. contacts: - name: Space Ghost email: space@ghost.com phone_number: "+17124832133" city: New York state: NY address: 54321 E 16th avenue country: USA zipcode: 10010 window: start: 2020-06-21T16:00:00 end: 2020-06-21T18:00:00 - quote_id: quote_bd030c027543ffe032dd asset_carrier_quote_id: F1CT10N4L1D228 expires_at: 2018-10-26T17:00:00Z status: available shipment_mode: LTL service_level: Guaranteed by 3PM customer_reference: 88ACA02 carriers: - name: Fictional Freight uuid: 956dcd70-95cd-419a-af5c-96d394d8ee53 priority: restricted price: total: 1876.9 components: - type: haul price: 1726.9 - type: fuel_surcharge price: 150 equipment: type: DRV stops: - type: PU facility_name: Brothers & Sons Inc. items: - items_count: 1 length: 12 width: 18 height: 24 classification: "70" nmfc_code: 19874 package_type: std_pallets hazmat: true hazmat_class: mass_explosive un_number: 1485 stackable: false description: apples weight: 20000 contacts: - name: John Doe email: john@example.com phone_number: "+17895551234" city: Miami Beach state: FL address: 12345 E 16th avenue country: USA zipcode: 33139 window: start: 2020-06-20T09:00:00 end: 2020-06-20T11:00:00 instructions: Driver must arrive on time. These instructions will be sent to driver. - type": DEL facility_name: Space Ghost Coast to Coast Inc. contacts: - name: Space Ghost email: space@ghost.com phone_number: "+17124832133" city: New York state: NY address: 321 E 7th avenue country: USA zipcode: 10010 window: start: 2020-06-22T16:00:00 end: 2020-06-22T18:00:00 instructions: No special instructions here. items: - items_count: 1 length: 12 width: 18 height: 24 classification: "80" nmfc_code: 19874 package_type: std_pallets hazmat: true hazmat_class: mass_explosive un_number: 1485 stackable: false description: apples weight: 20000 stops: - type: PU address: 12345 E 16th avenue city: Miami Beach state: FL drop_trailer: true zipcode: "33140" country: USA window: start: 2018-06-20T09:00:00 end: 2018-06-20T11:00:00 accessorials: - sort-and-segregate - inside-pickup - type: DEL address: 54321 E 16th avenue city: New York state: NY drop_trailer: false zipcode: "33140" country: USA "404": description: Quote Request not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found "410": description: Quote request is no longer available content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description /api/v2/load-offers/offers: get: summary: Search offers tags: - Load Offers security: - Application-JWT: - load_offers_read description: | Search offers parameters: - in: query name: alcohol schema: description: Show only loads that have/don't have alcoholic commodity (shows all loads if not informed) type: string format: boolean required: false - in: query name: equipment_type schema: description: | The type of truck used to transport the load: * `DRV` - Dry van * `FBE` - Flatbed * `RFR` - Reefer * `CON` - Conestoga * `CUR` - Curtainside * `DDP` - Double drop * `IMC` - Intermodal * `SDK` - Step deck * `STK` - Straight truck * `LTL` - Less than truckload * `BLK` - Bulk * `TNK` - Tanker * `OTH` - Others Repeat the query string in order to search for multiple types at the same time, e.g: `?equipment_type=DRV&equipment_type=FBE` type: string enum: - DRV - FBE - RFR - CON - CUR - DDP - IMC - SDK - STK - LTL - BLK - TNK - OTH required: false - in: query name: start_date schema: description: Date type: string format: YYYY-MM-DD required: false - in: query name: end_date schema: description: Date type: string format: YYYY-MM-DD required: false - in: query name: origin_lat schema: description: Origin latitude type: number required: false - in: query name: origin_lon schema: description: Origin longitude type: number required: false - in: query name: origin_radius schema: description: Radius for origin field (Miles) type: number format: integer required: false - in: query name: destination_lat schema: description: Destination latitude type: number required: false - in: query name: destination_lon schema: description: Destination longitude type: number required: false - in: query name: destination_radius schema: description: Radius for destitation field (Miles) type: number format: integer required: false - in: query name: mc schema: description: Carrier's MC number type: string required: false - in: query name: dot schema: description: Carrier's DOT number type: string required: false responses: "200": description: Success content: application/json: schema: type: object properties: count: description: Number of objects found type: number format: integer next: description: URL for next page of results type: string format: url previous: description: URL for previous page of results type: string format: url results: type: array items: type: object properties: id: type: string description: Offer unique identifier (UUID) price: type: number description: Offer price (USD) load: type: object properties: equipment_type: type: string enum: - DRV - FBE - RFR - CON - CUR - DDP - IMC - SDK - STK - LTL - BLK - TNK - OTH description: The type of truck used to transport the load. Allowed values are DRV (dry van), FBE (flatbed), RFR (reefer), CON (conestoga), CUR (curtainside), DDP (double drop), IMC (intermodal), SDK (step deck), STK (straight truck), LTL (less than truckload), BLK (bulk), TNK (tanker) and OTH for others. commodity: type: string maxLength: 255 description: Name or description of the commodity that is being shipped. weight: type: number minimum: 1 description: Weight of the cargo in pounds (lbs). dimensions: type: object description: | Dimensions of the cargo in feet (ft). A `null` dimension means that the information is unavailable. properties: weight: type: number nullable: true height: type: number nullable: true width: type: number nullable: true distance: type: number minimum: 1 description: Total distance of the shipment, in miles. This counts all stops. stops: type: array items: type: object properties: type: type: string enum: - PU - DEL description: Type of the stop. Pickup (PU) or Delivery (DEL). address: type: string city: type: string state: type: string pattern: ^[A-Z0-9]{1,3}$ description: | Up to 3-alphanumeric characters representing state or equivalent administrative boundary, from the second part of ISO 3166-2 code definition. For example, Florida is FL, since its ISO 3166-2 is US-FL. country: type: string pattern: ^[A-Z]{3}$ description: 3 letter country code (ISO-3166-1 alpha3). latitude: type: number description: Latitude coordinate of the stop longitude: type: number description: Longitude coordinate of the stop zipcode: type: string description: Zipcode of the stop (first five digits) window_start: type: string format: naive date-time description: A datetime that represents the start of a time window for this stop (pickup or delivery). In local time. window_end: type: string format: naive date-time description: A datetime that represents the start of a time window for this stop (pickup or delivery). In local time. window_timezone: type: string description: A timezone identifier for the stop. requirements: type: array description: | A list of requirements for the Stop, such as drop_trailer, etc. facility_info: type: object description: Detention rate and average waiting time on the facility properties: avg_time_spent: type: object description: Average waiting on facility properties: pickup: type: number description: Average waiting time in minutes for pickup delivery: type: number description: Average waiting time in minutes for delivery detention_rate: type: number description: Facility detention rate (0 to 100) requirements: type: object description: | Requirements for the load properties: beer: type: boolean chemicals: type: boolean ctpat: type: boolean food_grade: type: boolean frozen: type: boolean hazmat: type: boolean hvhr: type: boolean pharmaceuticals: type: boolean produce: type: boolean teams: type: boolean tsa: type: boolean twic: type: boolean vented_vans: type: boolean ref_number: type: string description: Human readable Load reference number. required: - ref_number - equipment_type actions: type: object properties: redirect_url: type: string description: URL of offer on Loadsmart website. accept_url: type: string description: URL to accept the offer via API (must be a POST method). example: count: 2 next: null previous: null results: - id: ccd37107-ebe7-4a60-a20f-01d4e74355c8 price: 1234.56 load: equipment_type: DRV commodity: apples weight: 20000 dimensions: width: 8 height: 8 length: 54 distance: 50000 stops: - type: PU address: 101 Collins Avenue city: Miami Beach state: FL country: USA latitude: 41.203996 longitude: -96.115593 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false facility_info: avg_time_spent: pickup: 40 delivery: 180 detention_rate: 4 zipcode: "33139" window_start: 2020-02-13T09:00:00 window_end: 2018-02-13T11:00:00 window_timezone: America/New_York - type: DEL address: 2022 Collins Avenue city: Miami Beach state: FL country: USA latitude: 42.535793 longitude: -70.966568 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false facility_info: avg_time_spent: pickup: 20 delivery: 20 detention_rate: 0 window_start: 2018-02-14T16:00:00 window_end: 2018-02-14T18:00:00 window_timezone: America/New_York requirements: beer: false chemicals: false ctpat: false food_grade: false frozen: false hazmat: false hvhr: false pharmaceuticals: false produce: false teams: false tsa: false twic: false vented_vans: false ref_number: "425631" actions: redirect_url: https://loadsmart.com/loads/#/a440a0df-c3c2-4d70-9acd-7f03f4bc00f4 accept_url: https://api.loadsmart.com/api/v2/load-offers/offers/ccd37107-ebe7-4a60-a20f-01d4e74355c8/accept - id: e79acc24-cbfa-4cc7-92ca-7001279cf064 price: 1234.56 load: equipment_type: DRV commodity: apples weight: 20000 dimensions: width: null height: null length: null distance: 50000 stops: - type: PU address: 101 Collins Avenue city: Miami Beach state: FL country: USA latitude: 41.203996 longitude: -96.115593 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false zipcode: "33139" window_start: 2020-02-13T09:00:00 window_end: 2018-02-13T11:00:00 window_timezone: America/New_York - type: DEL address: 2022 Collins Avenue city: Miami Beach state: FL country: USA latitude: 42.535793 longitude: -70.966568 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false window_start: 2018-02-14T16:00:00 window_end: 2018-02-14T18:00:00 window_timezone: America/New_York requirements: beer: false chemicals: false ctpat: false food_grade: false frozen: false hazmat: false hvhr: false pharmaceuticals: false produce: false teams: false tsa: false twic: false vented_vans: false ref_number: "425821" actions: redirect_url: https://loadsmart.com/loads/#/eec5677f-883c-4696-b13b-7539fa98e098 accept_url: https://api.loadsmart.com/api/v2/load-offers/offers/e79acc24-cbfa-4cc7-92ca-7001279cf064/accept "400": description: Invalid parameters content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description "/api/v2/load-offers/offers/{offer_id}": get: summary: Retrieve offer tags: - Load Offers security: - Application-JWT: - load_offers_read parameters: - in: query name: offer_id required: true schema: description: Offer UUID type: string format: uuid responses: "200": description: Success content: application/json: schema: type: object properties: id: type: string description: Offer unique identifier (UUID) price: type: number description: Offer price (USD) load: type: object properties: equipment_type: type: string enum: - DRV - FBE - RFR - CON - CUR - DDP - IMC - SDK - STK - LTL - BLK - TNK - OTH description: The type of truck used to transport the load. Allowed values are DRV (dry van), FBE (flatbed), RFR (reefer), CON (conestoga), CUR (curtainside), DDP (double drop), IMC (intermodal), SDK (step deck), STK (straight truck), LTL (less than truckload), BLK (bulk), TNK (tanker) and OTH for others. commodity: type: string maxLength: 255 description: Name or description of the commodity that is being shipped. weight: type: number minimum: 1 description: Weight of the cargo in pounds (lbs). dimensions: type: object description: | Dimensions of the cargo in feet (ft). A `null` dimension means that the information is unavailable. properties: weight: type: number nullable: true height: type: number nullable: true width: type: number nullable: true distance: type: number minimum: 1 description: Total distance of the shipment, in miles. This counts all stops. stops: type: array items: type: object properties: type: type: string enum: - PU - DEL description: Type of the stop. Pickup (PU) or Delivery (DEL). address: type: string city: type: string state: type: string pattern: ^[A-Z0-9]{1,3}$ description: | Up to 3-alphanumeric characters representing state or equivalent administrative boundary, from the second part of ISO 3166-2 code definition. For example, Florida is FL, since its ISO 3166-2 is US-FL. country: type: string pattern: ^[A-Z]{3}$ description: 3 letter country code (ISO-3166-1 alpha3). latitude: type: number description: Latitude coordinate of the stop longitude: type: number description: Longitude coordinate of the stop zipcode: type: string description: Zipcode of the stop (first five digits) window_start: type: string format: naive date-time description: A datetime that represents the start of a time window for this stop (pickup or delivery). In local time. window_end: type: string format: naive date-time description: A datetime that represents the start of a time window for this stop (pickup or delivery). In local time. window_timezone: type: string description: A timezone identifier for the stop. requirements: type: array description: | A list of requirements for the Stop, such as drop_trailer, etc. facility_info: type: object description: Detention rate and average waiting time on the facility properties: avg_time_spent: type: object description: Average waiting on facility properties: pickup: type: number description: Average waiting time in minutes for pickup delivery: type: number description: Average waiting time in minutes for delivery detention_rate: type: number description: Facility detention rate (0 to 100) requirements: type: object description: | Requirements for the load properties: beer: type: boolean chemicals: type: boolean ctpat: type: boolean food_grade: type: boolean frozen: type: boolean hazmat: type: boolean hvhr: type: boolean pharmaceuticals: type: boolean produce: type: boolean teams: type: boolean tsa: type: boolean twic: type: boolean vented_vans: type: boolean ref_number: type: string description: Human readable Load reference number. required: - ref_number - equipment_type actions: type: object properties: redirect_url: type: string description: URL of offer on Loadsmart website. accept_url: type: string description: URL to accept the offer via API (must be a POST method). example: id: ccd37107-ebe7-4a60-a20f-01d4e74355c8 price: 1234.56 load: equipment_type: DRV commodity: apples weight: 20000 dimensions: width: 8 height: 8 length: 54 distance: 50000 stops: - type: PU address: 101 Collins Avenue city: Miami Beach state: FL country: USA latitude: 41.203996 longitude: -96.115593 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false facility_info: avg_time_spent: pickup: 40 delivery: 180 detention_rate: 4 zipcode: "33139" window_start: 2020-02-13T09:00:00 window_end: 2018-02-13T11:00:00 window_timezone: America/New_York - type: DEL address: 2022 Collins Avenue city: Miami Beach state: FL country: USA latitude: 42.535793 longitude: -70.966568 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false facility_info: avg_time_spent: pickup: 20 delivery: 20 detention_rate: 0 window_start: 2018-02-14T16:00:00 window_end: 2018-02-14T18:00:00 window_timezone: America/New_York requirements: beer: false chemicals: false ctpat: false food_grade: false frozen: false hazmat: false hvhr: false pharmaceuticals: false produce: false teams: false tsa: false twic: false vented_vans: false ref_number: "425631" actions: redirect_url: https://loadsmart.com/loads/#/a440a0df-c3c2-4d70-9acd-7f03f4bc00f4 accept_url: https://api.loadsmart.com/api/v2/load-offers/offers/ccd37107-ebe7-4a60-a20f-01d4e74355c8/accept "/api/v2/load-offers/offers/{offer_id}/accept": post: summary: Accept an offer tags: - Load Offers security: - User-JWT: - load_offers_write description: | Accept an Offer for a Carrier parameters: - in: path name: offer_id schema: description: Offer UUID type: string format: uuid required: true responses: "202": description: Accepted content: application/json: schema: properties: id: type: string description: Load unique identifier (UUID) example: id: 2ed37107-ebe7-4a60-a20f-01d4e74355c8 "400": description: Invalid parameters content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description "404": description: Offer not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found "410": description: Offer no longer available content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description "412": description: Carrier is not eligible to move the Load content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description "/api/v2/load-offers/offers/{offer_id}/related": get: summary: Search related offers tags: - Load Offers security: - Application-JWT: - load_offers_read description: | Search related offers of another offer parameters: - in: path name: offer_id required: true schema: description: Offer UUID type: string format: uuid - in: query name: relation required: false schema: description: | Relation type with the Offer. Possible values `backhaul`, `similar_lane`, `similar_pickup`, `similar_delivery` or `from_delivery` type: string responses: "200": description: Success content: application/json: schema: type: object properties: count: description: Number of objects found type: number format: integer next: description: URL for next page of results type: string format: url previous: description: URL for previous page of results type: string format: url results: type: array items: type: object properties: id: type: string description: Offer unique identifier (UUID) price: type: number description: Offer price (USD) relation: type: string description: | Relation type with the Offer. Possible values `backhaul`, `similar_lane`, `similar_pickup`, `similar_delivery` or `from_delivery` load: type: object properties: equipment_type: type: string enum: - DRV - FBE - RFR - CON - CUR - DDP - IMC - SDK - STK - LTL - BLK - TNK - OTH description: The type of truck used to transport the load. Allowed values are DRV (dry van), FBE (flatbed), RFR (reefer), CON (conestoga), CUR (curtainside), DDP (double drop), IMC (intermodal), SDK (step deck), STK (straight truck), LTL (less than truckload), BLK (bulk), TNK (tanker) and OTH for others. commodity: type: string maxLength: 255 description: Name or description of the commodity that is being shipped. weight: type: number minimum: 1 description: Weight of the cargo in pounds (lbs). dimensions: type: object description: | Dimensions of the cargo in feet (ft). A `null` dimension means that the information is unavailable. properties: weight: type: number nullable: true height: type: number nullable: true width: type: number nullable: true distance: type: number minimum: 1 description: Total distance of the shipment, in miles. This counts all stops. stops: type: array items: type: object properties: type: type: string enum: - PU - DEL description: Type of the stop. Pickup (PU) or Delivery (DEL). address: type: string city: type: string state: type: string pattern: ^[A-Z0-9]{1,3}$ description: | Up to 3-alphanumeric characters representing state or equivalent administrative boundary, from the second part of ISO 3166-2 code definition. For example, Florida is FL, since its ISO 3166-2 is US-FL. country: type: string pattern: ^[A-Z]{3}$ description: 3 letter country code (ISO-3166-1 alpha3). latitude: type: number description: Latitude coordinate of the stop longitude: type: number description: Longitude coordinate of the stop zipcode: type: string description: Zipcode of the stop (first five digits) window_start: type: string format: naive date-time description: A datetime that represents the start of a time window for this stop (pickup or delivery). In local time. window_end: type: string format: naive date-time description: A datetime that represents the start of a time window for this stop (pickup or delivery). In local time. window_timezone: type: string description: A timezone identifier for the stop. requirements: type: array description: | A list of requirements for the Stop, such as drop_trailer, etc. facility_info: type: object description: Detention rate and average waiting time on the facility properties: avg_time_spent: type: object description: Average waiting on facility properties: pickup: type: number description: Average waiting time in minutes for pickup delivery: type: number description: Average waiting time in minutes for delivery detention_rate: type: number description: Facility detention rate (0 to 100) requirements: type: object description: | Requirements for the load properties: beer: type: boolean chemicals: type: boolean ctpat: type: boolean food_grade: type: boolean frozen: type: boolean hazmat: type: boolean hvhr: type: boolean pharmaceuticals: type: boolean produce: type: boolean teams: type: boolean tsa: type: boolean twic: type: boolean vented_vans: type: boolean ref_number: type: string description: Human readable Load reference number. required: - ref_number - equipment_type actions: type: object properties: redirect_url: type: string description: URL of offer on Loadsmart website. accept_url: type: string description: URL to accept the offer via API (must be a POST method). example: count: 2 next: null previous: null results: - id: ccd37107-ebe7-4a60-a20f-01d4e74355c8 price: 1234.56 relation: similar_lane load: equipment_type: DRV commodity: apples weight: 20000 dimensions: width: 8 height: 9 length: 54 distance: 50000 stops: - type: PU address: 101 Collins Avenue city: Miami Beach state: FL country: USA latitude: 41.203996 longitude: -96.115593 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false facility_info: avg_time_spent: pickup: 40 delivery: 180 detention_rate: 4 zipcode: "33139" window_start: 2020-02-13T09:00:00 window_end: 2018-02-13T11:00:00 window_timezone: America/New_York - type: DEL address: 2022 Collins Avenue city: Miami Beach state: FL country: USA latitude: 42.535793 longitude: -70.966568 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false facility_info: avg_time_spent: pickup: 20 delivery: 20 detention_rate: 0 window_start: 2018-02-14T16:00:00 window_end: 2018-02-14T18:00:00 window_timezone: America/New_York requirements: beer: false chemicals: false ctpat: false food_grade: false frozen: false hazmat: false hvhr: false pharmaceuticals: false produce: false teams: false tsa: false twic: false vented_vans: false ref_number: "425631" actions: redirect_url: https://loadsmart.com/loads/#/a440a0df-c3c2-4d70-9acd-7f03f4bc00f4 accept_url: https://api.loadsmart.com/api/v2/load-offers/offers/ccd37107-ebe7-4a60-a20f-01d4e74355c8/accept - id: e79acc24-cbfa-4cc7-92ca-7001279cf064 price: 1234.56 relation: similar_pickup load: equipment_type: DRV commodity: apples weight: 20000 dimensions: width: null height: null length: null distance: 50000 stops: - type: PU address: 101 Collins Avenue city: Miami Beach state: FL country: USA latitude: 41.203996 longitude: -96.115593 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false zipcode: "33139" window_start: 2020-02-13T09:00:00 window_end: 2018-02-13T11:00:00 window_timezone: America/New_York - type: DEL address: 2022 Collins Avenue city: Miami Beach state: FL country: USA latitude: 42.535793 longitude: -70.966568 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false window_start: 2018-02-14T16:00:00 window_end: 2018-02-14T18:00:00 window_timezone: America/New_York requirements: beer: false chemicals: false ctpat: false food_grade: false frozen: false hazmat: false hvhr: false pharmaceuticals: false produce: false teams: false tsa: false twic: false vented_vans: false ref_number: "425821" actions: redirect_url: https://loadsmart.com/loads/#/eec5677f-883c-4696-b13b-7539fa98e098 accept_url: https://api.loadsmart.com/api/v2/load-offers/offers/e79acc24-cbfa-4cc7-92ca-7001279cf064/accept "400": description: Invalid parameters content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description /api/v2/load-offers/loads/: get: summary: List loads tags: - Load Offers security: - Application-JWT: - load_offers_read description: List accepted loads responses: "200": description: Success content: application/json: schema: type: object properties: count: description: Number of objects found type: number format: integer next: description: URL for next page of results type: string format: url previous: description: URL for previous page of results type: string format: url results: type: array items: allOf: - type: object properties: id: type: string description: Load unique identifier (UUID) active_offer: type: object description: Offer associated to the load properties: id: type: string description: Offer unique identifier (UUID) price: type: number format: float description: Offer price (USD) carrier: type: object description: Carrier assigned to the load properties: id: description: Carrier id type: string format: uuid dot: description: Carrier DOT number type: string format: integer mc: description: Carrier MC number type: string format: integer - type: object properties: equipment_type: type: string enum: - DRV - FBE - RFR - CON - CUR - DDP - IMC - SDK - STK - LTL - BLK - TNK - OTH description: The type of truck used to transport the load. Allowed values are DRV (dry van), FBE (flatbed), RFR (reefer), CON (conestoga), CUR (curtainside), DDP (double drop), IMC (intermodal), SDK (step deck), STK (straight truck), LTL (less than truckload), BLK (bulk), TNK (tanker) and OTH for others. commodity: type: string maxLength: 255 description: Name or description of the commodity that is being shipped. weight: type: number minimum: 1 description: Weight of the cargo in pounds (lbs). dimensions: type: object description: | Dimensions of the cargo in feet (ft). A `null` dimension means that the information is unavailable. properties: weight: type: number nullable: true height: type: number nullable: true width: type: number nullable: true distance: type: number minimum: 1 description: Total distance of the shipment, in miles. This counts all stops. stops: type: array items: type: object properties: type: type: string enum: - PU - DEL description: Type of the stop. Pickup (PU) or Delivery (DEL). address: type: string city: type: string state: type: string pattern: ^[A-Z0-9]{1,3}$ description: | Up to 3-alphanumeric characters representing state or equivalent administrative boundary, from the second part of ISO 3166-2 code definition. For example, Florida is FL, since its ISO 3166-2 is US-FL. country: type: string pattern: ^[A-Z]{3}$ description: 3 letter country code (ISO-3166-1 alpha3). latitude: type: number description: Latitude coordinate of the stop longitude: type: number description: Longitude coordinate of the stop zipcode: type: string description: Zipcode of the stop (first five digits) window_start: type: string format: naive date-time description: A datetime that represents the start of a time window for this stop (pickup or delivery). In local time. window_end: type: string format: naive date-time description: A datetime that represents the start of a time window for this stop (pickup or delivery). In local time. window_timezone: type: string description: A timezone identifier for the stop. requirements: type: array description: | A list of requirements for the Stop, such as drop_trailer, etc. facility_info: type: object description: Detention rate and average waiting time on the facility properties: avg_time_spent: type: object description: Average waiting on facility properties: pickup: type: number description: Average waiting time in minutes for pickup delivery: type: number description: Average waiting time in minutes for delivery detention_rate: type: number description: Facility detention rate (0 to 100) requirements: type: object description: | Requirements for the load properties: beer: type: boolean chemicals: type: boolean ctpat: type: boolean food_grade: type: boolean frozen: type: boolean hazmat: type: boolean hvhr: type: boolean pharmaceuticals: type: boolean produce: type: boolean teams: type: boolean tsa: type: boolean twic: type: boolean vented_vans: type: boolean ref_number: type: string description: Human readable Load reference number. required: - ref_number - equipment_type "400": description: Invalid parameters content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description "404": description: Load not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found "/api/v2/load-offers/loads/{load_id}": get: summary: Retrieve a load tags: - Load Offers security: - Application-JWT: - load_offers_read description: Retrieve an accepted load parameters: - in: path name: load_id required: true schema: description: Load UUID type: string format: uuid responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: id: type: string description: Load unique identifier (UUID) active_offer: type: object description: Offer associated to the load properties: id: type: string description: Offer unique identifier (UUID) price: type: number format: float description: Offer price (USD) carrier: type: object description: Carrier assigned to the load properties: id: description: Carrier id type: string format: uuid dot: description: Carrier DOT number type: string format: integer mc: description: Carrier MC number type: string format: integer - type: object properties: equipment_type: type: string enum: - DRV - FBE - RFR - CON - CUR - DDP - IMC - SDK - STK - LTL - BLK - TNK - OTH description: The type of truck used to transport the load. Allowed values are DRV (dry van), FBE (flatbed), RFR (reefer), CON (conestoga), CUR (curtainside), DDP (double drop), IMC (intermodal), SDK (step deck), STK (straight truck), LTL (less than truckload), BLK (bulk), TNK (tanker) and OTH for others. commodity: type: string maxLength: 255 description: Name or description of the commodity that is being shipped. weight: type: number minimum: 1 description: Weight of the cargo in pounds (lbs). dimensions: type: object description: | Dimensions of the cargo in feet (ft). A `null` dimension means that the information is unavailable. properties: weight: type: number nullable: true height: type: number nullable: true width: type: number nullable: true distance: type: number minimum: 1 description: Total distance of the shipment, in miles. This counts all stops. stops: type: array items: type: object properties: type: type: string enum: - PU - DEL description: Type of the stop. Pickup (PU) or Delivery (DEL). address: type: string city: type: string state: type: string pattern: ^[A-Z0-9]{1,3}$ description: | Up to 3-alphanumeric characters representing state or equivalent administrative boundary, from the second part of ISO 3166-2 code definition. For example, Florida is FL, since its ISO 3166-2 is US-FL. country: type: string pattern: ^[A-Z]{3}$ description: 3 letter country code (ISO-3166-1 alpha3). latitude: type: number description: Latitude coordinate of the stop longitude: type: number description: Longitude coordinate of the stop zipcode: type: string description: Zipcode of the stop (first five digits) window_start: type: string format: naive date-time description: A datetime that represents the start of a time window for this stop (pickup or delivery). In local time. window_end: type: string format: naive date-time description: A datetime that represents the start of a time window for this stop (pickup or delivery). In local time. window_timezone: type: string description: A timezone identifier for the stop. requirements: type: array description: | A list of requirements for the Stop, such as drop_trailer, etc. facility_info: type: object description: Detention rate and average waiting time on the facility properties: avg_time_spent: type: object description: Average waiting on facility properties: pickup: type: number description: Average waiting time in minutes for pickup delivery: type: number description: Average waiting time in minutes for delivery detention_rate: type: number description: Facility detention rate (0 to 100) requirements: type: object description: | Requirements for the load properties: beer: type: boolean chemicals: type: boolean ctpat: type: boolean food_grade: type: boolean frozen: type: boolean hazmat: type: boolean hvhr: type: boolean pharmaceuticals: type: boolean produce: type: boolean teams: type: boolean tsa: type: boolean twic: type: boolean vented_vans: type: boolean ref_number: type: string description: Human readable Load reference number. required: - ref_number - equipment_type example: id: 2ed37107-ebe7-4a60-a20f-01d4e74355c8 equipment_type: DRV commodity: apples weight: 20000 dimensions: width: 8 height: 9 length: 54 distance: 50000 stops: - type: PU address: 101 Collins Avenue city: Miami Beach state: FL country: USA latitude: 41.203996 longitude: -96.115593 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false facility_info: avg_time_spent: pickup: 40 delivery: 180 detention_rate: 4 zipcode: "33139" window_start: 2020-02-13T09:00:00 window_end: 2018-02-13T11:00:00 window_timezone: America/New_York - type: DEL address: 2022 Collins Avenue city: Miami Beach state: FL country: USA latitude: 42.535793 longitude: -70.966568 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false facility_info: avg_time_spent: pickup: 20 delivery: 20 detention_rate: 0 window_start: 2018-02-14T16:00:00 window_end: 2018-02-14T18:00:00 window_timezone: America/New_York requirements: beer: false chemicals: false ctpat: false food_grade: false frozen: false hazmat: false hvhr: false pharmaceuticals: false produce: false teams: false tsa: false twic: false vented_vans: false active_offer: id: ccd37107-ebe7-4a60-a20f-01d4e74355c8 price: 1234.56 carrier: id: 89ef54c7-52d5-44a0-b94d-df41eb1aab15 mc: 123456 dot: 987654 ref_number: "425631" "404": description: Load not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found delete: summary: Drop a load tags: - Load Offers security: - User-JWT: - load_offers_write description: Drop a load parameters: - in: path name: load_id required: true schema: description: Load UUID type: string format: uuid requestBody: required: true content: application/json: schema: type: object properties: reason: description: Reason for dropping the load type: string required: - reason responses: "204": description: Success "400": description: Invalid parameters content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description "404": description: Load not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found "500": description: Internal error content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description "/api/v2/load-offers/loads/{load_id}/rate_confirmation": get: summary: Download ratecon tags: - Load Offers security: - User-JWT: - load_offers_read description: Download rate confirmation PDF file parameters: - in: path name: load_id required: true schema: description: Load UUID type: string format: uuid responses: "200": description: The Rate Confirmation file was generated and downloaded content: application/pdf: schema: type: string format: binary "403": description: Invalid token type. content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: forbiden_access error_description: An user is trying to access a not authorized resource. "404": description: Load not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found "/api/v2/load-offers/loads/{load_id}/related-offers": get: summary: Search related offers tags: - Load Offers security: - Application-JWT: - load_offers_read description: | Search related offers of a Load parameters: - in: path name: load_id required: true schema: description: Load UUID type: string format: uuid - in: query name: relation required: false schema: description: | Relation type with the Offer. Possible values `backhaul`, `similar_lane`, `similar_pickup`, `similar_delivery` or `from_delivery` type: string responses: "200": description: Success content: application/json: schema: type: object properties: count: description: Number of objects found type: number format: integer next: description: URL for next page of results type: string format: url previous: description: URL for previous page of results type: string format: url results: type: array items: type: object properties: id: type: string description: Offer unique identifier (UUID) price: type: number description: Offer price (USD) relation: type: string description: | Relation type with the Offer. Possible values `backhaul`, `similar_lane`, `similar_pickup`, `similar_delivery` or `from_delivery` load: type: object properties: equipment_type: type: string enum: - DRV - FBE - RFR - CON - CUR - DDP - IMC - SDK - STK - LTL - BLK - TNK - OTH description: The type of truck used to transport the load. Allowed values are DRV (dry van), FBE (flatbed), RFR (reefer), CON (conestoga), CUR (curtainside), DDP (double drop), IMC (intermodal), SDK (step deck), STK (straight truck), LTL (less than truckload), BLK (bulk), TNK (tanker) and OTH for others. commodity: type: string maxLength: 255 description: Name or description of the commodity that is being shipped. weight: type: number minimum: 1 description: Weight of the cargo in pounds (lbs). dimensions: type: object description: | Dimensions of the cargo in feet (ft). A `null` dimension means that the information is unavailable. properties: weight: type: number nullable: true height: type: number nullable: true width: type: number nullable: true distance: type: number minimum: 1 description: Total distance of the shipment, in miles. This counts all stops. stops: type: array items: type: object properties: type: type: string enum: - PU - DEL description: Type of the stop. Pickup (PU) or Delivery (DEL). address: type: string city: type: string state: type: string pattern: ^[A-Z0-9]{1,3}$ description: | Up to 3-alphanumeric characters representing state or equivalent administrative boundary, from the second part of ISO 3166-2 code definition. For example, Florida is FL, since its ISO 3166-2 is US-FL. country: type: string pattern: ^[A-Z]{3}$ description: 3 letter country code (ISO-3166-1 alpha3). latitude: type: number description: Latitude coordinate of the stop longitude: type: number description: Longitude coordinate of the stop zipcode: type: string description: Zipcode of the stop (first five digits) window_start: type: string format: naive date-time description: A datetime that represents the start of a time window for this stop (pickup or delivery). In local time. window_end: type: string format: naive date-time description: A datetime that represents the start of a time window for this stop (pickup or delivery). In local time. window_timezone: type: string description: A timezone identifier for the stop. requirements: type: array description: | A list of requirements for the Stop, such as drop_trailer, etc. facility_info: type: object description: Detention rate and average waiting time on the facility properties: avg_time_spent: type: object description: Average waiting on facility properties: pickup: type: number description: Average waiting time in minutes for pickup delivery: type: number description: Average waiting time in minutes for delivery detention_rate: type: number description: Facility detention rate (0 to 100) requirements: type: object description: | Requirements for the load properties: beer: type: boolean chemicals: type: boolean ctpat: type: boolean food_grade: type: boolean frozen: type: boolean hazmat: type: boolean hvhr: type: boolean pharmaceuticals: type: boolean produce: type: boolean teams: type: boolean tsa: type: boolean twic: type: boolean vented_vans: type: boolean ref_number: type: string description: Human readable Load reference number. required: - ref_number - equipment_type actions: type: object properties: redirect_url: type: string description: URL of offer on Loadsmart website. accept_url: type: string description: URL to accept the offer via API (must be a POST method). example: count: 2 next: null previous: null results: - id: ccd37107-ebe7-4a60-a20f-01d4e74355c8 price: 1234.56 relation: similar_lane load: equipment_type: DRV commodity: apples weight: 20000 dimensions: width: 8 height: 9 length: 54 distance: 50000 stops: - type: PU address: 101 Collins Avenue city: Miami Beach state: FL country: USA latitude: 41.203996 longitude: -96.115593 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false facility_info: avg_time_spent: pickup: 40 delivery: 180 detention_rate: 4 zipcode: "33139" window_start: 2020-02-13T09:00:00 window_end: 2018-02-13T11:00:00 window_timezone: America/New_York - type: DEL address: 2022 Collins Avenue city: Miami Beach state: FL country: USA latitude: 42.535793 longitude: -70.966568 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false facility_info: avg_time_spent: pickup: 20 delivery: 20 detention_rate: 0 window_start: 2018-02-14T16:00:00 window_end: 2018-02-14T18:00:00 window_timezone: America/New_York requirements: beer: false chemicals: false ctpat: false food_grade: false frozen: false hazmat: false hvhr: false pharmaceuticals: false produce: false teams: false tsa: false twic: false vented_vans: false ref_number: "425631" actions: redirect_url: https://loadsmart.com/loads/#/a440a0df-c3c2-4d70-9acd-7f03f4bc00f4 accept_url: https://api.loadsmart.com/api/v2/load-offers/offers/ccd37107-ebe7-4a60-a20f-01d4e74355c8/accept - id: e79acc24-cbfa-4cc7-92ca-7001279cf064 price: 1234.56 relation: similar_pickup load: equipment_type: DRV commodity: apples weight: 20000 dimensions: width: null height: null length: null distance: 50000 stops: - type: PU address: 101 Collins Avenue city: Miami Beach state: FL country: USA latitude: 41.203996 longitude: -96.115593 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false zipcode: "33139" window_start: 2020-02-13T09:00:00 window_end: 2018-02-13T11:00:00 window_timezone: America/New_York - type: DEL address: 2022 Collins Avenue city: Miami Beach state: FL country: USA latitude: 42.535793 longitude: -70.966568 requirements: blind_bol: false drop_trailer: false heavy_scale_ticket: false light_scale_ticket: false window_start: 2018-02-14T16:00:00 window_end: 2018-02-14T18:00:00 window_timezone: America/New_York requirements: beer: false chemicals: false ctpat: false food_grade: false frozen: false hazmat: false hvhr: false pharmaceuticals: false produce: false teams: false tsa: false twic: false vented_vans: false ref_number: "425821" actions: redirect_url: https://loadsmart.com/loads/#/eec5677f-883c-4696-b13b-7539fa98e098 accept_url: https://api.loadsmart.com/api/v2/load-offers/offers/e79acc24-cbfa-4cc7-92ca-7001279cf064/accept "400": description: Invalid parameters content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description /api/v2/load-offers/webhooks: get: summary: List webhooks tags: - Load Offers security: - Application-JWT: - load_offers_read description: | List configured webhooks responses: "200": description: Success content: application/json: schema: type: object properties: count: description: Number of objects found type: number format: integer next: description: URL for next page of results type: string format: url previous: description: URL for previous page of results type: string format: url results: type: array items: allOf: - type: object properties: id: description: Webhook unique identifier (UUID) type: string - type: object properties: url: description: URL to be called when proper event happens type: string event: description: Action that will trigger the endpoint type: string enum: - load_cancelled - load_carrier_bounced - offer_created - offer_removed required: - url - event example: count: 2 next: null previous: null results: - uuid: d630d8fe-9859-453f-aed2-372a1b09345c url: https://www.example.com/my/awsome/webhook_1 event: load_cancelled - uuid: 8f62fea9-1edb-4f31-b2e5-dcf184b5a22b url: https://www.example.com/my/awsome/webhook_2 event: load_carrier_bounced - uuid: bac6dabc-c324-40bc-91f6-ed772d72632f url: https://www.example.com/my/awsome/webhook_3 event: offer_created - uuid: f2d51c14-4750-42cf-8c7a-a68c0d7b8d11 url: https://www.example.com/my/awsome/webhook_3 event: offer_removed post: summary: Register webhooks tags: - Load Offers security: - Application-JWT: - load_offers_write description: | Create webhooks configuration requestBody: required: true content: application/json: schema: type: object properties: url: description: URL to be called when proper event happens type: string event: description: Action that will trigger the endpoint type: string enum: - load_cancelled - load_carrier_bounced - offer_created - offer_removed required: - url - event responses: "201": description: Success content: application/json: schema: allOf: - type: object properties: id: description: Webhook unique identifier (UUID) type: string - type: object properties: url: description: URL to be called when proper event happens type: string event: description: Action that will trigger the endpoint type: string enum: - load_cancelled - load_carrier_bounced - offer_created - offer_removed required: - url - event example: uuid: d630d8fe-9859-453f-aed2-372a1b09345c url: https://www.example.com/my/awsome/webhook_1 event: load_carrier_bounced "400": description: Invalid parameters content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description "/api/v2/load-offers/webhooks/{uuid}": get: summary: Retrieve webhook tags: - Load Offers security: - Application-JWT: - load_offers_read description: | Retrieve webhook configuration parameters: - in: path name: uuid schema: description: Webhook unique identifier (UUID) type: string format: uuid required: true responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: id: description: Webhook unique identifier (UUID) type: string - type: object properties: url: description: URL to be called when proper event happens type: string event: description: Action that will trigger the endpoint type: string enum: - load_cancelled - load_carrier_bounced - offer_created - offer_removed required: - url - event example: uuid: d630d8fe-9859-453f-aed2-372a1b09345c url: https://www.example.com/my/awsome/webhook_1 event: load_carrier_bounced "404": description: Webhook configuration not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found put: summary: Update webhook tags: - Load Offers security: - Application-JWT: - load_offers_write description: | Update webhook configuration parameters: - in: path name: uuid schema: description: Webhook unique identifier (UUID) type: string format: uuid required: true requestBody: required: true content: application/json: schema: type: object properties: url: description: URL to be called when proper event happens type: string event: description: Action that will trigger the endpoint type: string enum: - load_cancelled - load_carrier_bounced - offer_created - offer_removed required: - url - event responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: id: description: Webhook unique identifier (UUID) type: string - type: object properties: url: description: URL to be called when proper event happens type: string event: description: Action that will trigger the endpoint type: string enum: - load_cancelled - load_carrier_bounced - offer_created - offer_removed required: - url - event example: uuid: d630d8fe-9859-453f-aed2-372a1b09345c url: https://www.example.com/my/awsome/webhook_1 event: load_carrier_bounced "400": description: Invalid parameters content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description "404": description: Webhook configuration not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found delete: summary: Delete webhook tags: - Load Offers security: - Application-JWT: - load_offers_write description: | Delete webhook configuration parameters: - in: path name: uuid schema: description: Webhook unique identifier (UUID) type: string format: uuid required: true responses: "204": description: No Content "404": description: Webhook configuration not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found /api/v2/load-offers/bids: get: summary: List Bids tags: - Bids security: - User-JWT: - load_offers_read parameters: - in: query name: status schema: type: string enum: - pending - awarded - accepted - timed_out - refused description: The status of the bid responses: "200": description: Success content: application/json: schema: type: object properties: count: description: Number of objects found type: number format: integer next: description: URL for next page of results type: string format: url previous: description: URL for previous page of results type: string format: url results: type: array items: type: object description: The bid properties properties: id: type: string format: uuid description: Bid unique identifier (UUID) offer_id: type: string format: uuid description: Offer unique identifier (UUID) price: type: string format: uuid description: Bid price (USD). created_at: type: datetime format: date-time description: Bid creation datetime expires_at: type: datetime format: date-time description: The bid expiration datetime expired_at: type: datetime format: date-time description: The bid datetime that bid was expirated status: type: string enum: - pending - awarded - accepted - timed_out - refused description: Bit status. example: count: 2 next: null previous: null results: - id: 3b068fe4-99da-40e5-813a-d0a6de9fd558 offer_id: 1471e2b8-bb79-4210-a2d8-5171c4776a54 created_at: 2021-05-26T17:12:43.701Z expires_at: null expired_at: null price: 770.1 status: pending - id: 02df5646-be83-4383-ac76-b2d5557cf927 offer_id: 36241edf-545a-496a-a698-ca8fb6c21156 created_at: 2021-05-26T17:12:43.688Z expires_at: null expired_at: null price: 61.14 status: pending "400": description: Invalid parameters "401": description: Not authorized post: summary: Create Bid tags: - Bids security: - User-JWT: - load_offers_write requestBody: required: true content: application/json: schema: type: object description: Create bid properties: offer_id: type: string format: uuid description: Offer unique identifier (UUID). price: type: string description: Bid Price (USD) example: offer_id: 47aada86-6ef1-4516-a272-2881397daea9 price: "809.96" responses: "201": description: Success content: application/json: example: id: 7593cbc8-53d0-4e54-87fd-a21f4b6dbb44 offer_id: 47aada86-6ef1-4516-a272-2881397daea9 created_at: 2021-05-26T13:43:55.727258Z expires_at: 2021-05-26T13:58:55.727258Z expired_at: null price: "809.96" status: pending schema: type: object description: The bid properties properties: id: type: string format: uuid description: Bid unique identifier (UUID) offer_id: type: string format: uuid description: Offer unique identifier (UUID) price: type: string format: uuid description: Bid price (USD). created_at: type: datetime format: date-time description: Bid creation datetime expires_at: type: datetime format: date-time description: The bid expiration datetime expired_at: type: datetime format: date-time description: The bid datetime that bid was expirated status: type: string enum: - pending - awarded - accepted - timed_out - refused description: Bit status. "400": description: Invalid parameters "401": description: Not authorized "403": description: Forbidden "404": description: Offer doesn't exists or expired "410": description: Offer is no longer available "422": description: Could not create the bid with the given data due to one of - ["The carrier is not eligible for this offer", "This offer is unbiddable", "Invalid Price"] "/api/v2/load-offers/bids/{bid_id}": get: summary: Retrieve Bid tags: - Bids security: - User-JWT: - load_offers_read parameters: - in: path name: bid_id schema: description: Bid unique identifier (UUID) type: string format: uuid required: true responses: "200": description: Success content: application/json: schema: type: object description: The bid properties properties: id: type: string format: uuid description: Bid unique identifier (UUID) offer_id: type: string format: uuid description: Offer unique identifier (UUID) price: type: string format: uuid description: Bid price (USD). created_at: type: datetime format: date-time description: Bid creation datetime expires_at: type: datetime format: date-time description: The bid expiration datetime expired_at: type: datetime format: date-time description: The bid datetime that bid was expirated status: type: string enum: - pending - awarded - accepted - timed_out - refused description: Bit status. example: id: 7593cbc8-53d0-4e54-87fd-a21f4b6dbb44 offer_id: 47aada86-6ef1-4516-a272-2881397daea9 created_at: 2021-05-26T13:43:55.727258Z expires_at: 2021-05-26T13:58:55.727258Z expired_at: null price: "809.96" status: pending "401": description: Not authorized "403": description: Bid is not linked to external outlet "404": description: Offer doesn't exists "/api/v2/load-offers/bids/{bid_id}/accept": post: summary: Accept Bid tags: - Bids security: - User-JWT: - load_offers_write parameters: - in: path name: bid_id schema: description: Bid unique identifier (UUID) type: string format: uuid required: true responses: "200": description: Success content: application/json: schema: type: object properties: id: type: string format: uuid description: Load unique identifier (UUID) example: id: 7593cbc8-53d0-4e54-87fd-a21f4b6dbb44 "400": description: Invalid parameters "401": description: Not authorized "403": description: Forbidden "404": description: Offer doesn't exists "409": description: Cant accept bid with invalid status "/api/v2/loads/{load_id}/events": get: summary: List Load Events description: | Provides a list of the events (rejected, accepted, etc) regarding a load previously tendered to Loadsmart. This is an alternative way to obtain feedback whether a tendered load was accepted or rejected (you can also receive load events by Webhooks - see [Load Webhooks](#tag/Webhooks/paths/~1load-webhooks/post) section). The List Load Events endpoint was designed to be polled, so you don't need to expose an endpoint where Loadsmart would send the accepted/rejected webhook. Although loads and shipments usually refer to the same thing, Loadsmart handles them as two slightly different entities. Up to the point when a load is tendered and booked, the entity in play is a “load”. After this load is booked, it becomes a shipment. From this point on, communication is done with the shipment. List of event types/actions: - awarded - accepted - canceled - rejected security: - User-JWT: - load_read responses: "200": description: Load was found content: application/json: schema: type: object properties: count: description: Number of objects found type: number format: integer next: description: URL for next page of results type: string format: url previous: description: URL for previous page of results type: string format: url data: type: array items: allOf: - type: object properties: id: description: Load event unique identifier type: string format: uuid action: description: Event type type: string created: description: The date and time of the event creation type: string format: date-time load_id: description: Load unique identifier type: string format: uuid example: count: 2 next: null previous: null data: - id: 54b8e6cb-d038-455f-af44-d78fed519172 action: awarded created: 2021-01-06T17:15:12.275594Z load_id: 20eccb85-b1cf-4d40-b904-9e2e05981911 - id: 81c5c1ac-9f6f-4725-81f7-887bd5a9da61 action: accepted created: 2021-01-06T17:18:12.552749Z load_id: 20eccb85-b1cf-4d40-b904-9e2e05981911 "404": description: Load was not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found tags: - Loads /api/v2/loads/tender: post: summary: Create tender description: | Tender a load to Loadsmart. The load could be either a spot or contracted one. If the endpoint returns a successful status code, it means that we have received the load. In order to see if the load was accepted or rejected, you must listen for the `load:accepted` and `load:rejected` webhooks, respectively. See [Load Webhooks](#tag/Webhooks/paths/~1load-webhooks/post) section. Important: the uuid returned identifies a load uniquely in Loadsmart systems. This means that, for two or more responses, if they contain the same uuid, they are related to the exact same load. Quotes that have been created using the `/quote` endpoint can be booked with the tender endpoint if the `quote_id` parameter, provided by the [Create Quote](#tag/Quotes/paths/~1api~1v2~1quotes/post) endpoint, is sent. security: - User-JWT: - tender_write requestBody: required: true content: application/json: schema: type: object properties: mode: default: FTL allOf: - x-external: true type: string default: FTL enum: - FTL - LTL description: | The transportation mode of the load. Allowed values are: - FTL: Full Truckload - LTL: Less-than-Truckload equipment_type: type: string enum: - DRV - FBE - RFR - CON - CUR - DDP - IMC - SDK - STK - BLK - TNK - OTH description: | Equipment required to transport the shipment. Recognized equipments are: - DRV: Dry Van - FBE: Flatbed - RFR: Reefer - CON: Conestoga - CUR: Curtainside - DDP: Double Drop - IMC: Intermodal - SDK: Step Deck - STK: Straight truck - BLK: Bulk - TNK: Tanker - OTH: Other equipment not explicited listed customer_ref: type: string maxLength: 255 description: Internal client's reference, such as an ID, of the tender quote_id: type: string maxLength: 40 description: Reference for the quote that should be used to book the load commodity: type: string maxLength: 255 description: Name of the commodity that will be shipped source: type: string maxLength: 64 description: Field used to indicate the context where the tender request was made (in a contract, routing guide process or spot bid, for example) weight: oneOf: - type: number - type: string description: | The total weight, in pounds, of the shipment. Acceptable values must be positive numbers with up to 2 decimal digits. Any other type will cause a validation error. Note that the minimum value is 1 and the maximum value depends on the chosen equipment_type: 45000 for DRV, 43000 for RFR and 50000 for FBE. If the weight is not provided, it is set to the maximum allowed for the equipment_type. minimum: 1 maximum: 50000 stops: type: array description: Points of interest where the truck makes a stop to either pickup or deliver a shipment. Usually a tender has one pickup stop and one delivery stop, but in some cases there will be multiple delivery stops. items: oneOf: - type: object title: Zipcode properties: type: type: string enum: - PU - DEL description: The type of the stop, can be PU (Pickup) or DEL (Delivery) facility_name: type: string description: Name of the facility at this stop facility_ref: type: string description: A reference used to identify the facility among tenders requests address: type: string city: type: string state: type: string zipcode: type: string country: type: string pattern: ^[A-Z]{3}$ description: 3-letter country code, uppercase (ISO 3166-1 alpha-3) contacts: type: array items: type: object properties: name: type: string description: Name of the person who is the contact at this stop maxLength: 255 email: type: string format: email description: Email of the contact. Required if no phone number is provided maxLength: 254 phone_number: description: Phone number of the contact. Required if email is provided type: string pattern: \+\d{4,15} maxLength: 16 required: - name window_start: description: A window start indicating the start local time of the truck at the stop (required for first stop) type: string format: naive date-time window_end: description: A window end indicating the end local time of the truck stop at the stop type: string format: naive date-time drop_trailer: type: boolean description: Indicates whether the truck will drop the trailer at the stop stop_customer_ref: type: string description: Shipper identifier for this stop instructions: type: string description: Instructions for the driver requirements: type: object description: An object with specific requirements for this stop properties: loading_type: type: string enum: - floor_loaded - palletized description: | Indicates if the load should be floor loaded in this stop, or if it's palletized required: - zipcode - country - window_start - type: object title: City & State properties: type: type: string enum: - PU - DEL facility_name: type: string description: Name of the facility at this stop facility_ref: type: string description: A reference used to identify the facility among tenders requests stop_customer_ref: type: string description: Shipper identifier for this stop address: type: string city: type: string state: type: string description: two-letters state code zipcode: type: string country: type: string pattern: ^[A-Z]{3}$ description: 3-letter country code, uppercase (ISO 3166-1 alpha-3) contacts: type: array items: type: object properties: name: type: string description: Name of the person who is the contact at this stop maxLength: 255 email: type: string format: email description: Email of the contact. Required if no phone number is provided maxLength: 254 phone_number: description: Phone number of the contact. Required if email is provided type: string pattern: \+\d{4,15} maxLength: 16 required: - name window_start: description: A window start indicating the start local time of the truck at the stop (required for first stop) type: string format: naive date-time window_end: description: A window end indicating the end local time of the truck stop at the stop (required for first stop) type: string format: naive date-time drop_trailer: type: boolean description: Indicates whether the truck will drop the trailer at the stop instructions: type: string description: Instructions for the driver required: - city - state - country - window_start - window_end minItems: 2 contacts: type: array description: At least name or phone number should be provided for each contact. items: type: object properties: name: type: string description: Name of the person who is the contact at this stop maxLength: 255 email: type: string format: email description: Email of the contact. Required if no phone number is provided maxLength: 254 phone_number: description: Phone number of the contact. Required if email is provided type: string pattern: \+\d{4,15} maxLength: 16 required: - name purchase_order_numbers: type: array description: Purchase Order Numbers for the load items: type: object properties: po_number: type: string description: Purchase order number properties: type: object description: | General information about the load. This is an open JSON field that allows passing special properties with meaning on the customer context, such as the order numbers, must_arrive_by_date, and others. properties: {} requirements: type: object description: An object with any specific requirement for this tender properties: promotion_load: type: boolean description: Indicates the load requires expediting since customer needs the product for an in-store promotion emergency_response: type: boolean description: An emergency response flag hazmat: type: boolean description: Indicates that the load must consider the presence of hazardous materials beer: type: boolean description: Indicates that the load requires permission to move beer twic: type: boolean description: Indicates if the carrier is required to have a TWIC card ctpat: type: boolean description: CTPAT recognition teams: type: boolean description: Indicates if the load requires a team of drivers food_grade: type: boolean description: Indicates if load requires food grade trailers frozen: type: boolean description: Indicates if load requires to be moved frozen produce: type: boolean description: Indicates if the load contains produce pharmaceuticals: type: boolean description: Indicates if the load contains pharmaceuticals chemicals: type: boolean description: Indicates if the load contains chemicals tsa: type: boolean description: Indicates if the carrier is required to have a TSA card hvhr: type: boolean description: Indicates if the load is high value or high risk vented_vans: type: boolean description: Indicates if the load requires vented vans bill_to: type: object description: An object with billing information properties: company_name: type: string maxLength: 255 description: Bill to Company Name address1: type: string maxLength: 255 description: Bill to address address2: type: string maxLength: 255 description: Continuation of bill to address city: type: string maxLength: 255 description: Bill to city zipcode: type: string maxLength: 255 description: Bill to zipcode state: type: string maxLength: 255 description: Bill to state country: type: string maxLength: 255 pattern: ^[A-Z]{3}$ description: 3-letter country code, uppercase (ISO 3166-1 alpha-3) bol_number: type: string maxLength: 255 description: the bill of lading number for the tender required: - customer_ref - equipment_type - stops example: equipment_type: DRV commodity: apples weight: 20000 customer_ref: a reference for the tender properties: private_id: CAR-7725B my_numbers: - 44234 - 10534 - 8875 requirements: hazmat: true bol_number: the bill of lading number for the tender quote_id: quote_12345643 purchase_order_numbers: - "12345" - ABCDE stops: - type: PU facility_name: Brothers & Sons Inc. facility_ref: asjf1984jd112o8 address: 101 Collins Avenue city: Miami Beach state: FL country: USA contacts: - name: John Doe email: john@example.com phone_number: "+17895551234" drop_trailer: false stop_customer_ref: ABC123 zipcode: "33139" window_start: 2018-06-20T09:00:00 window_end: 2018-06-20T11:00:00 instructions: Driver must arrive on time. These instructions will be sent to driver. requirements: loading_type: palletized - type: DEL facility_name: Space Ghost Coast to Coast Inc. facility_ref: ascm1394u address: 2022 Collins Avenue city: Miami Beach state: FL country: USA zipcode: "33140" contacts: - name: Space Ghost email: space@ghost.com phone_number: "+17124832133" drop_trailer: false stop_customer_ref: 343254-TP window_start: 2018-06-21T16:00:00 window_end: 2018-06-21T18:00:00 instructions: No special instructions here. requirements: loading_type: palletized bill_to: company_name: Acme address1: 1st Street address2: null city: Springfield zipcode: 12345 state: TX country: USA responses: "200": description: Tender was posted content: application/json: schema: type: object properties: data: type: object properties: id: type: string format: uuid description: Unique identifier for this load. Use this id to later match with the Webhook/load with the acceptance of the load. readOnly: true required: - id example: data: id: 3fa68364-4f39-4cf1-a042-5e57215b7150 "422": description: Invalid or missing data content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. tags: - Loads /api/v2/routes/estimate-trip-duration: get: summary: Estimate distance and duration tags: - Routes security: - Application-JWT: - routes-read - User-JWT: - routes-read description: | Estimate the distance and trip duration between an origin and destination. Origin and destination can be any valid address. parameters: - in: query name: origin schema: type: string description: Address (complete or partial) for the origin - in: query name: destination schema: type: string description: Address (complete or partial) for the destination responses: "200": description: Success content: application/json: schema: type: object properties: data: type: object properties: duration: type: string description: | Duration string following [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#iso.8601.collected.abnf) specification. miles: type: integer format: int64 description: Total miles between origin and destination example: data: duration: P1DT30H4S miles: 2412 "404": description: Address not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found "422": description: Invalid or missing data content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. /api/v2/capacity: post: summary: Create capacity description: | Inform us about a list of available trucks. The available trucks must have at least a point of pickup, the delivery is not mandatory but will increase the chances of best matching for our loads. The capacity represents an empty truck position. For different empty positions for the same truck, the available trucks and their ids must be different. We suggest that you use an uuid to represent the `ref_number` attribute on your side, because this identifier will be reused across other endpoints. tags: - Capacity security: - User-JWT: - capacity_write requestBody: required: true content: application/json: schema: oneOf: - type: array title: capacity:spot items: type: object required: - carrier_identification - ref_number - equipment_type - available_at - pickup properties: available_at: type: string description: The date and time the truck is going to be available. You must not provide timezone info. format: date-time pattern: YYYY-MM-DDThh:mm:ss delivery_deadhead: type: number description: The distance between the truck and the delivery pickup_deadhead: type: number description: The distance between the truck and the pickup expires_at: type: string format: date-time carrier_identification: description: | An identifier for the carrier. There are two ways to identify a carrier, by Loadsmart Carrier ID or by MC+DOT combination. If you provide carrier ID, you must not provide any information for MC and DOT. If you provide MC and DOT, you must not provide carrier ID information. oneOf: - title: Carrier identified by Carrier ID type: object properties: carrier_id: type: string format: uuid description: Carrier UUID (provided by Loadsmart) mc: type: string description: Carrier MC Number (Motor Carrier Number) dot: type: string description: Carrier DOT Number required: - carrier_id - title: Carrier identified by MC and DOT type: object properties: carrier_id: type: string format: uuid description: Carrier UUID (provided by Loadsmart) mc: type: string description: Carrier MC Number (Motor Carrier Number) dot: type: string description: Carrier DOT Number required: - mc - dot ref_number: type: string description: | Unique id for the given capacity, this must represent the id for this capacity on your side. This represents the empty truck location identifier. You must use different ids for different empty locations or dates, even if its the same capacity/truck. We suggest that you use an uuid to create this identifier. fleet_id: type: string description: Fleet identifier for this capacity. equipment_type: type: string enum: - DRV - FBE - RFR - CON - CUR - DDP - IMC - SDK - STK description: | Truck's type. Must be one of the following: `DRV` for Dry Van `FBE` for Flatbed `RFR` for Reefer `CON` for Conestoga `CUR` for Curtainside `DDP` for Double Drop `IMC` for Intermodal `SDK` for Step Deck `STK` for Straight Truck rate: type: number description: The all in rate for the lane. rate_per_mile: type: number description: Indicates the value per miles is_backhaul: type: boolean description: Indicates whether the capacity is backhaul or not. contacts: type: array description: A list of who should be contacted by us for this capacity. items: type: object properties: name: type: string phone_number: type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) email: type: string pickup: description: | The desired location for pickup. Certain parameters are required for this request. You must include either zipcode, state or coords. If you provide coords, you must not provide any other address information. If you include a City, then a State should also be provided to avoid ambiguous information. Missing geographical data will be automatically filled by the API. oneOf: - title: Place with State type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - state - title: Place with Zipcode type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - zipcode - title: Place with City must have State type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - city - state - title: Place with Coords type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - coords delivery: type: array description: | The desired location for delivery. Certain parameters are required for this request. You must include either zipcode, state or coords. If you provide coords, you must not provide any other address information. If you include a City, then a State should also be provided to avoid ambiguous information. Missing geographical data will be automatically filled by the API. items: oneOf: - title: Place with State type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - state - title: Place with Zipcode type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - zipcode - title: Place with City must have State type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - city - state - title: Place with Coords type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - coords - type: array title: capacity:static items: type: object required: - carrier_identification - ref_number - equipment_type - available_dow - pickup - contacts properties: available_dow: type: array description: A list of the capacity's available days of week. items: type: string enum: - Mon - Tue - Wed - Thu - Fri - Sat - Sun carrier_identification: description: | An identifier for the carrier. There are two ways to identify a carrier, by Loadsmart Carrier ID or by MC+DOT combination. If you provide carrier ID, you must not provide any information for MC and DOT. If you provide MC and DOT, you must not provide carrier ID information. oneOf: - title: Carrier identified by Carrier ID type: object properties: carrier_id: type: string format: uuid description: Carrier UUID (provided by Loadsmart) mc: type: string description: Carrier MC Number (Motor Carrier Number) dot: type: string description: Carrier DOT Number required: - carrier_id - title: Carrier identified by MC and DOT type: object properties: carrier_id: type: string format: uuid description: Carrier UUID (provided by Loadsmart) mc: type: string description: Carrier MC Number (Motor Carrier Number) dot: type: string description: Carrier DOT Number required: - mc - dot ref_number: type: string description: | Unique id for the given capacity, this must represent the id for this capacity on your side. This represents the empty truck location identifier. You must use different ids for different empty locations or dates, even if its the same capacity/truck. We suggest that you use an uuid to create this identifier. fleet_id: type: string description: Fleet identifier for this capacity. equipment_type: type: string enum: - DRV - FBE - RFR - CON - CUR - DDP - IMC - SDK - STK description: | Truck's type. Must be one of the following: `DRV` for Dry Van `FBE` for Flatbed `RFR` for Reefer `CON` for Conestoga `CUR` for Curtainside `DDP` for Double Drop `IMC` for Intermodal `SDK` for Step Deck `STK` for Straight Truck rate: type: number description: The all in rate for the lane. rate_per_mile: type: number description: Indicates the value per miles is_backhaul: type: boolean description: Indicates whether the capacity is backhaul or not. contacts: type: array description: A list of who should be contacted by us for this capacity. items: type: object properties: name: type: string phone_number: type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) email: type: string pickup: description: | The desired location for pickup. Certain parameters are required for this request. You must include either zipcode, state or coords. If you provide coords, you must not provide any other address information. If you include a City, then a State should also be provided to avoid ambiguous information. Missing geographical data will be automatically filled by the API. oneOf: - title: Place with State type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - state - title: Place with Zipcode type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - zipcode - title: Place with City must have State type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - city - state - title: Place with Coords type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - coords delivery: type: array description: | The desired location for delivery. Certain parameters are required for this request. You must include either zipcode, state or coords. If you provide coords, you must not provide any other address information. If you include a City, then a State should also be provided to avoid ambiguous information. Missing geographical data will be automatically filled by the API. items: oneOf: - title: Place with State type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - state - title: Place with Zipcode type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - zipcode - title: Place with City must have State type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - city - state - title: Place with Coords type: object properties: city: type: string description: Name of city state: type: string description: Two letter state or equivalent administrative boundary zipcode: type: string description: zipcode (first five digits) country: type: string pattern: ^[A-Z]{3}$ description: | 3-letter country code, uppercase (ISO 3166-1 alpha-3) If no country is provided, 'USA' is inferred. coords: type: object required: - latitude - longitude properties: latitude: type: number description: Approximate latitude for the place longitude: type: number description: Approximate longitude for the place required: - coords examples: Spot Capacity: value: - available_at: 2018-11-22T10:00:00 carrier_id: 9f87d040-f843-42e7-887a-45bea55e76f3 ref_number: c6786277-e20e-4e0e-b28b-972d7bac365b fleet_id: XYZ123 equipment_type: DRV rate: 1200 is_backhaul: false contacts: - name: Foo Bar phone_number: 1111111111 pickup: city: New York state: NY zipcode: "10013" country: USA delivery: city: Nashville state: TN zipcode: "37011" country: USA Static Capacity: value: - available_dow: - Mon - Sun carrier_id: 9f87d040-f843-42e7-887a-45bea55e76f3 ref_number: c6786277-e20e-4e0e-b28b-972d7bac365b fleet_id: XYZ123 equipment_type: DRV rate: 1200 is_backhaul: false contacts: - name: Foo Bar phone_number: 1111111111 pickup: city: New York state: NY zipcode: "10013" country: USA delivery: city: Nashville state: TN zipcode: "37011" country: USA Capacity with coords: value: - available_at: 2018-11-22T10:00:00 carrier_id: 9f87d040-f843-42e7-887a-45bea55e76f3 ref_number: c6786277-e20e-4e0e-b28b-972d7bac365b fleet_id: XYZ123 equipment_type: DRV rate: 1200 is_backhaul: false contacts: - name: Foo Bar phone_number: 1111111111 pickup: coords: latitude: 40.7128 longitude: -74.006 delivery: city: Nashville state: TN zipcode: "37011" country: USA responses: "202": description: All provided data is valid and the available trucks are being created "422": description: Payload is invalid and a capacity can't be created content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: invalid_data error_description: Can't create the object errors: field_name: - This field is required. other_field: - Expected string but received integer. "/api/v2/capacity/{capacity_ref_number}": delete: summary: Delete a Capacity tags: - Capacity security: - User-JWT: - capacity_write parameters: - in: path name: ref_number required: true schema: type: string description: | Unique id for the given capacity, this must represent the id for this capacity on your side. This represents the empty truck location identifier. You must use different ids for different empty locations or dates, even if its the same capacity/truck. We suggest that you use an uuid to create this identifier. responses: "204": description: Capacity deleted "404": description: Capacity not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found /api/v2/webhooks/url: get: summary: List Webhooks security: - Application-JWT: - webhook_read description: | Lists all webhooks registered for the authenticated client responses: "200": description: Event received content: application/json: schema: type: object properties: count: description: Number of objects found type: number format: integer next: description: URL for next page of results type: string format: url previous: description: URL for previous page of results type: string format: url results: type: array items: allOf: - type: object properties: uuid: description: Webhook unique identifier type: string format: uuid - type: object properties: events: type: array items: type: string enum: - load:accepted - load:rejected - quote:booked - quote:book-failed - quote:rejected - shipment:invoice - shipment:carrier-dropped - shipment:carrier-updated - shipment:appointment-pickup - shipment:appointment-delivery - shipment:driver-assigned - shipment:driver-unassigned - shipment:en-route-to-pickup - shipment:check-in-pickup - shipment:check-out-pickup - shipment:en-route-to-delivery - shipment:check-in-delivery - shipment:check-out-delivery - shipment:pickup-late - shipment:delivery-late - shipment:location-updated - shipment:canceled - shipment:incident - shipment:updated - carrier:tender:accepted - carrier:tender:canceled - carrier:status:changed - integration-request:accepted - integration-request:rejected - bid:expired - bid:timed_out - bid:refused - bid:awarded - bid:accepted url: type: string format: URL description: URL to post the webhooks required: - url - events example: count: 2 next: null previous: null results: - uuid: d630d8fe-9859-453f-aed2-372a1b09345c url: https://www.example.com/my/awsome/webhook_1 events: - load:accepted - carrier:tender:accepted - uuid: 8f62fea9-1edb-4f31-b2e5-dcf184b5a22b url: https://www.example.com/my/awsome/webhook_2 events: - integration-request:accepted tags: - Webhooks post: summary: Register webhooks security: - Application-JWT: - webhook_write description: | Create webhooks configuration requestBody: required: true content: application/json: schema: type: object properties: events: type: array items: type: string enum: - load:accepted - load:rejected - quote:booked - quote:book-failed - quote:rejected - shipment:invoice - shipment:carrier-dropped - shipment:carrier-updated - shipment:appointment-pickup - shipment:appointment-delivery - shipment:driver-assigned - shipment:driver-unassigned - shipment:en-route-to-pickup - shipment:check-in-pickup - shipment:check-out-pickup - shipment:en-route-to-delivery - shipment:check-in-delivery - shipment:check-out-delivery - shipment:pickup-late - shipment:delivery-late - shipment:location-updated - shipment:canceled - shipment:incident - shipment:updated - carrier:tender:accepted - carrier:tender:canceled - carrier:status:changed - integration-request:accepted - integration-request:rejected - bid:expired - bid:timed_out - bid:refused - bid:awarded - bid:accepted url: type: string format: URL description: URL to post the webhooks required: - url - events responses: "201": description: Success content: application/json: schema: allOf: - type: object properties: uuid: description: Webhook unique identifier type: string format: uuid - type: object properties: events: type: array items: type: string enum: - load:accepted - load:rejected - quote:booked - quote:book-failed - quote:rejected - shipment:invoice - shipment:carrier-dropped - shipment:carrier-updated - shipment:appointment-pickup - shipment:appointment-delivery - shipment:driver-assigned - shipment:driver-unassigned - shipment:en-route-to-pickup - shipment:check-in-pickup - shipment:check-out-pickup - shipment:en-route-to-delivery - shipment:check-in-delivery - shipment:check-out-delivery - shipment:pickup-late - shipment:delivery-late - shipment:location-updated - shipment:canceled - shipment:incident - shipment:updated - carrier:tender:accepted - carrier:tender:canceled - carrier:status:changed - integration-request:accepted - integration-request:rejected - bid:expired - bid:timed_out - bid:refused - bid:awarded - bid:accepted url: type: string format: URL description: URL to post the webhooks required: - url - events example: uuid: d630d8fe-9859-453f-aed2-372a1b09345c url: https://www.example.com/my/awsome/webhook_1 events: - load:accepted - carrier:tender:accepted "400": description: Invalid parameters content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description tags: - Webhooks "/api/v2/webhooks/url/{uuid}": get: summary: Retrieve webhook tags: - Webhooks security: - Application-JWT: - webhook_read description: | Retrieve webhook configuration parameters: - in: path name: uuid schema: description: Webhook unique identifier (UUID) type: string format: uuid required: true responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: uuid: description: Webhook unique identifier type: string format: uuid - type: object properties: events: type: array items: type: string enum: - load:accepted - load:rejected - quote:booked - quote:book-failed - quote:rejected - shipment:invoice - shipment:carrier-dropped - shipment:carrier-updated - shipment:appointment-pickup - shipment:appointment-delivery - shipment:driver-assigned - shipment:driver-unassigned - shipment:en-route-to-pickup - shipment:check-in-pickup - shipment:check-out-pickup - shipment:en-route-to-delivery - shipment:check-in-delivery - shipment:check-out-delivery - shipment:pickup-late - shipment:delivery-late - shipment:location-updated - shipment:canceled - shipment:incident - shipment:updated - carrier:tender:accepted - carrier:tender:canceled - carrier:status:changed - integration-request:accepted - integration-request:rejected - bid:expired - bid:timed_out - bid:refused - bid:awarded - bid:accepted url: type: string format: URL description: URL to post the webhooks required: - url - events example: uuid: d630d8fe-9859-453f-aed2-372a1b09345c url: https://www.example.com/my/awsome/webhook_1 events: - load:accepted - carrier:tender:accepted "404": description: Webhook configuration not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found put: summary: Update webhook tags: - Webhooks security: - Application-JWT: - webhook_write description: | Update webhook configuration parameters: - in: path name: uuid schema: description: Webhook unique identifier (UUID) type: string format: uuid required: true requestBody: required: true content: application/json: schema: type: object properties: events: type: array items: type: string enum: - load:accepted - load:rejected - quote:booked - quote:book-failed - quote:rejected - shipment:invoice - shipment:carrier-dropped - shipment:carrier-updated - shipment:appointment-pickup - shipment:appointment-delivery - shipment:driver-assigned - shipment:driver-unassigned - shipment:en-route-to-pickup - shipment:check-in-pickup - shipment:check-out-pickup - shipment:en-route-to-delivery - shipment:check-in-delivery - shipment:check-out-delivery - shipment:pickup-late - shipment:delivery-late - shipment:location-updated - shipment:canceled - shipment:incident - shipment:updated - carrier:tender:accepted - carrier:tender:canceled - carrier:status:changed - integration-request:accepted - integration-request:rejected - bid:expired - bid:timed_out - bid:refused - bid:awarded - bid:accepted url: type: string format: URL description: URL to post the webhooks required: - url - events responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: uuid: description: Webhook unique identifier type: string format: uuid - type: object properties: events: type: array items: type: string enum: - load:accepted - load:rejected - quote:booked - quote:book-failed - quote:rejected - shipment:invoice - shipment:carrier-dropped - shipment:carrier-updated - shipment:appointment-pickup - shipment:appointment-delivery - shipment:driver-assigned - shipment:driver-unassigned - shipment:en-route-to-pickup - shipment:check-in-pickup - shipment:check-out-pickup - shipment:en-route-to-delivery - shipment:check-in-delivery - shipment:check-out-delivery - shipment:pickup-late - shipment:delivery-late - shipment:location-updated - shipment:canceled - shipment:incident - shipment:updated - carrier:tender:accepted - carrier:tender:canceled - carrier:status:changed - integration-request:accepted - integration-request:rejected - bid:expired - bid:timed_out - bid:refused - bid:awarded - bid:accepted url: type: string format: URL description: URL to post the webhooks required: - url - events example: uuid: d630d8fe-9859-453f-aed2-372a1b09345c url: https://www.example.com/my/awsome/webhook_1 events: - load:accepted - carrier:tender:accepted "400": description: Invalid parameters content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description "404": description: Webhook configuration not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found delete: summary: Delete webhook tags: - Webhooks security: - Application-JWT: - webhook_write description: | Delete webhook configuration parameters: - in: path name: uuid schema: description: Webhook unique identifier (UUID) type: string format: uuid required: true responses: "204": description: No Content "404": description: Webhook configuration not found content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: object_not_found error_description: Object not found /quote-webhooks: post: summary: Quote Events description: | Posts a message when an event about a quote is triggered. The quote event payload has a base schema but the details change depending on the event type. During the onboarding you can let Loadsmart know which events you want to receive. You can also receive events in more than one URL. List of event types: - quote:booked - quote:rejected requestBody: content: application/json: schema: oneOf: - type: object title: quote:booked properties: details: type: object properties: event: type: object properties: sender_id: type: string description: The identification of the party that is sending this message nullable: true receiver_id: type: string description: The identification of the party that is receiving this message nullable: true shipment: type: object properties: id: type: string format: uuid description: The shipment identifier bol_number: type: string description: The bill of lading number equipment_type: type: string description: The type of truck used to move the load equipment_size: type: integer description: The size of the truck used to move the load, in feet purchase_order_number: type: string description: The Purchase Order (PO) number nullable: true ref_number: type: string description: The load number from its shipper loadsmart_ref_number: type: string description: Internal identifier stops: type: array minItems: 1 items: type: object properties: date: type: string format: date-time description: The date and time of the stop city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: type: object description: General localization attributes properties: latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located shipper: type: object properties: id: type: string format: uuid description: The shipper identifier name: type: string description: The shipper name created_at: type: string format: date-time description: The date and time of the event. type: type: string description: Event type - type: object title: quote:rejected properties: details: type: object properties: quote: type: object properties: id: type: string description: The quote identifier customer_reference: type: string description: The quoted shipment identifier on the shipper side shipper: type: object properties: id: type: string format: uuid description: The shipper identifier name: type: string description: The shipper name created_at: type: string format: date-time description: The date and time of the event. type: type: string description: Event type examples: BookedQuote: value: type: quote:booked created_at: 2019-09-09T14:14:14.044Z details: event: sender_id: Loadsmart receiver_id: Your Company shipment: id: 515cf5a61d004b87abecc6988d75619c bol_number: FHC-1234BR equipment_type: DRV equipment_size: 53 purchase_order_number: GA452686 ref_number: SKT8678K stops: - city: Orange state: MA zipcode: "01364" country: USA stop_index: 0 date: 2018-09-19T13:30:00.000000-04:00 location: latitude: 42.35725 longitude: -72.18648 - city: Red Bluff state: CA zipcode: "96080" country: USA stop_index: 1 date: 2018-09-22T17:00:00.000000-04:00 location: latitude: 40.043325 longitude: -122.34648 shipper: id: 5d5f9e1b49d543eba0d5744237357e66 name: Stark Industries RejectedQuote: value: type: quote:rejected created_at: 2019-09-09T14:14:14.044Z details: quote: id: 556152bb26824d1abc65ba2d0af1532d customer_reference: DAY2357V shipper: id: db0da78773884ecd9975af1c9d53e8b8 name: Acme Inc. responses: "200": description: Event received tags: - Webhooks /shipment-webhooks: post: summary: Shipment Events description: | Posts a message when an event about a shipment is triggered. The shipment event payload has a base schema but the details change depending on the event type. During the onboarding you can let Loadsmart know which events you want to receive. You can also receive events in more than one URL. List of event types: - shipment:appointment-pickup - shipment:appointment-delivery - shipment:en-route-to-pickup - shipment:check-in-pickup - shipment:check-out-pickup - shipment:check-in-delivery - shipment:check-out-delivery - shipment:carrier-updated - shipment:carrier-dropped - shipment:location-updated - shipment:driver-assigned - shipment:driver-unassigned - shipment:canceled - shipment:incident - shipment:invoice - shipment:updated - shipment:created requestBody: content: application/json: schema: oneOf: - type: object title: shipment:appointment-pickup properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: appointment: type: object description: The date and time interval of the appointment and its confirmation flag properties: start: type: date-time description: Appointment start timestamp end: type: date-time description: Appointment end timestamp confirmed: deprecated: true type: boolean description: Will always be true event_date: deprecated: true format: date-time description: The date and time of the event stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. reason: type: string description: The reason for changing the appointment enum: - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - driver_not_available - insufficient_pickup_time - load_shifted - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - other - other_carrier_related - past_cut_off_time - refused_by_customer - road_conditions - shipment_overweight - shipper_related - suspended_at_customer_request - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - waiting_shipping_instruction shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:appointment-delivery properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: appointment: type: object description: The date and time interval of the appointment and its confirmation flag properties: start: type: date-time description: Appointment start timestamp end: type: date-time description: Appointment end timestamp confirmed: type: boolean description: Appointment confirmation event_date: deprecated: true format: date-time description: The date and time of the event stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. reason: type: string description: The reason for changing the appointment enum: - address_corrected_delivery_attempted - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - driver_not_available - held_per_shipper - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - other - other_carrier_related - past_cut_off_time - recipient_unavailable_delivery_delayed - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - suspended_at_customer_request - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - waiting_shipping_instructions shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:en-route-to-pickup properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:check-in-pickup properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. is_late: type: boolean description: Indicate if the check in/out event is late. late_reason: description: Indicate the reason which caused the delay. nullable: true enum: - accident - address_corrected_delivery_attempted - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - customer_wanted_earlier_delivery - driver_not_available - driver_related - held_per_shipper - hold_due_customs_documentation_problems - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - past_cut_off_time - previous_stop - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product is_last_stop: type: boolean description: Indicate if the stop is the last one. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:check-out-pickup properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. is_late: type: boolean description: Indicate if the check in/out event is late. late_reason: description: Indicate the reason which caused the delay. nullable: true enum: - accident - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - consignee_related - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_per_shipper - hold_due_customs_documentation_problems - improper_unloading_facility_or_equipment - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - past_cut_off_time - previous_stop - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - waiting_shipping_instructions is_last_stop: type: boolean description: Indicate if the stop is the last one. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:check-in-delivery properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. is_late: type: boolean description: Indicate if the check in/out event is late. late_reason: description: Indicate the reason which caused the delay. nullable: true enum: - accident - address_corrected_delivery_attempted - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - customer_wanted_earlier_delivery - driver_not_available - driver_related - held_per_shipper - hold_due_customs_documentation_problems - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - past_cut_off_time - previous_stop - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product is_last_stop: type: boolean description: Indicate if the stop is the last one. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:check-out-delivery properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. is_late: type: boolean description: Indicate if the check in/out event is late. late_reason: description: Indicate the reason which caused the delay. nullable: true enum: - accident - carrier_dispatch_error - carrier_keying_error - closed_holiday - consignee_closed - consignee_related - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_per_shipper - hold_due_customs_documentation_problems - improper_unloading_facility_or_equipment - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - past_cut_off_time - previous_stop - reconsigned - refused_by_customer - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - waiting_shipping_instructions is_last_stop: type: boolean description: Indicate if the stop is the last one. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: "[DEPRECATED] shipment:pickup-late" properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: "[DEPRECATED] shipment:delivery-late" properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: event_date: format: date-time description: The date and time of the event. eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions stop_index: type: integer description: Indicate the stop number for this event, being 0-based for pickup. shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:carrier-updated properties: details: type: object properties: carrier: type: object properties: id: type: string format: uuid name: type: string maxLength: 255 mc_number: type: string maxLength: 255 nullable: true dot_number: type: string maxLength: 255 nullable: true tractor_number: type: string maxLength: 70 nullable: true trailer_number: type: string maxLength: 70 nullable: true shipment: type: object properties: loadsmart_ref_number: type: string description: Internal identifier ref_number: type: string description: Reference number shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:carrier-dropped properties: details: type: object nullable: true shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:location-updated properties: details: type: object properties: shipment: type: object properties: loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: properties: latitude: type: number format: float description: The location latitude nullable: true longitude: type: number format: float description: The location longitude nullable: true city: type: string description: City name of the last tracked location minLength: 1 maxLength: 40 state: type: string description: State of the last tracked location minLength: 2 maxLength: 2 country: type: string description: Country of the last tracked location. Based on ISO 3166 - Alpha 3 code minLength: 3 maxLength: 3 direction: type: string enum: - NE - SE - NW - SW event_date: type: string format: date-time description: The date and time the carrier was tracked, using actual time if not informed. eta: type: string format: date-time description: The estimated time of arrival. late_reason: description: Indicate the reason which caused the delay. nullable: true enum: - accident - carrier_dispatch_error - carrier_keying_error - closed_holiday - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - hold_due_customs_documentation_problems - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - load_shifted - mechanical_breakdown - missed_delivery - missed_pickup - missing_documents - natural_disaster_related - normal_status - other - other_carrier_related - previous_stop - reconsigned - road_conditions - shipment_overweight - shipper_related - tractor_conventional_not_available - tractor_with_sleeper_car_not_available - trailer_not_available - trailer_not_usable_due_to_prior_product - unable_locate - waiting_inspection shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:driver-assigned properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: sender_id: type: string nullable: true receiver_id: type: string nullable: true driver: type: object properties: id: type: string format: uuid name: type: string maxLength: 255 phone_number: type: string pattern: \+\d{4,15} maxLength: 16 description: Phone number following the format [E.164](https://www.itu.int/rec/T-REC-E.164/) shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:driver-unassigned properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object properties: sender_id: type: string nullable: true receiver_id: type: string nullable: true shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:canceled properties: details: type: object properties: reason: type: string enum: - shipper - carrier - loadsmart - other details: type: string shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:incident properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name event: type: object title: shipment:incident properties: type: type: string description: The type of the incident enum: - detention_loading - detention_unloading - truck_breakdown - driver_late_shipper - driver_late_receiver - TONU - transit_check - OSD - misc - lumper - no_contact_with_dispatcher - no_contact_with_driver - driver_risk_miss_appointment - rejected_load - truck_overweight - other reason: type: string description: The reason which caused the incident enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions eta: type: string format: date-time description: A new ETA after the incident notes: type: string description: Any additional information required: - type shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:invoice properties: details: type: object properties: event: type: object properties: invoice_number: type: string description: The invoice identifier number weight: type: integer description: The shipment weight lading_quantity: type: integer description: The amount of lading in the shipment invoice_date: type: string format: date-time description: The date and time of the invoice pu_appointment: type: string format: date-time description: The pickup appointment date and time pu_checkin: type: string format: date-time description: The check in at pickup date and time pu_checkout: type: string format: date-time description: The check out from pickup date and time del_appointment: type: string format: date-time description: The delivery appointment date and time del_checkin: type: string format: date-time description: The check in at delivery date and time del_checkout: type: string format: date-time description: The check out from delivery date and time total_invoice_amount: type: number description: The total amount of the invoice bill_to: deprecated: true type: object description: Address information for where to bill the shipment properties: company_name: type: string description: Company name address1: type: string description: Address line 1 address2: type: string description: Address line 2 city: type: string description: City zipcode: type: string description: Zipcode state: type: string description: State (e.g. MI, FL...) country: type: string description: Country (e.g. USA, CAN...) lines: type: array description: A list of all the invoice items items: type: object properties: item_no: type: string description: The type of the item enum: - all_in_rate - accessorial - detention - lumper_fee - tonu - layover - stop_off - rate_adjustment - claim - other - quickpay - demurrage - fuel_surcharge description: type: string description: A description of the item unit_price: type: number description: The price of the item stop_index: type: integer nullable: true description: Indicate the stop number, being 0-based for pickup shipment: type: object properties: bol_number: type: string description: Bill of Lading number commodity: type: string description: The shipment commodity id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier miles: type: double description: Total miles between origin and destination purchase_order_number: type: string description: Purchase order number purchase_order_numbers: type: array description: A list of all shipment's purchase order numbers items: type: string ref_number: type: string description: Reference number stops: type: array description: A list of all shipment stops items: type: object properties: address: type: string description: Stop address city: type: string description: Stop city country: type: string description: Stop country. Ex. USA stop_customer_ref: type: string description: Shipper identifier for the stop company_name: type: string description: Company name stop_index: type: integer description: Indicate the stop number, being 0-based for pickup state: type: string description: Stop state type: type: string description: Stop type enum: - pickup - delivery zipcode: type: string description: Stop zipcode facility: description: Facility information properties: company_name: type: string description: Facility's company name ref: type: string description: Facility's identifier number address: type: string description: Facility's address city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string tractor_number: type: string description: Tractor number trailer_number: type: string description: Trailer number properties: type: object description: Shipment misc properties bill_to: type: object description: Address information for where to bill the shipment properties: company_name: type: string description: Company name address1: type: string description: Address line 1 address2: type: string description: Address line 2 city: type: string description: City zipcode: type: string description: Zipcode state: type: string description: State (e.g. MI, FL...) country: type: string description: Country (e.g. USA, CAN...) contracted: type: boolean description: True whether the shipment was booked through a contract with the Shipper shipper: type: object properties: id: type: string format: uuid description: The shipper identified name: type: string description: The shipper name shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:created properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. weight: type: string description: Shipment's weight (string formatted decimal) must_arrive_by_date: type: string description: Deadline to delivery load must_ship_by_date: type: string description: Deadline to ship load container: type: object nullable: true description: Container related info properties: is_live: type: boolean description: True if it is a live load, False if it is a drop load number: type: string description: Unique container identifier ocean_bol_number: type: string description: Ocean bill of lading identifier number stops: type: array description: All shipment stops minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string properties: type: object description: JSON object where you can set custom properties stop: type: object description: Event stop details properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General localization attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located delay: deprecated: true type: object description: Delay is an optional field and will only exist if there is a new ETA and a reason for the delay properties: eta: format: date-time description: New ETA. reason: type: string description: The reason which caused the delay enum: - accident - border_clearance - carrier_dispatch_error - closed_holiday - consignee_closed - consignee_related - customer_requested_future_delivery - customer_wanted_earlier_delivery - delivery_shortage - driver_not_available - driver_related - held_pending_appointment - held_per_shipper - incorrect_address - insufficient_delivery_time - insufficient_pickup_time - insufficient_time_to_complete_delivery - mechanical_breakdown - missed_delivery - missed_pickup - natural_disaster_related - normal_status - no_requested_arrival_date_provided_by_shipper - no_requested_arrival_time_provided_by_shipper - other - other_carrier_related - past_cut_off_time - previous_stop - receiving_time_restricted - recipient_unavailable_delivery_delayed - refused_customer - road_conditions - shipment_overweight - shipper_related - trailer_not_available - unable_locate - waiting_shipping_instructions event: type: object title: shipment:created shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type - type: object title: shipment:updated properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier loadsmart_ref_number: type: string description: Internal identifier bol_number: type: string description: Bill of Lading number equipment_type: type: string description: The type of truck used to move the load trailer_number: type: string description: Carriers trailer number ref_number: type: string description: Reference number carrier_pro: type: string description: Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. truck_license_plate: type: string description: License Plate attached to a truck for official identification purposes. stops: type: array minItems: 1 items: type: object properties: city: type: string description: This stop city state: type: string description: This stop state country: type: string description: This stop country stop_customer_ref: type: string description: Shipper identifier for the stop facility_ref: type: string description: Shipper identifier for the facility zipcode: type: string description: This stop zipcode timezone: type: string description: This stop timezone stop_index: type: number description: Indicate the stop number for this event, being 0-based for pickup. location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located facility: description: Facility information properties: company_name: type: string description: Facility's company name city: type: string description: Facility's city state: type: string description: Facility's state zipcode: type: string description: Facility's zipcode timezone: type: string description: Facility's timezone location: description: General location attributes properties: gln: type: string nullable: true description: GS1 Global Location Number if registered. latitude: type: number description: The latitude where the stop is located longitude: type: number description: The longitude where the stop is located contact: description: Facility contact information properties: first_name: type: string last_name: type: string phone_number: type: string email: type: string event: type: object title: shipment:updated shipment_id: type: string format: uuid description: The shipment identifier created_at: type: string format: date-time description: The date and time of the event creation type: type: string description: Event type example: type: shipment:en-route-to-pickup created_at: 2018-06-19T10:30:00.000Z details: shipper: id: 5d5f9e1b-49d5-43eb-a0d5-744237357e66 name: Stark Industries shipment: trailer_number: "9437" bol_number: "31871465" equipment_type: DRV properties: private_id: CAR-7725B my_numbers: - 44234 - 10534 - 8875 container: is_live: true number: MSK12345 ocean_bol_number: o123c stop: city: Los Angeles state: CA country: USA zipcode: "89109" timezone: America/Los_Angeles stop_index: 0 stop_customer_ref: ABC1234 facility_ref: BCD2345 delay: eta: 2018-06-19T20:10:00Z reason: accident location: gln: null latitude: 34.0207305 longitude: -118.6919139 stops: - city: Los Angeles state: CA country: USA facility_ref: BCD2345 zipcode: "89109" timezone: America/Los_Angeles stop_index: 0 stop_customer_ref: ABC1234 delay: eta: 2018-06-19T20:10:00Z reason: accident location: gln: null latitude: 34.0207305 longitude: -118.6919139 facility: company_name: Loadsmart address: 123 Street city: Los Angeles state: CA zipcode: "89109" timezone: America/Los_Angeles contact: first_name: John last_name: Doe phone_number: "1111111111" email: "" event: stop_index: 0 event_date: 2018-06-19T10:10:00Z responses: "200": description: Event received tags: - Webhooks /load-webhooks: post: summary: Load Events description: | Posts a message when an event about a load is triggered. The load event payload has a base schema but the details change depending on the event type. During the onboarding you can let Loadsmart know which events you want to receive. You can also receive events in more than one URL. Difference between load and shipment: Although loads and shipments usually refer to the same thing, Loadsmart handles them as two slightly different entities. Up to the point when a load is tendered and booked, the entity in play is a "load". After this load is booked, it becomes a shipment. From this point on, communication is done with the shipment. List of event types: - load:rejected - load:accepted requestBody: content: application/json: schema: oneOf: - type: object title: load:accepted properties: details: type: object properties: shipment: type: object properties: id: type: string format: uuid description: The shipment identifier load: type: object properties: id: type: string format: uuid description: The load identifier received in the /api/v2/loads/tender endpoint ref_number: type: string description: The load identifier on the customer's side properties: type: object description: | General information about the load. This is an open JSON field that allows passing special properties with meaning on the customer context, such as the order numbers, must_arrive_by_date, and others. shipper: type: object properties: id: type: string format: uuid description: The shipper identifier created_at: type: string format: date-time description: The date and time of the event. type: type: string description: Event type - type: object title: load:rejected properties: details: type: object properties: load: type: object properties: id: type: string format: uuid description: The load identifier received in the /api/v2/loads/tender endpoint ref_number: type: string description: The load identifier on the customer's side properties: type: object description: | General information about the load. This is an open JSON field that allows passing special properties with meaning on the customer context, such as the order numbers, must_arrive_by_date, and others. shipper: type: object properties: id: type: string format: uuid description: The shipper identifier created_at: type: string format: date-time description: The date and time of the event. type: type: string description: Event type examples: load:accepted: value: type: load:accepted created_at: 2018-06-19T10:45:00.000Z details: shipper: id: db0da787-7388-4ecd-9975-af1c9d53e8b8 load: id: 06aa28df-4f5c-4db7-b779-270f27e21713 ref_number: DAY2357V properties: customer_id: 123456 custom_field: custom_value shipment: id: 0bec679a-df08-4c60-8b97-0ff702fa8729 load:rejected: value: type: load:rejected created_at: 2019-09-09T14:14:14.044Z details: shipper: id: db0da78773884ecd9975af1c9d53e8b8 load: id: 06aa28df4f5c4db7b779270f27e21713 ref_number: DAY2357V properties: customer_id: 123456 custom_field: custom_value responses: "200": description: Event received tags: - Webhooks /bid-webhooks: post: summary: Bid Events description: | Posts a message when an event about a Bid is triggered. The bid event payload has the same schema for all bid event types. requestBody: content: application/json: schema: oneOf: - type: object title: bid:expired properties: details: type: object properties: id: type: string format: uuid description: Bid unique identifier (UUID) offer_id: type: string format: uuid description: Offer unique identifier (UUID) price: type: string format: uuid description: Bid price (USD). created_at: type: datetime format: date-time description: Bid creation datetime expires_at: type: datetime format: date-time description: The bid expiration datetime expired_at: type: datetime format: date-time description: The bid datetime that bid was expirated status: type: string enum: - pending - awarded - accepted - timed_out - refused description: Bid status. created_at: type: string format: date-time description: The date and time of the event. type: type: string description: Event type enum: - bid:expired - bid:timed_out - bid:refused - bid:awarded - bid:accepted - type: object title: bid:timed_out properties: details: type: object properties: id: type: string format: uuid description: Bid unique identifier (UUID) offer_id: type: string format: uuid description: Offer unique identifier (UUID) price: type: string format: uuid description: Bid price (USD). created_at: type: datetime format: date-time description: Bid creation datetime expires_at: type: datetime format: date-time description: The bid expiration datetime expired_at: type: datetime format: date-time description: The bid datetime that bid was expirated status: type: string enum: - pending - awarded - accepted - timed_out - refused description: Bid status. created_at: type: string format: date-time description: The date and time of the event. type: type: string description: Event type enum: - bid:expired - bid:timed_out - bid:refused - bid:awarded - bid:accepted - type: object title: bid:refused properties: details: type: object properties: id: type: string format: uuid description: Bid unique identifier (UUID) offer_id: type: string format: uuid description: Offer unique identifier (UUID) price: type: string format: uuid description: Bid price (USD). created_at: type: datetime format: date-time description: Bid creation datetime expires_at: type: datetime format: date-time description: The bid expiration datetime expired_at: type: datetime format: date-time description: The bid datetime that bid was expirated status: type: string enum: - pending - awarded - accepted - timed_out - refused description: Bid status. created_at: type: string format: date-time description: The date and time of the event. type: type: string description: Event type enum: - bid:expired - bid:timed_out - bid:refused - bid:awarded - bid:accepted - type: object title: bid:awarded properties: details: type: object properties: id: type: string format: uuid description: Bid unique identifier (UUID) offer_id: type: string format: uuid description: Offer unique identifier (UUID) price: type: string format: uuid description: Bid price (USD). created_at: type: datetime format: date-time description: Bid creation datetime expires_at: type: datetime format: date-time description: The bid expiration datetime expired_at: type: datetime format: date-time description: The bid datetime that bid was expirated status: type: string enum: - pending - awarded - accepted - timed_out - refused description: Bid status. created_at: type: string format: date-time description: The date and time of the event. type: type: string description: Event type enum: - bid:expired - bid:timed_out - bid:refused - bid:awarded - bid:accepted - type: object title: bid:awarded properties: details: type: object properties: id: type: string format: uuid description: Bid unique identifier (UUID) offer_id: type: string format: uuid description: Offer unique identifier (UUID) price: type: string format: uuid description: Bid price (USD). created_at: type: datetime format: date-time description: Bid creation datetime expires_at: type: datetime format: date-time description: The bid expiration datetime expired_at: type: datetime format: date-time description: The bid datetime that bid was expirated status: type: string enum: - pending - awarded - accepted - timed_out - refused description: Bid status. created_at: type: string format: date-time description: The date and time of the event. type: type: string description: Event type enum: - bid:expired - bid:timed_out - bid:refused - bid:awarded - bid:accepted - type: object title: bid:accepted properties: details: type: object properties: id: type: string format: uuid description: Bid unique identifier (UUID) offer_id: type: string format: uuid description: Offer unique identifier (UUID) price: type: string format: uuid description: Bid price (USD). created_at: type: datetime format: date-time description: Bid creation datetime expires_at: type: datetime format: date-time description: The bid expiration datetime expired_at: type: datetime format: date-time description: The bid datetime that bid was expirated status: type: string enum: - pending - awarded - accepted - timed_out - refused description: Bid status. created_at: type: string format: date-time description: The date and time of the event. type: type: string description: Event type examples: bid:expired: value: type: bid:expired created_at: 2021-06-02T10:45:00.000Z details: id: 2217d4d1-bf82-4a77-90d8-8b2eda1c82c2 offer_id: eb405734-a58a-4f45-8cb5-6a514b58503a price: "4300.00" created_at: 2021-07-02T10:45:00.557Z expires_at: 2021-07-02T11:00:00.557Z expired_at: 2021-07-02T11:00:01.557Z status: timed_out bid:timed_out: value: type: bid:timed_out created_at: 2021-06-02T10:45:00.000Z details: id: 2217d4d1-bf82-4a77-90d8-8b2eda1c82c2 offer_id: eb405734-a58a-4f45-8cb5-6a514b58503a price: "4300.00" created_at: 2021-07-02T10:45:00.557Z expires_at: 2021-07-02T11:00:00.557Z expired_at: 2021-07-02T11:00:00.557Z status: timed_out bid:refused: value: type: bid:refused created_at: 2021-06-02T10:45:00.000Z details: id: 2217d4d1-bf82-4a77-90d8-8b2eda1c82c2 offer_id: eb405734-a58a-4f45-8cb5-6a514b58503a price: "4300.00" created_at: 2021-07-02T10:45:00.557Z expires_at: 2021-07-02T11:00:00.557Z expired_at: null status: refused bid:awarded: value: type: bid:awarded created_at: 2021-06-02T10:45:00.000Z details: id: 2217d4d1-bf82-4a77-90d8-8b2eda1c82c2 offer_id: eb405734-a58a-4f45-8cb5-6a514b58503a price: "4300.00" created_at: 2021-07-02T10:45:00.557Z expires_at: 2021-07-02T11:00:00.557Z expired_at: null status: awarded bid:accepted: value: type: bid:accepted created_at: 2021-06-02T10:45:00.000Z details: id: 2217d4d1-bf82-4a77-90d8-8b2eda1c82c2 offer_id: eb405734-a58a-4f45-8cb5-6a514b58503a price: "4300.00" created_at: 2021-07-02T10:45:00.557Z expires_at: 2021-07-02T11:00:00.557Z expired_at: null status: accepted responses: "200": description: Event received tags: - Webhooks /carrier-webhooks: post: summary: Carrier Events description: | Posts a message when an event about a Carrier is triggered. requestBody: content: application/json: schema: oneOf: - type: object title: carrier:status:changed properties: details: type: object properties: id: type: string format: uuid description: Unique Identifier of the Carrier on Loadsmart mc: type: string format: integer description: Carrier Interstate Operating Authority (MC number) dot: type: string format: integer description: Carrier US DOT Number name: type: string description: Carrier legal name eligible: type: bool description: Flag that report if the Carrier is eligible to carry loads status: type: string enum: - New - Pending - Ready - Inactive description: Carrier status on Loadsmart previous_status: type: string enum: - New - Pending - Ready - Inactive description: Carrier previous status on Loadsmart created_at: type: string format: date-time description: The date and time of the event. type: type: string description: Event type enum: - carrier:status:changed examples: carrier:status:changed: value: type: carrier:status:changed created_at: 2022-08-30T10:45:00.000Z details: id: 9b739d7a-b4db-45f7-a61b-990c7ac77082 dot: "2953461" mc: "456" status: Ready previous_status: Pending eligible: true name: J R T TRANS CORP responses: "200": description: Event received tags: - Webhooks /integration-request: post: summary: Integration Request Events description: | Posts a message when an event about an integration request is triggered. The event payload has the same schema for both integration-request events. List of event types: - integration-request:accepted - integration-request:rejected requestBody: content: application/json: schema: type: object properties: created_at: type: string format: date-time description: The date and time of the event. type: type: string description: Event type details: type: object properties: id: type: string format: uuid description: Unique Identifier of the Integration Request carrier_id: type: string format: uuid description: Unique Identifier of the Carrier on Loadsmart mc: type: string description: Carrier Interstate Operating Authority (MC number) dot: type: string description: Carrier US DOT Number name: type: string description: Carrier legal name status: type: string enum: - pending - accepted - rejected description: | Status of the Integration Request - pending: waiting/under evaluation from Carrier owner and/or Loadsmart - accepted: Integration Request accepted - rejected: Integration Request rejected by Carrier owner and/or Loadsmart example: type: integration-request:accepted created_at: 2018-06-19T10:30:00Z details: id: 5d5f9e1b-49d5-43eb-a0d5-744237357e66 carrier_id: 7c5b89cc-53fe-4e7a-9cf2-47a725e631a5 dot: "123" mc: "456" name: Stark Industries status: accepted responses: "200": description: Event received tags: - Webhooks /api/v2/shipmentscores: get: summary: Retrieve shipment scores tags: - Shipments security: - User-JWT: - shipment_score_read parameters: - in: query name: start_date schema: type: string format: date pattern: YYYY-MM-DD description: Start date for shipment scores - in: query name: end_date schema: type: string format: date pattern: YYYY-MM-DD description: End date for shipment scores - in: query name: shipper_uuid schema: type: uuid description: Filter shipment scores by shipper responses: "200": description: Shipment scores content: application/json: schema: type: object properties: data: type: array items: type: object properties: shipment_uuid: type: uuid shipment_ref: type: string source: type: string pickup_city: type: string pickup_state: type: string delivery_city: type: string delivery_state: type: string otp: type: boolean otd: type: boolean audited: type: boolean delivered_at: type: datetime format: date-time carrier_name: type: string carrier_uuid: type: uuid overridden: type: string shipper_uuid: type: uuid count: type: number format: integer next: type: string format: url previous: type: string format: url example: data: - audited: false carrier_name: JONES EXPRESS, INC. carrier_uuid: ab51fded-cc5b-4338-ad41-69c98ecdeaa4 delivered_at: 2019-10-18T13:20:36Z delivery_city: Buford delivery_state: GA otd: true otp: false overridden: "" pickup_city: Grand Rapids pickup_state: MI shipment_ref: "9290080" shipment_uuid: b5cfc16c-37d2-4e1a-a481-3e0ec5e05cdf shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: CELADON TRUCKING SERVICES INC carrier_uuid: d11a1f7c-fad9-4ff9-b0ba-34fc93f63c3f delivered_at: 2019-10-18T13:04:00Z delivery_city: Grimes delivery_state: IA otd: true otp: true overridden: "" pickup_city: Salisbury pickup_state: NC shipment_ref: "9290018" shipment_uuid: 0d6527b4-c091-4f4e-99af-4634b7de1a74 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: JD LOGISTIC carrier_uuid: 4591734a-9ce8-47f3-a0bf-9872e4734d70 delivered_at: 2019-10-18T12:30:00Z delivery_city: Swedesboro delivery_state: NJ otd: true otp: true overridden: "" pickup_city: Walton pickup_state: KY shipment_ref: "9289985" shipment_uuid: a5675679-6b06-4206-8eb9-f930b64ca255 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: TRANSPORT AMERICA carrier_uuid: fcc9aacd-1acd-4fa1-9c9a-4288d6f62fc4 delivered_at: 2019-10-16T14:00:00Z delivery_city: Buford delivery_state: GA otd: true otp: true overridden: "" pickup_city: Florence pickup_state: KY shipment_ref: "9289982" shipment_uuid: 34aff94e-1744-494b-9194-17c0c804c899 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: SCHNEIDER NATIONAL CARRIERS, INC. carrier_uuid: 1848f1b2-a16a-4be8-9304-8e5a049f619a delivered_at: 2019-10-17T13:30:00Z delivery_city: Grimes delivery_state: IA otd: true otp: true overridden: "" pickup_city: Broadview pickup_state: IL shipment_ref: "9289979" shipment_uuid: 2b221d63-d91e-4c48-9614-cb2e8438cfc0 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: P W D TRANSPORTATION INC carrier_uuid: 34eb6030-f4b2-45e2-aec5-70ad7cd08aa2 delivered_at: 2019-10-17T19:20:00Z delivery_city: Whitestown delivery_state: IN otd: true otp: true overridden: "" pickup_city: Huntington pickup_state: IN shipment_ref: "9289963" shipment_uuid: 1ab41074-6dce-4b42-a049-3c2d969e6cf5 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: P W D TRANSPORTATION INC carrier_uuid: 34eb6030-f4b2-45e2-aec5-70ad7cd08aa2 delivered_at: 2019-10-17T12:30:00Z delivery_city: Whitestown delivery_state: IN otd: true otp: true overridden: "" pickup_city: Goshen pickup_state: IN shipment_ref: "9289962" shipment_uuid: dec8a270-5ff5-4693-b7ce-c09561adc3e3 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: ARKA EXPRESS INC carrier_uuid: 9c6276bc-c4e4-4a8d-8ffa-ce511ef05996 delivered_at: 2019-10-17T01:55:00Z delivery_city: Portage delivery_state: IN otd: true otp: true overridden: "" pickup_city: Des Plaines pickup_state: IL shipment_ref: "9289950" shipment_uuid: 5866d5f8-7806-4251-b03c-b3d70ee4a049 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: CELADON TRUCKING SERVICES INC carrier_uuid: d11a1f7c-fad9-4ff9-b0ba-34fc93f63c3f delivered_at: 2019-10-18T12:42:00Z delivery_city: Grand Prairie delivery_state: TX otd: true otp: false overridden: "" pickup_city: Grand Rapids pickup_state: MI shipment_ref: "9289898" shipment_uuid: 858e8be9-3776-4fd1-a5d3-c07113bde05e shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: A. D. TRANSPORT EXPRESS, INC. carrier_uuid: f80fcf21-8e29-4f6e-989b-0347b03207ba delivered_at: 2019-10-16T17:01:00Z delivery_city: Grimes delivery_state: IA otd: true otp: true overridden: "" pickup_city: Grand Rapids pickup_state: MI shipment_ref: "9289876" shipment_uuid: edb3f8e5-903c-4a46-8a34-258d7207473a shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: CELADON TRUCKING SERVICES INC carrier_uuid: d11a1f7c-fad9-4ff9-b0ba-34fc93f63c3f delivered_at: 2019-10-16T21:52:00Z delivery_city: Memphis delivery_state: TN otd: true otp: true overridden: "" pickup_city: Kendallville pickup_state: IN shipment_ref: "9289842" shipment_uuid: e75e44ed-ee2d-4aba-a8eb-75588fdc187f shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: R. T. 80 EXPRESS, INC. carrier_uuid: ddf2af3b-9615-4154-b187-4a63316550c9 delivered_at: 2019-10-16T13:00:00Z delivery_city: Canton delivery_state: OH otd: true otp: true overridden: "" pickup_city: Wapakoneta pickup_state: OH shipment_ref: "9289783" shipment_uuid: 9d0be210-e4f1-46f3-a906-8d20ebda3287 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: CELADON TRUCKING SERVICES INC carrier_uuid: d11a1f7c-fad9-4ff9-b0ba-34fc93f63c3f delivered_at: 2019-10-17T16:28:00Z delivery_city: Grand Prairie delivery_state: TX otd: true otp: true overridden: "" pickup_city: Huntington pickup_state: IN shipment_ref: "9289782" shipment_uuid: 59e97293-d47b-4be4-af66-3ce6b5e6d062 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: BIG M TRANSPORTATION, INC. carrier_uuid: 232319b6-bf79-4f53-baf3-4a7eea74f8f1 delivered_at: 2019-10-17T02:47:00Z delivery_city: Memphis delivery_state: TN otd: false otp: true overridden: "" pickup_city: Huntington pickup_state: IN shipment_ref: "9289778" shipment_uuid: 2eaa2056-3de5-4b5e-bd38-8577f6c938bd shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: SCHNEIDER NATIONAL CARRIERS, INC. carrier_uuid: 1848f1b2-a16a-4be8-9304-8e5a049f619a delivered_at: 2019-10-17T16:45:00Z delivery_city: Memphis delivery_state: TN otd: true otp: true overridden: "" pickup_city: Montpelier pickup_state: OH shipment_ref: "9289769" shipment_uuid: 9ff161a5-0823-4ede-8dc6-b40d67d3fb72 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: RSR TRANSPORT LLC carrier_uuid: ba7b00fb-7a3d-4b5b-b45d-dd75a51561ad delivered_at: 2019-10-16T14:15:00Z delivery_city: Canton delivery_state: OH otd: true otp: true overridden: "" pickup_city: Trenton pickup_state: MO shipment_ref: "9289756" shipment_uuid: 473fb3fe-7c09-4ac4-bee1-8e0898eb2272 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: CELADON TRUCKING SERVICES INC carrier_uuid: d11a1f7c-fad9-4ff9-b0ba-34fc93f63c3f delivered_at: 2019-10-16T10:02:00Z delivery_city: Whitestown delivery_state: IN otd: true otp: false overridden: "" pickup_city: Spartanburg pickup_state: SC shipment_ref: "9289691" shipment_uuid: 761927f2-6ffb-4ec1-93a9-63a2e9d40823 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: SCHNEIDER NATIONAL CARRIERS, INC. carrier_uuid: 1848f1b2-a16a-4be8-9304-8e5a049f619a delivered_at: 2019-10-17T13:29:00Z delivery_city: Buford delivery_state: GA otd: true otp: true overridden: "" pickup_city: Grand Rapids pickup_state: MI shipment_ref: "9289670" shipment_uuid: c580dc2f-8a81-4c1f-935a-ab0053009dde shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: A. D. TRANSPORT EXPRESS, INC. carrier_uuid: f80fcf21-8e29-4f6e-989b-0347b03207ba delivered_at: 2019-10-17T01:00:00Z delivery_city: Buford delivery_state: GA otd: true otp: true overridden: "" pickup_city: Grand Rapids pickup_state: MI shipment_ref: "9289669" shipment_uuid: 23629db9-268f-4853-8949-9d212251f204 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice - audited: false carrier_name: SCHNEIDER NATIONAL CARRIERS, INC. carrier_uuid: 1848f1b2-a16a-4be8-9304-8e5a049f619a delivered_at: 2019-10-16T15:00:00Z delivery_city: Buford delivery_state: GA otd: true otp: true overridden: "" pickup_city: Grand Rapids pickup_state: MI shipment_ref: "9289668" shipment_uuid: 5c72f663-0213-4ce0-b0f2-7e39edb5a6f3 shipper_uuid: 320bea98-c46a-493a-860d-f9bdd49c39a9 source: alice next: https://api.loadsmart.io/api/v2/shipmentscores/?limit=20&offset=20 previous: null count: 325923 "401": description: User Does Not Have Permission content: application/json: schema: type: object properties: error: type: string enum: - invalid_data error_description: type: string description: Description of what happened errors: type: object description: Object where each field is a key and the value is an array of errors required: - error - error_description example: error: does_not_have_permission error_description: Permission is Denied for this Request tags: - name: Carrier description: | This API allows partners to request integration for Carriers and also manage Carrier's information. The usage of this API is detailed at https://developer.loadsmart.com/carrier-integrations/how-tos/how-to-connect.html. To sum up how to integrate a Carrier, follow these steps: * `Search a carrier` by its MC# or DOT; * `Request Integration for a Carrier`; * Check the status by `Detail Carrier Integration Request status`; * Once the status is `ACCEPTED`, do requests on behalf of this carrier. - name: Capacity description: | Manages new capacity. A capacity is a truck that is empty and it's location. - name: Load Offers description: | This API allows third parties to search and accept available Offers. ## Webhook events There are few webhook events that can be triggered related to Load Offers API. The following example refers to the webhook events `load_carrier_bounced` and `load_cancelled`: ``` { "event": "load_carrier_bounced", "data": { "load_id": "2ed37107-ebe7-4a60-a20f-01d4e74355c8", "load": { "id": "2ed37107-ebe7-4a60-a20f-01d4e74355c8", "active_offer": { "id": "ccd37107-ebe7-4a60-a20f-01d4e74355c8", "price": 1234.56 }, "carrier": { "id": "89ef54c7-52d5-44a0-b94d-df41eb1aab15", "mc": 123456, "dot": 987654 }, "commodity": "BOTTLED WATER", "distance": 353.6, "equipment_type": "DRV", "requirements": { "beer": false, "chemicals": null, "ctpat": null, "food_grade": null, "frozen": null, "hazmat": null, "hvhr": null, "pharmaceuticals": null, "produce": null, "teams": null, "tsa": null, "twic": null, "vented_vans": null, }, "stops": [ { "address": "109 Poland Spring Dr", "city": "Poland", "country": "USA", "latitude": 44.031602, "longitude": -70.355065, "state": "ME", "type": "PU", "window_end": "2019-11-28T08:00:00+00:00", "window_start": "2019-11-28T06:00:00+00:00", "window_timezone": "America/New_York", "requirements": null, "facility_info": { "avg_time_spent":{ "pickup":40, "delivery": null }, "detention_rate": 4 } }, { "address": "6 Westbelt", "city": "Wayne", "country": "USA", "latitude": 40.900033, "longitude": -74.264872, "state": "NJ", "type": "DEL", "window_end": "2019-11-29T19:00:00+00:00", "window_start": "2019-11-29T17:00:00+00:00", "window_timezone": "America/New_York", "requirements": null, "facility_info": { "avg_time_spent":{ "pickup":null, "delivery": 20 }, "detention_rate": 9 } }, ], "numberweight": 45000.0, "dimensions": {"width": 8.00, "height": 9.00, "length": 54.00} "ref_number": "41324" } } } ``` The following example refers to the webhook events `offer_created` and `offer_removed`: ``` { "event": "offer_created", "data": { "offer": { "id": "ccd37107-ebe7-4a60-a20f-01d4e74355c8", "price": 1234.56, "load": { "equipment_type": "DRV", "commodity": "apples", "weight": 20000, "dimensions": {"width": 8.00, "height": 9.00, "length": 54.00} "distance": 50000, "stops": [ { "type": "PU", "address": "101 Collins Avenue", "city": "Miami Beach", "state": "FL", "country": "USA", "requirements": { "blind_bol": false, "drop_trailer": false, "heavy_scale_ticket": false, "light_scale_ticket": false }, "facility_info": { "avg_time_spent":{ "pickup":40, "delivery": null }, "detention_rate": 4 } "zipcode": "33139", "window_start": "2020-02-13T09:00:00", "window_end": "2018-02-13T11:00:00", "window_timezone": "America/New_York" }, { "type": "DEL", "address": "2022 Collins Avenue", "city": "Miami Beach", "state": "FL", "country": "USA", "requirements": { "blind_bol": false, "drop_trailer": false, "heavy_scale_ticket": false, "light_scale_ticket": false }, "facility_info": { "avg_time_spent":{ "pickup":null, "delivery": 20 }, "detention_rate": 9 } "window_start": "2018-02-14T16:00:00", "window_end": "2018-02-14T18:00:00", "window_timezone": "America/New_York" } ], "requirements": { "beer": false, "chemicals": false, "ctpat": false, "food_grade": false, "frozen": false, "hazmat": false, "hvhr": false, "pharmaceuticals": false, "produce": false, "teams": false, "tsa": false, "twic": false, "vented_vans": false }, "ref_number": "425631" }, "actions": { "redirect_url": "https://loadsmart.com/loads/#/eec5677f-883c-4696-b13b-7539fa98e098", "accept_url": "https://api.loadsmart.com/api/v2/load-offers/offers/ccd37107-ebe7-4a60-a20f-01d4e74355c8/accept" } } } } ``` - name: Bids description: | This API allows third parties to create, list, retrieve and accept bids. - name: Shippers description: | Manage shippers. A shipper is a company that creates and manages loads on Loadsmart platform. - name: Shipper Accounts description: | Manage the accounts associated with shippers. An account represents an user. - name: Quotes description: | Quotes provide the price and conditions for a future shipment. To create a shipment, you need first to request a valid quote. - name: Loads description: | This endpoint will be the entrypoint for our integrations. It will receive loads. - name: Routes description: | Provides information about routing - name: Shipments description: Manage shipments - name: Shipment Events description: | Our API supports fetch and change of a variety of shipments status, the main ones are responsible to move the shipment from booked to in transit and delivered, They must obey the following order: * **shipment:en-route-to-pickup** - The first state responsible to start the haul. * **shipment:check-in-pickup** - Used when driver arrives at pickup facility. * **shipment:check-out-pickup** - Used when driver leaves the pickup facility. * **shipment:check-in-delivery** - Used when driver arrives at delivery facility. * **shipment:check-out-delivery** - Used when the driver delivers the shipment. NOTE: These events are allowed to be changed via API. There are other events to support the main flow, they are available on webhooks or can be listed via API Shipment events, specific events that can happen for a shipment: * **shipment:incident** - When a incident is registered to a shipment. * **shipment:canceled** - When the shipment is canceled for some reason. Appointment events, these events are normally set before the load starts to move: * **shipment:appointment-pickup** - Used to set an appointment at pickup. * **shipment:appointment-delivery** - Used to set an appointment at delivery. Carrier related events, indicate changes in the carrier, drop, etc. normally happens before the load starts to move: * **shipment:carrier-updated** - Used for changes on a load related to a carrier, i.e. trailer # change. * **shipment:carrier-dropped** - Indicates a carrier drop for a particular shipment. * **shipment:driver-assigned** - A carrier driver assignment. * **shipment:driver-unassigned** - A carrier driver unassignment. Carrier location update, happens while the load is in transit until final delivery: * **shipment:location-updated** - Used to indicate the geographic coordinates of the carrier. - name: Shipment Locations description: Truck location during the shipment transportation - name: Shipment Stops description: Stops of a shipment - name: Webhooks description: | Webhooks allow you to receive certain events from Loadsmart. When one of those events is triggered, we'll send an HTTP POST request to the webhook's configured URL(s). This URL(s) should be sent to Loadsmart as part of the onboarding process. Webhooks can be used to update your own system with information from Loadsmart. ## Authentication Loadsmart Webhooks use the same authentication scheme used in the API, except in this case, Loadsmart generates the JWT tokens and the TMS authenticates our requests with these tokens. During the setup process Loadsmart will send to TMS the public key and the TMS will be responsible for validating the token. ### Token structure The JWT token header will be: ``` { "alg": "RS256", "typ": "JWT" } ``` The token payload will have: ``` { "iss": "loadsmart", // the token issuer "iat": 1517239022, // unix timestamp when the token was issued "exp": 1626239022 //unix timestamp when the token will expire } ``` The JWT token will be present in the Authorization header on all requests, as in the following example: ``` Authorization: JWT eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.TCYt5XsITJX1CxPCT8yAV-TVkIEq_PbChOMqsLfRoPsnsgw5WEuts01mq-pQy7UJiN5mgRxD-WUcX16dUEMGlv50aqzpqh4Qktb3rk-BuQy72IFLOqV0G_zS245-kronKb78cPN25DGlcTwLtjPAYuNzVBAh4vGHSrQyHUdBBPM ``` - name: Errors and Status Codes description: | The API uses two slightly different formats to describe an error. #### Authentication error object Whenever the application makes requests to the API which are related to authentication or authorization, e.g. retrieving an access token or refreshing an access token, the error response follows RFC 6749 on The OAuth 2.0 Authorization Framework. ```JSON { "error": "invalid_grant", "error_description": "Invalid credentials given." } ``` #### Regular error object Apart from the response code, unsuccessful responses return information about the error as an error JSON object containing the following information: ```JSON { "error": "invalid_data", "error_description": "Could not generate the quote", "errors": { "equipment_type": [ "This field is required." ] } } ``` Below is a list of common errors. 400 Bad Request - failed_to_parse_data: Submission is made with invalid content-type or format 401 Unauthorized - invalid_credentails: An user doesn't have a valid client_id and is trying to access some protected resource - invalid_client: An user is trying to authenticate with wrong client_id - invalid_access_token: An user is using an invalid access token 403 Forbidden - forbidden_access: An user is trying to access a not authorized resource. 404 Not Found - object_not_found: Happens when the user tries to reach some inexistent resource 409 Conflict - quote_already_booked: There is already a shipment booked with the supplied quote - user_duplicated_data: There is alread an user with the supplied unique data 422 Unprocessable Entity - invalid_data: When some POST or PUT is made with invalid data errors: A list of invalid fields