openapi: 3.0.0 info: title: Opendock Nova API Documentation Appointments Shipment Events API description: "## Welcome to Opendock Nova!\n\n#### What is Opendock Nova?\n\nOpendock is an online dock appointment scheduling tool. Facilities such as warehouses, distribution centers, and\nmanufacturing plants use it to organize their docks and schedule appointments for outbound pickups and inbound\ndeliveries.\nYou can read all our knowledge base\narticles [here.](https://community.loadsmart.com/hc/en-us/sections/24987828169619-Opendock-Nova-Warehouse-API)\n\nWe now provide an SSO option for User Authentication. Read\nthe [docs here.](https://community.loadsmart.com/hc/en-us/articles/14944624317075-Single-Sign-On-SSO-SAML-2-0)\n\n---\n\n## Our APIs\n\nWe have 3 main APIs:\n\n- REST API called _Neutron_ for performing standard HTTP operations.\n- Real-time API called _Subspace_ for receiving streaming events whenever objects are Created/Updated/Deleted.\n- A **\"Reference Number Validation\"** aka \"PO Validation\" _protocol_ for validating PO numbers (or similar) before an\n appointment is scheduled. Detailed documentation for it can be found\n here: [PO/Ref Number Validation Implementation](https://community.loadsmart.com/hc/en-us/articles/14946368437907-PO-Ref-Number-Validation-Implementation)\n\n---\n\n## Neutron - REST API\n\nAll endpoints are listed below. Depending on your User Role, some may be forbidden. Almost all endpoints expect a simple\nJWT token to be set in the `Authorization: Bearer` HTTP header. Read more about Bearer\ntokens [here](https://swagger.io/docs/specification/authentication/bearer-authentication/).\n\n### Base URL\n\nThe base URL is the same as it is for this document (look at the current URL in your browser's address bar). For\nexample, our production Neutron Base URL is [https://neutron.opendock.com](https://neutron.opendock.com).\n\n### Authentication\n\nTo start, call the `POST /auth/login` endpoint to exchange your user credentials (email + password) for a simple JWT\ntoken. If you don't have an account yet, reach out to your account admin or contact us for further help.\n\nIf login is successful, the response will be a JWT token to use as your `Bearer` header as described above.\n\nThe JWT expiration time depends on your User Role as well as other factors. You may base64-decode your JWT token to view\nmore technical details about it.\n\n#### Test it:\n\nTo test that your auth headers are set correctly, call the `GET /auth/me` endpoint. It will return a JSON payload with\nyour User information.\n\n---\n\n## Subspace - Real-time Streaming API\n\nSubspace is a _read-only_ API that allows your system to recieve streaming real-time information about changes to your\nAppointments, Warehouses, Docks, etc.\n\nUsing Subspace you can implement a \"push\"-based approach to your integration instead of relying only on \"poll\"-ing\nmethods (which can be inefficient).\n\nSubpsace is based on the famous [`socket.io`](https://socket.io/) library.\n\n### Choosing a socket.io Client\n\nThe socket.io project provides a JavaScript client library that works in the browser as well as NodeJS. However there\nare also client implementations in many other languages including C#, Java, Python, and Go, so you should select the\nappropriate client for your project. A good overview of socket.io and a list of client implementations can be found\nhere: [Socket.IO Introduction](https://socket.io/docs/v4/)\n\n**NOTE:** Currently Opendock uses socket.io server **v4.x** so please make sure to select an appropriate socket.io\nclient version that is protocol compatible.\n\n### Connecting and Authentication\n\nThe base connection URL is the same as the base URL for Neutron above, except with the word \"subspace\" instead of \"\nneutron\". For example, our production Subspace connection URL\nis [wss://subspace.opendock.com](wss://subspace.opendock.com).\n\nFor convenience, the same JWT token obtained from the Neutron `/auth/login` endpoint above is used for Subspace\nauthentication.\n\nConnecting and Authenticating are done in a single operation: simply connect to the following `wss` URL:\n\n```\n?token=\n```\n\nThat can be a little confusing to parse. Here's a real-life example connection string:\n\n```\nwss://subspace.opendock.com?token=eyJhbGciOiJIUzI1Ni...(full token continues)\n```\n\n**NOTE:** Currently Opendock only supports the `websocket` transport, so you must specify this in your connection\nsettings.\n\nHere's an example of connecting to Subspace using the JavaScript client:\n\n```JavaScript\n// NOTE: we assume \"accessToken\" was already obtained earlier via a call to '/auth/login'.\nconst baseSubspaceUrl = 'wss://subspace.opendock.com';\nconst url = `${baseSubspaceUrl}?token=${accessToken}`;\nconst socket = io(url, { transports: ['websocket'] }); // Enforce 'websocket' transport only.\n```\n\n### Listening to events\n\nSubspace emits Create/Update/Delete events for each entity in your Org (Appointment, Warehouse, Dock, etc). Your event\nhandler for these events will receive a JSON object containing the details about the given entity.\n\nOnce your socket.io client instance is connected, you can listen for any of these events by constructing the appropriate\nevent string:\n\nEvent strings follow this pattern:\n\n```\n\"{EventType}-{EntityName}\"\n```\n\n`EventType` can be one of: `create`, `update`, or `delete`.\n\n`EntityName` can be any entity in our REST API, such as: `Appointment`, `Warehouse`, `Dock`, etc.\n\nSo for example, to listen to `create` events for `Appointment` entities you would use:\n\n```\n\"create-Appointment\"\n```\n\nOr to listen to `update` events for `Warehouse` entities you would use:\n\n```\n\"update-Warehouse\"\n```\n\n**NOTE:** The event types are lowercase, but the entity names are capitalized (event strings are case-sensitive).\n\nThere is also a `\"heartbeat\"` event that you can listen to, which will emit every 5 seconds with a timestamp and the\nNeutron API version. This can be helpful for ensuring that your connection to Subspace is working correctly.\n\n### Caveats and Limitations\n\nSubspace does not do any sort of \"catch-up\" or \"replay\" of events, you will only get the events that occur after you\nconnect to the socket.io server.\n\nIf your client loses connection for some time, the event messages will not be queued and delivered when you next\nconnect, you will simply start receiving new messages after the point in time that you connected.\n\nFor this reason, even when using Subspace, you may need to occasionally supplement with calls to our REST API (ie.\ngetAll) to fetch entities and keep in sync with the data in Opendock, depending on your needs.\n\n### Example: Listening for Heartbeat\n\nThis event handler will get called periodically with the \"heartbeat\" information:\n\n```JavaScript\nsocket.on('heartbeat', (data) => {\n console.log(data);\n});\n```\n\nThis will output something like:\n\n```JSON\n{\n now: '2022-09-15T20:02:20.015Z',\n version: {\n major: '2',\n minor: '5',\n patch: '16',\n commit: '4a443fb\\n'\n }\n}\n```\n\n### Example: Listening for Appointment Creation and Update\n\nIn this example, your event handler will get called whenever an Appointment\nis created in your Org:\n\n```JavaScript\nsocket.on('create-Appointment', (data) => {\n console.log('appt create:', data);\n});\n```\n\nThe `data` your event handler recieves will be a JSON object containing\nthe Appointment details, like this:\n\n```JSON\n{\n \"id\": \"9cd63603-a7ff-43c7-8183-befc19a7a81b\",\n \"createDateTime\": \"2022-07-29T06:49:20Z\",\n \"lastChangedDateTime\": \"2022-07-29T06:49:20Z\",\n \"isActive\": true,\n \"tags\": [],\n \"type\": \"Standard\",\n \"status\": \"Scheduled\",\n \"start\": \"2022-07-29T00:00:00+00:00\",\n \"end\": \"2022-07-29T01:30:00+00:00\",\n ...\n ...\n ...\n}\n```\n\nIf you also wanted to listen for any changes to existing Appointments\nyou could add another listener:\n\n```JavaScript\nsocket.on('create-Appointment', (data) => {\n console.log('appt create:', data);\n});\n\nsocket.on('update-Appointment', (data) => {\n console.log('appt update:', data);\n});\n```\n\nThe `update-Appointment` event handler will receive a similar JSON object\ncontaining the most up-to-date details of the Appointment that was\njust updated.\n\n---\n\n## Nestjsx/Crud\n\n[NestJSX/Crud](https://github.com/nestjsx/crud/wiki/Requests#search) is a robust library designed for creating\nhigh-performance and scalable APIs. With NestJSX/Crud, API\nconsumers can take advantage of a flexible and intuitive approach to querying data.\n\nThis library streamlines the process of searching, sorting, and paginating data to cater to the exact requirements of\nthe API consumer. This feature saves valuable time by allowing the API consumer to bypass irrelevant data, ensuring only\nthe necessary data is obtained.\n\nNote: We encourage use of the `search` parameter (`s=...`), and do not allow use of the deprecated `filter` parameter.\n\n#### Search Examples\n\nFind all active Appointments created or updated since March 15th, 2023 at 8am MST (since created appts also have updated lastChangeDateTime)\n\n```\ns={\"lastChangedDateTime\":{\"$gt\":\"2023-03-15T08:00:00.000-07:00\"}}\n```\n\nFind all soft-deleted (inActive) appointments updated since a date/time (isActive:false indicates soft-deleted)\n\n```\ns={\"$and\":[{\"lastChangedDateTime\": {\"$gt\":\"2023-07-7T00:00:00.000Z\"}},{\"isActive\":false}]}\n```\n\nFind all appointments changed since a date time (both active and inactive).\nThis is useful for integration partners with recurring series who need to know future appointments in the series have been removed\n\n```\ns={\"$and\":[{\"lastChangedDateTime\": {\"$gt\":\"2023-07-7T00:00:00.000Z\"}},{\"$or\":[{\"isActive\":true},{\"isActive\":false}]}]}\n```\n\nFind all Appointment where the `tags` are empty\n\n```\ns={\"tags\": {\"$or\": {\"$isnull\": true, \"$eq\": \"{}\"}}}\n```\n\nFind all Appointments where it includes a tag of `Late`\n\n```\ns={\"tags\":{\"$contL\":\"Late\"}}\n```\n\nFind all appointments in `Scheduled` status set to start after March 15th, 2023 at 8am MST\n\n```\ns={\"$and\":[{\"status\":\"Scheduled\"},{\"start\":{\"$gt\":\"2023-03-15T08:00:00.000-07:00\"}}]}\n```\n\n#### Join examples (with Fields)\n\nTo return data from other tables without the need to make a secondary query, the API consumer can join specific tables\ntogether and request only the fields necessary.\n\nGet the appointment with the carrier and company. This will return a nested `User` with a nested `Company` in the result for\neach appointment.\nOrder matters here. You must first include `user` to get to `user.company`.\n\n```\njoin=user&join=user.company\n```\n\nTo get just the user's email and company's name, you can use the `||` operator.\nBecause `user.companyId = company.id` you must at least include `companyId` on `user`\n\n```\njoin=user||email,companyId&join=user.company||name\n```\n\n#### Other Examples\n\nTo get an appointment's refNumber (PO), start, lastChangedDateTime, and carrier company name\n\n```\ns={\"start\": {\"$gt\":\"2023-03-15T00:00:00.000Z\"}}&join=user||companyId&join=user.company||name&fields=refNumber,lastChangedDateTime,start\n```\n\n---\n" version: v4.144.0 - 39b4253 contact: {} servers: - url: https://neutron.opendock.com description: Production Server - url: https://neutron.staging.opendock.com description: Staging Server tags: - 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. ' paths: /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-19 14:30:00+00:00 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-19 10:30:00+00:00 details: event_date: 2018-06-10 09:00:00+00:00 stop_index: 0 - type: shipment:driver-assigned shipment_id: ad5aa25c-3e20-4de8-aeba-3a71d3c3242c created_at: 2018-06-19 14:30:00+00:00 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 components: securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http