---
updatedAt: 2025-09-10T20:59:27.000Z
agentTools:
projectIndex: https://shipcars.readme.io/llms.txt
---
# Create a load with direct dispatch
This method creates a new load and directly dispatches it
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "User Management",
"description": "Ship.Cars User Management",
"contact": {
"url": "https://ship.cars",
"email": "support@ship.cars"
},
"version": "1.0.0"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "oauth2",
"flows": {
"password": {
"tokenUrl": "https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token",
"scopes": {}
}
}
}
}
},
"servers": [
{
"url": "https://ship.cars/api"
}
],
"paths": {
"/shipperlite/posting/v3/integrators/loads/direct-dispatch": {
"post": {
"tags": [
"Loads API"
],
"summary": "Create a load with direct dispatch",
"description": "This method creates a new load and directly dispatches it",
"operationId": "createAndDispatchStandaloneLoadLeg_2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"carrierDot",
"loadLeg"
],
"type": "object",
"properties": {
"loadLeg": {
"required": [
"carrierPayInCents",
"contract",
"deliveryContact",
"deliverySignatureRequired",
"load",
"payments",
"pickupContact",
"pickupSignatureRequired",
"route",
"shippingItems"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the load",
"example": "YK41K"
},
"status": {
"type": "string",
"description": " NEW - (Used by Driveaway Loads), if the driveaway driver decides to decline the load,
\n the status changes to NEW
\n PENDING_POSTING - The load’s posting is in progress.
\n POSTED - The load is posted on the LoadBoard.
\n PENDING_CLAIM - The load has been dispatched to the carrier or a carrier offer has been accepted.
\n Upon successful dispatch, the status changes to CARRIER_PENDING.
\n CARRIER_PENDING - The load is dispatched (through negotiation or directly)
\n and a carrier is presented with the option to accept or decline it.
\n DISPATCHED - The load has been dispatched.
\n ASSIGNED - The load has been assigned to a driver by a carrier.
\n PICKED_UP - The load has been picked up.
\n DELIVERED - The load has been delivered.
\n PENDING_ARCHIVE - The load’s archiving is pending.
\n ARCHIVED - The load has been archived.
\n",
"example": "[\"POSTED\",\"PICKED_UP\"]",
"enum": [
"NEW",
"PENDING_POSTING",
"POSTED",
"PENDING_CLAIM",
"CARRIER_PENDING",
"DISPATCHED",
"ASSIGNED",
"PICKED_UP",
"DELIVERED",
"PENDING_ARCHIVE",
"ARCHIVED"
]
},
"bookingAgent": {
"type": "string",
"description": "Booking Agent (creator) of the load",
"example": "Martin"
},
"shipperLoadId": {
"type": "string",
"description": "Custom identifying the number or name of the load. Generated in the response if not set on request",
"example": "CS1234X"
},
"route": {
"required": [
"deliveryLocation",
"pickupLocation",
"pickupRequestedDateDetail"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the route entity",
"example": "YK41K"
},
"pickupRequestedDateDetail": {
"required": [
"estimatedEndDate",
"estimatedStartDate",
"restriction"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the date",
"example": "YK41K"
},
"estimatedEndDate": {
"type": "string",
"description": "End date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-23"
},
"estimatedStartDate": {
"type": "string",
"description": "Start date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-21"
},
"restriction": {
"type": "string",
"description": " NO_RESTRICTIONS - No limitations.
\n NOT_EARLIER - Not earlier than a given date.
\n NOT_LATER - Not later than a given date.
\n NOT_EARLIER_NOT_LATER - Not earlier than a given date and not later than another date.
\n",
"example": "NO_RESTRICTIONS",
"default": "NO_RESTRICTIONS",
"enum": [
"NO_RESTRICTIONS",
"NOT_EARLIER",
"NOT_LATER",
"NOT_EARLIER_NOT_LATER"
]
}
},
"description": "Required details and restrictions for the load's estimated delivery date."
},
"pickupEstimatedDateDetail": {
"required": [
"estimatedEndDate",
"estimatedStartDate",
"restriction"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the date",
"example": "YK41K"
},
"estimatedEndDate": {
"type": "string",
"description": "End date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-23"
},
"estimatedStartDate": {
"type": "string",
"description": "Start date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-21"
},
"restriction": {
"type": "string",
"description": " NO_RESTRICTIONS - No limitations.
\n NOT_EARLIER - Not earlier than a given date.
\n NOT_LATER - Not later than a given date.
\n NOT_EARLIER_NOT_LATER - Not earlier than a given date and not later than another date.
\n",
"example": "NO_RESTRICTIONS",
"default": "NO_RESTRICTIONS",
"enum": [
"NO_RESTRICTIONS",
"NOT_EARLIER",
"NOT_LATER",
"NOT_EARLIER_NOT_LATER"
]
}
},
"description": "Required details and restrictions for the load's estimated delivery date."
},
"pickupActualDate": {
"type": "string",
"description": "Delivery actual date in yyyy-mm-dd format",
"format": "date",
"readOnly": true,
"example": "2022-03-23"
},
"deliveryRequestedDateDetail": {
"required": [
"estimatedEndDate",
"estimatedStartDate",
"restriction"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the date",
"example": "YK41K"
},
"estimatedEndDate": {
"type": "string",
"description": "End date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-23"
},
"estimatedStartDate": {
"type": "string",
"description": "Start date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-21"
},
"restriction": {
"type": "string",
"description": " NO_RESTRICTIONS - No limitations.
\n NOT_EARLIER - Not earlier than a given date.
\n NOT_LATER - Not later than a given date.
\n NOT_EARLIER_NOT_LATER - Not earlier than a given date and not later than another date.
\n",
"example": "NO_RESTRICTIONS",
"default": "NO_RESTRICTIONS",
"enum": [
"NO_RESTRICTIONS",
"NOT_EARLIER",
"NOT_LATER",
"NOT_EARLIER_NOT_LATER"
]
}
},
"description": "Required details and restrictions for the load's estimated delivery date."
},
"deliveryEstimatedDateDetail": {
"required": [
"estimatedEndDate",
"estimatedStartDate",
"restriction"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the date",
"example": "YK41K"
},
"estimatedEndDate": {
"type": "string",
"description": "End date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-23"
},
"estimatedStartDate": {
"type": "string",
"description": "Start date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-21"
},
"restriction": {
"type": "string",
"description": " NO_RESTRICTIONS - No limitations.
\n NOT_EARLIER - Not earlier than a given date.
\n NOT_LATER - Not later than a given date.
\n NOT_EARLIER_NOT_LATER - Not earlier than a given date and not later than another date.
\n",
"example": "NO_RESTRICTIONS",
"default": "NO_RESTRICTIONS",
"enum": [
"NO_RESTRICTIONS",
"NOT_EARLIER",
"NOT_LATER",
"NOT_EARLIER_NOT_LATER"
]
}
},
"description": "Required details and restrictions for the load's estimated delivery date."
},
"deliveryActualDate": {
"type": "string",
"description": "Delivery actual date in yyyy-mm-dd format",
"format": "date",
"readOnly": true,
"example": "2022-03-23"
},
"deliveryLocation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
},
"longitude": {
"type": "string",
"description": "Auto-generated longitude coordinates of the location",
"example": "-94.2332754"
},
"latitude": {
"type": "string",
"description": "Auto-generated latitude coordinates of the location",
"example": "39.3514073"
}
},
"description": "Required details and restrictions for the load's requested pickup location."
},
"pickupLocation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
},
"longitude": {
"type": "string",
"description": "Auto-generated longitude coordinates of the location",
"example": "-94.2332754"
},
"latitude": {
"type": "string",
"description": "Auto-generated latitude coordinates of the location",
"example": "39.3514073"
}
},
"description": "Required details and restrictions for the load's requested pickup location."
},
"distanceInMiles": {
"type": "number",
"description": "Automatically calculated distance in miles between the load's requested delivery and pickup locations.",
"example": 1345.56
},
"transitTime": {
"type": "string",
"description": "Automatically estimated time needed for transporting the load.",
"example": "5-6 days"
}
},
"description": "Basic details about the route the load is requested to travel."
},
"shippingItems": {
"type": "array",
"description": "Basic details about the items (vehicles and attachments) contained withing the load. Some of them, such as year, make, model and vin, could be set entirely as custom inputs.",
"items": {
"required": [
"vehicle"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the shipping item",
"example": "YK41K"
},
"vehicle": {
"required": [
"operableType"
],
"type": "object",
"properties": {
"bodyType": {
"type": "string",
"description": "Body type of the vehicle (sedan, SUV, pickup, motorcycle, mini-van, van)",
"example": "Car"
},
"buyerNumber": {
"type": "string",
"description": "Number used to purchase the vehicle during an auction. Can be defined by the customer.",
"example": "123CXS23"
},
"color": {
"type": "string",
"description": "Color of the vehicle.",
"example": "red"
},
"lotNumber": {
"type": "string",
"description": "Parking number the vehicle was positioned during an auction. Can be defined by the customer.",
"example": "123CXS23"
},
"stockNumber": {
"type": "string",
"description": "Unique vehicle stock number. Can be defined by the customer.",
"example": "123CXS23"
},
"vin": {
"type": "string",
"description": "Unique vehicle identification number. Replaces year,make and model.",
"example": "1D4GP24R85B225747"
},
"year": {
"minimum": 1900,
"type": "integer",
"description": "Vehicle manufacture year.",
"format": "int32",
"example": 2022
},
"make": {
"type": "string",
"description": "Vehicle brand (manufacturer).",
"example": "BMW"
},
"model": {
"type": "string",
"description": "Vehicle model/brand series.",
"example": "218i"
},
"inventoryUnitId": {
"maxLength": 128,
"minLength": 0,
"type": "string",
"description": "Inventory unit ID",
"example": "IU-2VK5EDPDNVHGJHTYFSQ7USQYB4"
},
"id": {
"type": "string",
"description": "Internal ID of the vehicle",
"example": "YK41K"
},
"length": {
"type": "string",
"description": "Length size of the vehicle.",
"example": "4526"
},
"height": {
"type": "string",
"description": "Height size of the vehicle.",
"example": "1420"
},
"width": {
"type": "string",
"description": "Width size of the vehicle.",
"example": "1800"
},
"weight": {
"type": "string",
"description": "Weight of the vehicle.",
"example": "1325"
},
"logo": {
"type": "string",
"description": "URL of the vehicle make's logo.",
"example": "https://image.com/bmw.jpg"
},
"totalRate": {
"minimum": 0,
"type": "integer",
"description": "Rate of the vehicle, in cents.",
"format": "int64",
"example": 10000
},
"galleryUrl": {
"type": "string",
"description": "Gallery URL of the vehicle.",
"example": "https://ship.cars/app/gallery#eyJ..."
},
"operableType": {
"type": "string",
"description": "Required identifying whether the vehicle is operable or inoperable",
"example": "OPERABLE",
"default": "OPERABLE",
"enum": [
"OPERABLE",
"INOPERABLE"
]
},
"lbExternalId": {
"type": "string",
"description": "External ID of the vehicle as seen in the Load Board platform.",
"example": "123CXS23"
},
"customInformation": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "Custom information for the vehicle.",
"example": "123CXS23"
}
},
"description": "Details and restrictions for the vehicle(s) included in the load."
},
"attachments": {
"type": "array",
"description": "Basic read only details and restrictions for different attachments included in the load by a shipper or a carrier.",
"items": {
"type": "object",
"properties": {
"fileUrl": {
"type": "string",
"description": "Unique Url of the attachment.",
"example": "https://www.media.com/attachment1.jpg"
},
"shareWith": {
"type": "string",
"description": "CARRIER - Shared with the carrier.
\nDRIVER - Shared with the driver.
\nALL - Shared with both carrier and driver.
\n",
"example": "CARRIER",
"default": "ALL",
"enum": [
"CARRIER",
"DRIVER",
"ALL"
]
},
"id": {
"type": "string",
"description": "Internal ID of the attachment.",
"example": "YK41K"
},
"lbExternalId": {
"type": "string",
"description": "External ID of the attachment.",
"example": "CS1235XX"
},
"loadLegId": {
"type": "string",
"description": "Load leg ID linked to the attachment.",
"example": "YK41K"
},
"shippingItemId": {
"type": "string",
"description": "Shipping item ID linked to the attachment.",
"example": "YK41K"
},
"creatorType": {
"type": "string",
"description": "Type of user who created the attachment. Can be either SHIPPER or CARRIER",
"example": "SHIPPER",
"enum": [
"CARRIER",
"SHIPPER"
]
},
"attachmentType": {
"type": "string",
"description": "The type of the attachment",
"example": "DISPATCH_SHEET",
"enum": [
"SHIPPER_ATTACHMENT",
"DISPATCH_SHEET",
"PICKUP_BOL",
"DELIVERY_BOL",
"EXTERNAL_BOL",
"INVOICE",
"PICKUP_DAMAGES_PICTURE",
"PICKUP_ODOMETER_PICTURE",
"DELIVERY_DAMAGES_PICTURE",
"DELIVERY_ODOMETER_PICTURE",
"OTHER"
]
},
"originalFileName": {
"type": "string",
"description": "Original name of the attachment as it was defined outside the platform.",
"example": "Dispatch Sheet"
},
"createdAt": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
},
"lastModified": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
}
},
"description": "Basic read only details and restrictions for different attachments included in the load by a shipper or a carrier."
}
}
},
"description": "Basic details about the items (vehicles and attachments) contained withing the load. Some of them, such as year, make, model and vin, could be set entirely as custom inputs."
}
},
"payments": {
"type": "array",
"description": "Payment details concerning the load.",
"items": {
"required": [
"carrierPayInCents",
"paymentTransactionType",
"paymentType"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the payment.",
"example": "YK41K"
},
"carrierPayInCents": {
"minimum": 0,
"type": "integer",
"description": "Requested full USD amount in cents the carrier is estimated to be paid.",
"format": "int64",
"example": 10000
},
"notes": {
"type": "string",
"description": "Text with details and notes about the payment. Part of the billing information.",
"example": "I prefer cards."
},
"paymentType": {
"type": "string",
"description": " COD - Payment occurs on delivery.
\n COP - Payment occurs on pickup.
\n USHIP - Payment occurs when customers deposit their funds and get a code in return.\n Whoever then gets the code can release the funds and withdraw them.
\n BILLING - Payment occurs when an invoice is presented to a carrier or from a carrier to a shipper.
\n",
"example": "COD",
"enum": [
"COD",
"COP",
"USHIP",
"BILLING"
]
},
"paymentTransactionType": {
"type": "string",
"description": " CUSTOMER_TO_CARRIER - The customer pays the carrier.
\n CARRIER_TO_SHIPPER - The carrier pays the shipper.
\n SHIPPER_TO_CARRIER - The shipper pays the carrier.
\n",
"example": "CUSTOMER_TO_CARRIER",
"enum": [
"CUSTOMER_TO_CARRIER",
"CARRIER_TO_SHIPPER",
"SHIPPER_TO_CARRIER"
]
},
"paymentMethod": {
"type": "string",
"description": " Defines the method used for paying the carrier. Depends on the payment type\n CASH - By cash.
\n BUSINESS_CHECK - Using a check.
\n CASHIERS_CHECK - Through a cash desk.
\n CERTIFIED_FUNDS - With funds guaranteed by the company/issuer certifying them.
\n COMPANY_CHECK - Using a formal company check.
\n COMCHECK - Using a paper check with additional labels and tracking numbers.
\n WIRE_TRANSFER - By transmitting money electronically (no physical exchange).
\n ACH - By transferring the money from one bank to another without using paper checks, wire transfers, credit cards or cash.
\n",
"example": "CASH",
"enum": [
"CASH",
"BUSINESS_CHECK",
"CASHIERS_CHECK",
"CERTIFIED_FUNDS",
"COMPANY_CHECK",
"COMCHECK",
"WIRE_TRANSFER",
"ACH"
]
},
"paymentTermsBeginType": {
"type": "string",
"description": " ON_PICKUP - During pickup process.
\n ON_DELIVERY - During delivery.
\n ON_BOL - After a signed BOL document is received.
\n ON_RECEIPT_INVOICE - After a receipt of invoice is received.
\n",
"example": "ON_BOL",
"enum": [
"ON_PICKUP",
"ON_DELIVERY",
"ON_BOL",
"ON_RECEIPT_INVOICE"
]
},
"paymentTermsType": {
"type": "string",
"description": "Defines when the actual payment will occur.",
"example": "IMMEDIATE",
"enum": [
"IMMEDIATE",
"TWO_DAYS",
"FIVE_DAYS",
"TEN_DAYS",
"FIFTEEN_DAYS",
"THIRTY_DAYS",
"SIXTY_DAYS"
]
}
},
"description": "Payment details concerning the load."
}
},
"carrierPayInCents": {
"maximum": 1000000000,
"minimum": 0,
"type": "integer",
"description": "Total price for the load, in USD.",
"format": "int64",
"example": 100000
},
"createdAt": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
},
"lastModified": {
"type": "string",
"description": "Modification timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
},
"type": {
"type": "string",
"description": "Load type",
"readOnly": true,
"enum": [
"STANDARD",
"MANAGED_ORDER",
"DRIVEAWAY",
"CHASE_DRIVER"
]
},
"contract": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the contract",
"example": "YK41K"
},
"shipper": {
"required": [
"name",
"primaryPhone"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the contact.",
"example": "YK41K"
},
"companyName": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Formal name of the company.",
"example": "Martin LLC"
},
"email": {
"maxLength": 254,
"minLength": 0,
"type": "string",
"description": "Email address.",
"example": "email@email.com"
},
"name": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Name(s) of the person.",
"example": "Martin Fuller"
},
"primaryPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Required primary phone used for contacting.",
"example": "1234567890"
},
"primaryPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the primary phone, if applicable.",
"example": "Do not call me before 8"
},
"secondaryPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Secondary phone used for contacting, if applicable.",
"example": "1234567890"
},
"secondaryPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the secondary phone, if applicable.",
"example": "Do not call me before 8"
},
"thirdPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Third phone used for contacting, if applicable.",
"example": "1234567890"
},
"thirdPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the third phone, if applicable.",
"example": "Do not call me before 8"
},
"workingHours": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Official working hours of the company/entity",
"example": "From 5 to 12"
},
"location": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
}
},
"description": "Required location information."
},
"type": {
"type": "string",
"description": "Contact type",
"example": "CUSTOMER",
"enum": [
"CUSTOMER",
"PICKUP",
"DELIVERY"
]
},
"notes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Contact notes, if applicable.",
"example": "Located in building A-C1"
}
}
},
"userAccount": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal posting user ID",
"example": "YK41K"
},
"userManagementId": {
"type": "string",
"description": "External ID of the user as seen in the User Management platform service.",
"example": "U-2VK5EDPDNVHGJHTYFSQ7USQYB4"
},
"name": {
"type": "string",
"description": "User's full name",
"example": "Martin"
},
"phone": {
"type": "string",
"description": "User's phone number",
"example": "5551237890"
},
"email": {
"type": "string",
"description": "User's email",
"example": "email@email.com"
},
"profilePictureUrl": {
"type": "string",
"description": "URL to profile picture of the driver",
"example": "https://www.image.com/picture.jpg"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal posting company ID",
"example": "YK41K"
},
"userManagementId": {
"type": "string",
"description": "External ID of the company as seen in the User Management platform service.",
"example": "C-2VK5EDPDNVHGJHTYFSQ7USQYB4"
},
"name": {
"type": "string",
"description": "Company's full name",
"example": "Martin LLC"
},
"email": {
"type": "string",
"description": "Company's email",
"example": "company@example.com"
},
"accountingEmail": {
"type": "string",
"description": "Company's accounting email",
"example": "company@example.com"
},
"usDotNumber": {
"type": "string",
"description": "Unique US DOT number of the company.",
"example": "1234567"
},
"logoUrl": {
"type": "string",
"description": "URL of the company's logo",
"example": "https://www.image.com/logo.jpg"
}
}
}
}
}
},
"description": "Contact information about the shipper creating the load."
},
"attachments": {
"type": "array",
"description": "Details and restrictions regarding any attachments included in the load.",
"items": {
"type": "object",
"properties": {
"fileUrl": {
"type": "string",
"description": "Unique Url of the attachment.",
"example": "https://www.media.com/attachment1.jpg"
},
"shareWith": {
"type": "string",
"description": "CARRIER - Shared with the carrier.
\nDRIVER - Shared with the driver.
\nALL - Shared with both carrier and driver.
\n",
"example": "CARRIER",
"default": "ALL",
"enum": [
"CARRIER",
"DRIVER",
"ALL"
]
},
"id": {
"type": "string",
"description": "Internal ID of the attachment.",
"example": "YK41K"
},
"lbExternalId": {
"type": "string",
"description": "External ID of the attachment.",
"example": "CS1235XX"
},
"loadLegId": {
"type": "string",
"description": "Load leg ID linked to the attachment.",
"example": "YK41K"
},
"shippingItemId": {
"type": "string",
"description": "Shipping item ID linked to the attachment.",
"example": "YK41K"
},
"creatorType": {
"type": "string",
"description": "Type of user who created the attachment. Can be either SHIPPER or CARRIER",
"example": "SHIPPER",
"enum": [
"CARRIER",
"SHIPPER"
]
},
"attachmentType": {
"type": "string",
"description": "The type of the attachment",
"example": "DISPATCH_SHEET",
"enum": [
"SHIPPER_ATTACHMENT",
"DISPATCH_SHEET",
"PICKUP_BOL",
"DELIVERY_BOL",
"EXTERNAL_BOL",
"INVOICE",
"PICKUP_DAMAGES_PICTURE",
"PICKUP_ODOMETER_PICTURE",
"DELIVERY_DAMAGES_PICTURE",
"DELIVERY_ODOMETER_PICTURE",
"OTHER"
]
},
"originalFileName": {
"type": "string",
"description": "Original name of the attachment as it was defined outside the platform.",
"example": "Dispatch Sheet"
},
"createdAt": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
},
"lastModified": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
}
},
"description": "Basic read only details and restrictions for different attachments included in the load by a shipper or a carrier."
}
},
"pickupContact": {
"required": [
"name",
"primaryPhone"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the contact.",
"example": "YK41K"
},
"companyName": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Formal name of the company.",
"example": "Martin LLC"
},
"email": {
"maxLength": 254,
"minLength": 0,
"type": "string",
"description": "Email address.",
"example": "email@email.com"
},
"name": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Name(s) of the person.",
"example": "Martin Fuller"
},
"primaryPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Required primary phone used for contacting.",
"example": "1234567890"
},
"primaryPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the primary phone, if applicable.",
"example": "Do not call me before 8"
},
"secondaryPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Secondary phone used for contacting, if applicable.",
"example": "1234567890"
},
"secondaryPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the secondary phone, if applicable.",
"example": "Do not call me before 8"
},
"thirdPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Third phone used for contacting, if applicable.",
"example": "1234567890"
},
"thirdPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the third phone, if applicable.",
"example": "Do not call me before 8"
},
"workingHours": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Official working hours of the company/entity",
"example": "From 5 to 12"
},
"location": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
}
},
"description": "Required location information."
},
"type": {
"type": "string",
"description": "Contact type",
"example": "CUSTOMER",
"enum": [
"CUSTOMER",
"PICKUP",
"DELIVERY"
]
},
"notes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Contact notes, if applicable.",
"example": "Located in building A-C1"
}
}
},
"deliveryContact": {
"required": [
"name",
"primaryPhone"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the contact.",
"example": "YK41K"
},
"companyName": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Formal name of the company.",
"example": "Martin LLC"
},
"email": {
"maxLength": 254,
"minLength": 0,
"type": "string",
"description": "Email address.",
"example": "email@email.com"
},
"name": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Name(s) of the person.",
"example": "Martin Fuller"
},
"primaryPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Required primary phone used for contacting.",
"example": "1234567890"
},
"primaryPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the primary phone, if applicable.",
"example": "Do not call me before 8"
},
"secondaryPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Secondary phone used for contacting, if applicable.",
"example": "1234567890"
},
"secondaryPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the secondary phone, if applicable.",
"example": "Do not call me before 8"
},
"thirdPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Third phone used for contacting, if applicable.",
"example": "1234567890"
},
"thirdPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the third phone, if applicable.",
"example": "Do not call me before 8"
},
"workingHours": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Official working hours of the company/entity",
"example": "From 5 to 12"
},
"location": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
}
},
"description": "Required location information."
},
"type": {
"type": "string",
"description": "Contact type",
"example": "CUSTOMER",
"enum": [
"CUSTOMER",
"PICKUP",
"DELIVERY"
]
},
"notes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Contact notes, if applicable.",
"example": "Located in building A-C1"
}
}
},
"publicLinkInfo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the public link info.",
"example": "YK41K"
},
"publicLinkKey": {
"type": "string",
"description": "Key for the public link",
"example": "1231435435"
},
"publicLink": {
"type": "string",
"description": "Full URL for the public link.",
"example": "https://www.public-link.com"
}
},
"description": "Unique public URL used for tracking the load as it is transported from point A to point B."
},
"externalId": {
"type": "string",
"description": "External platform carrier ID",
"example": "123XX"
},
"load": {
"required": [
"useEnclosedTrailer",
"useM22InspectionGuide"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the load",
"example": "YK41K"
},
"dispatchInstructions": {
"type": "string",
"description": "Text instructions concerning the load's dispatch, if applicable.",
"example": "Please, do not come before 6."
},
"useEnclosedTrailer": {
"type": "boolean",
"description": "Required true/false statement identifying the trailer which will carry the load.",
"example": true
},
"useM22InspectionGuide": {
"type": "boolean",
"description": "Required true/false statement identifying which damage inspection method the load is associated with. Any vehicle is inspected upon pick up and delivery either in the standard or the M22 method.",
"example": true
},
"useGpsTracking": {
"type": "boolean",
"description": "true/false statement identifying whether GPS tracking is activated for the load",
"example": true,
"default": false
}
},
"description": "Load details"
},
"carrier": {
"required": [
"primaryPhone"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the contact",
"example": "YK41K"
},
"email": {
"type": "string",
"description": "Email address of the carrier",
"example": "email@email.com"
},
"name": {
"pattern": "(^[0-9a-zA-Z\\s'-.]+$)",
"type": "string",
"example": "Martin Fuller"
},
"primaryPhone": {
"type": "string",
"example": "1234567890"
},
"primaryPhoneNotes": {
"type": "string",
"description": "Notes related to the primary phone, if applicable.",
"example": "Do not call me before 8"
},
"secondaryPhone": {
"type": "string",
"description": "Secondary phone used for contacting, if applicable.",
"example": "1234567890"
},
"secondaryPhoneNotes": {
"type": "string",
"description": "Notes related to the secondary phone, if applicable.",
"example": "Do not call me before 8"
},
"thirdPhone": {
"type": "string",
"description": "Third phone used for contacting, if applicable.",
"example": "1234567890"
},
"thirdPhoneNotes": {
"type": "string",
"description": "Notes related to the third phone, if applicable.",
"example": "Do not call me before 8"
},
"logo": {
"type": "string",
"description": "URL of the carrier company's logo (if not a person)",
"example": "https://www.image.com/logo.jpg"
},
"usDot": {
"type": "integer",
"description": "Unique US DOT number of the carrier.",
"format": "int64",
"example": 1234567
},
"lbExternalId": {
"type": "string",
"description": "ID of the carrier entity as visible on the external platform",
"example": "123X"
},
"location": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
}
},
"description": "Required location information."
},
"userManagementId": {
"type": "string",
"description": "External ID of the carrier as seen in the User Management platform service ",
"example": "123X"
}
},
"description": "Contact information related to the carrier person/company."
},
"contractPricing": {
"type": "object",
"properties": {
"basePrice": {
"type": "number",
"description": "Base price from Contract Pricing",
"example": 70
},
"totalPrice": {
"type": "number",
"description": "Total price from Contract Pricing with surcharges and discounts",
"example": 200.45
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the line item - discounts or surcharges",
"example": "SURCHARGE",
"enum": [
"SURCHARGE",
"DISCOUNT"
]
},
"description": {
"type": "string",
"description": "Shows how the item was calculated",
"example": "2$ Per Mile for 900 miles"
},
"title": {
"type": "string",
"example": "Fuel"
},
"price": {
"type": "number",
"description": "Price of each item",
"example": 130.45
}
}
}
},
"distance": {
"type": "number",
"description": "Distance for the calculation in miles",
"example": 2900
},
"pricePerMile": {
"type": "number",
"description": "Price per mile",
"example": 3
}
},
"description": "Shows whether the carrier has contract pricing with all details"
},
"driver": {
"required": [
"lbExternalId",
"phone"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the driver.",
"example": "YK41K"
},
"name": {
"pattern": "(^[0-9a-zA-Z\\s'-.]+$)",
"type": "string",
"description": "Name(s) of the driver.",
"example": "Martin Fuller"
},
"email": {
"type": "string",
"description": "Driver's email.",
"example": "email@email.com"
},
"phone": {
"type": "string",
"description": "Required primary phone used for contacting the driver.",
"example": "1234567890"
},
"additionalPhone": {
"type": "string",
"description": "Optional secondary phone used for contacting the driver.",
"example": "1234567890"
},
"lbExternalId": {
"type": "string",
"description": "ID of the driver as visible on the external platform.",
"example": "123X"
},
"profilePictureUrl": {
"type": "string",
"description": "URL to profile picture of the driver.",
"example": "https://www.image.com/picture.jpg"
},
"userManagementId": {
"type": "string",
"description": "External ID of the driver as seen in the User Management platform service.",
"example": "U-2VK5EDPDNVHGJHTYFSQ7USQYB4"
}
},
"description": "Contact information related to the driver assigned to the load."
},
"carrierOffers": {
"type": "array",
"description": "Information about the offer or offers (making up a negotiation) made by the carrier to the shipper regarding the final costs of transporting the load. Appears only after the load is created and a carrier offer for it was accepted.",
"items": {
"required": [
"expirationDate",
"priceInCents",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the carrierOffer.",
"example": "YK41K"
},
"priceInCents": {
"type": "integer",
"description": "Required total price (in cents) as according to the offer.",
"format": "int64",
"example": 100000
},
"carrierDot": {
"type": "string",
"description": "Unique USDOT number of the carrier.",
"example": "1111111"
},
"negotiationId": {
"type": "string",
"description": "Internal ID of the negotiation that occurred between the carrier and the shipper. Includes the last offer.",
"example": "123X"
},
"status": {
"type": "string",
"description": "Status of the last carrier offer.
\n\nACTIVE - Offer is active.
\nCANCELLED - Offer is canceled.
\nEXPIRED - Offer has been expired.
\nARCHIVED - Offer is archived.
\n",
"example": "active"
},
"externalId": {
"type": "string",
"description": "External ID of the last carrier offer.",
"example": "123X"
},
"companyId": {
"type": "string",
"description": "Internal ID of the carrier company.",
"example": "123X"
},
"expirationDate": {
"type": "string",
"description": "UTC Time of expiry of the negotiation. If the final offer of the negotiation is not. Concluded (accepted or declined) before this date, it will be automatically archived.",
"format": "date-time"
}
},
"description": "Information about the offer or offers (making up a negotiation) made by the carrier to the shipper regarding the final costs of transporting the load. Appears only after the load is created and a carrier offer for it was accepted."
}
},
"pickupSignatureRequired": {
"type": "boolean",
"description": "true/false statement indicating whether signature will be required on pickup.",
"example": false,
"default": true
},
"deliverySignatureRequired": {
"type": "boolean",
"description": "true/false statement indicating whether signature will be required on delivery.",
"example": false,
"default": true
},
"extRateCalculationId": {
"type": "string",
"description": "External ID of the rate engine calculation.",
"example": "YKXS23IJ"
}
}
},
"carrierDot": {
"type": "string",
"description": "Carrier dot to which you are dispatching",
"example": "1234567"
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"required": [
"carrierPayInCents",
"contract",
"deliveryContact",
"deliverySignatureRequired",
"load",
"payments",
"pickupContact",
"pickupSignatureRequired",
"route",
"shippingItems"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the load",
"example": "YK41K"
},
"status": {
"type": "string",
"description": " NEW - (Used by Driveaway Loads), if the driveaway driver decides to decline the load,
\n the status changes to NEW
\n PENDING_POSTING - The load’s posting is in progress.
\n POSTED - The load is posted on the LoadBoard.
\n PENDING_CLAIM - The load has been dispatched to the carrier or a carrier offer has been accepted.
\n Upon successful dispatch, the status changes to CARRIER_PENDING.
\n CARRIER_PENDING - The load is dispatched (through negotiation or directly)
\n and a carrier is presented with the option to accept or decline it.
\n DISPATCHED - The load has been dispatched.
\n ASSIGNED - The load has been assigned to a driver by a carrier.
\n PICKED_UP - The load has been picked up.
\n DELIVERED - The load has been delivered.
\n PENDING_ARCHIVE - The load’s archiving is pending.
\n ARCHIVED - The load has been archived.
\n",
"example": "[\"POSTED\",\"PICKED_UP\"]",
"enum": [
"NEW",
"PENDING_POSTING",
"POSTED",
"PENDING_CLAIM",
"CARRIER_PENDING",
"DISPATCHED",
"ASSIGNED",
"PICKED_UP",
"DELIVERED",
"PENDING_ARCHIVE",
"ARCHIVED"
]
},
"bookingAgent": {
"type": "string",
"description": "Booking Agent (creator) of the load",
"example": "Martin"
},
"shipperLoadId": {
"type": "string",
"description": "Custom identifying the number or name of the load. Generated in the response if not set on request",
"example": "CS1234X"
},
"route": {
"required": [
"deliveryLocation",
"pickupLocation",
"pickupRequestedDateDetail"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the route entity",
"example": "YK41K"
},
"pickupRequestedDateDetail": {
"required": [
"estimatedEndDate",
"estimatedStartDate",
"restriction"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the date",
"example": "YK41K"
},
"estimatedEndDate": {
"type": "string",
"description": "End date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-23"
},
"estimatedStartDate": {
"type": "string",
"description": "Start date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-21"
},
"restriction": {
"type": "string",
"description": " NO_RESTRICTIONS - No limitations.
\n NOT_EARLIER - Not earlier than a given date.
\n NOT_LATER - Not later than a given date.
\n NOT_EARLIER_NOT_LATER - Not earlier than a given date and not later than another date.
\n",
"example": "NO_RESTRICTIONS",
"default": "NO_RESTRICTIONS",
"enum": [
"NO_RESTRICTIONS",
"NOT_EARLIER",
"NOT_LATER",
"NOT_EARLIER_NOT_LATER"
]
}
},
"description": "Required details and restrictions for the load's estimated delivery date."
},
"pickupEstimatedDateDetail": {
"required": [
"estimatedEndDate",
"estimatedStartDate",
"restriction"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the date",
"example": "YK41K"
},
"estimatedEndDate": {
"type": "string",
"description": "End date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-23"
},
"estimatedStartDate": {
"type": "string",
"description": "Start date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-21"
},
"restriction": {
"type": "string",
"description": " NO_RESTRICTIONS - No limitations.
\n NOT_EARLIER - Not earlier than a given date.
\n NOT_LATER - Not later than a given date.
\n NOT_EARLIER_NOT_LATER - Not earlier than a given date and not later than another date.
\n",
"example": "NO_RESTRICTIONS",
"default": "NO_RESTRICTIONS",
"enum": [
"NO_RESTRICTIONS",
"NOT_EARLIER",
"NOT_LATER",
"NOT_EARLIER_NOT_LATER"
]
}
},
"description": "Required details and restrictions for the load's estimated delivery date."
},
"pickupActualDate": {
"type": "string",
"description": "Delivery actual date in yyyy-mm-dd format",
"format": "date",
"readOnly": true,
"example": "2022-03-23"
},
"deliveryRequestedDateDetail": {
"required": [
"estimatedEndDate",
"estimatedStartDate",
"restriction"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the date",
"example": "YK41K"
},
"estimatedEndDate": {
"type": "string",
"description": "End date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-23"
},
"estimatedStartDate": {
"type": "string",
"description": "Start date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-21"
},
"restriction": {
"type": "string",
"description": " NO_RESTRICTIONS - No limitations.
\n NOT_EARLIER - Not earlier than a given date.
\n NOT_LATER - Not later than a given date.
\n NOT_EARLIER_NOT_LATER - Not earlier than a given date and not later than another date.
\n",
"example": "NO_RESTRICTIONS",
"default": "NO_RESTRICTIONS",
"enum": [
"NO_RESTRICTIONS",
"NOT_EARLIER",
"NOT_LATER",
"NOT_EARLIER_NOT_LATER"
]
}
},
"description": "Required details and restrictions for the load's estimated delivery date."
},
"deliveryEstimatedDateDetail": {
"required": [
"estimatedEndDate",
"estimatedStartDate",
"restriction"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the date",
"example": "YK41K"
},
"estimatedEndDate": {
"type": "string",
"description": "End date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-23"
},
"estimatedStartDate": {
"type": "string",
"description": "Start date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-21"
},
"restriction": {
"type": "string",
"description": " NO_RESTRICTIONS - No limitations.
\n NOT_EARLIER - Not earlier than a given date.
\n NOT_LATER - Not later than a given date.
\n NOT_EARLIER_NOT_LATER - Not earlier than a given date and not later than another date.
\n",
"example": "NO_RESTRICTIONS",
"default": "NO_RESTRICTIONS",
"enum": [
"NO_RESTRICTIONS",
"NOT_EARLIER",
"NOT_LATER",
"NOT_EARLIER_NOT_LATER"
]
}
},
"description": "Required details and restrictions for the load's estimated delivery date."
},
"deliveryActualDate": {
"type": "string",
"description": "Delivery actual date in yyyy-mm-dd format",
"format": "date",
"readOnly": true,
"example": "2022-03-23"
},
"deliveryLocation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
},
"longitude": {
"type": "string",
"description": "Auto-generated longitude coordinates of the location",
"example": "-94.2332754"
},
"latitude": {
"type": "string",
"description": "Auto-generated latitude coordinates of the location",
"example": "39.3514073"
}
},
"description": "Required details and restrictions for the load's requested pickup location."
},
"pickupLocation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
},
"longitude": {
"type": "string",
"description": "Auto-generated longitude coordinates of the location",
"example": "-94.2332754"
},
"latitude": {
"type": "string",
"description": "Auto-generated latitude coordinates of the location",
"example": "39.3514073"
}
},
"description": "Required details and restrictions for the load's requested pickup location."
},
"distanceInMiles": {
"type": "number",
"description": "Automatically calculated distance in miles between the load's requested delivery and pickup locations.",
"example": 1345.56
},
"transitTime": {
"type": "string",
"description": "Automatically estimated time needed for transporting the load.",
"example": "5-6 days"
}
},
"description": "Basic details about the route the load is requested to travel."
},
"shippingItems": {
"type": "array",
"description": "Basic details about the items (vehicles and attachments) contained withing the load. Some of them, such as year, make, model and vin, could be set entirely as custom inputs.",
"items": {
"required": [
"vehicle"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the shipping item",
"example": "YK41K"
},
"vehicle": {
"required": [
"operableType"
],
"type": "object",
"properties": {
"bodyType": {
"type": "string",
"description": "Body type of the vehicle (sedan, SUV, pickup, motorcycle, mini-van, van)",
"example": "Car"
},
"buyerNumber": {
"type": "string",
"description": "Number used to purchase the vehicle during an auction. Can be defined by the customer.",
"example": "123CXS23"
},
"color": {
"type": "string",
"description": "Color of the vehicle.",
"example": "red"
},
"lotNumber": {
"type": "string",
"description": "Parking number the vehicle was positioned during an auction. Can be defined by the customer.",
"example": "123CXS23"
},
"stockNumber": {
"type": "string",
"description": "Unique vehicle stock number. Can be defined by the customer.",
"example": "123CXS23"
},
"vin": {
"type": "string",
"description": "Unique vehicle identification number. Replaces year,make and model.",
"example": "1D4GP24R85B225747"
},
"year": {
"minimum": 1900,
"type": "integer",
"description": "Vehicle manufacture year.",
"format": "int32",
"example": 2022
},
"make": {
"type": "string",
"description": "Vehicle brand (manufacturer).",
"example": "BMW"
},
"model": {
"type": "string",
"description": "Vehicle model/brand series.",
"example": "218i"
},
"inventoryUnitId": {
"maxLength": 128,
"minLength": 0,
"type": "string",
"description": "Inventory unit ID",
"example": "IU-2VK5EDPDNVHGJHTYFSQ7USQYB4"
},
"id": {
"type": "string",
"description": "Internal ID of the vehicle",
"example": "YK41K"
},
"length": {
"type": "string",
"description": "Length size of the vehicle.",
"example": "4526"
},
"height": {
"type": "string",
"description": "Height size of the vehicle.",
"example": "1420"
},
"width": {
"type": "string",
"description": "Width size of the vehicle.",
"example": "1800"
},
"weight": {
"type": "string",
"description": "Weight of the vehicle.",
"example": "1325"
},
"logo": {
"type": "string",
"description": "URL of the vehicle make's logo.",
"example": "https://image.com/bmw.jpg"
},
"totalRate": {
"minimum": 0,
"type": "integer",
"description": "Rate of the vehicle, in cents.",
"format": "int64",
"example": 10000
},
"galleryUrl": {
"type": "string",
"description": "Gallery URL of the vehicle.",
"example": "https://ship.cars/app/gallery#eyJ..."
},
"operableType": {
"type": "string",
"description": "Required identifying whether the vehicle is operable or inoperable",
"example": "OPERABLE",
"default": "OPERABLE",
"enum": [
"OPERABLE",
"INOPERABLE"
]
},
"lbExternalId": {
"type": "string",
"description": "External ID of the vehicle as seen in the Load Board platform.",
"example": "123CXS23"
},
"customInformation": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "Custom information for the vehicle.",
"example": "123CXS23"
}
},
"description": "Details and restrictions for the vehicle(s) included in the load."
},
"attachments": {
"type": "array",
"description": "Basic read only details and restrictions for different attachments included in the load by a shipper or a carrier.",
"items": {
"type": "object",
"properties": {
"fileUrl": {
"type": "string",
"description": "Unique Url of the attachment.",
"example": "https://www.media.com/attachment1.jpg"
},
"shareWith": {
"type": "string",
"description": "CARRIER - Shared with the carrier.
\nDRIVER - Shared with the driver.
\nALL - Shared with both carrier and driver.
\n",
"example": "CARRIER",
"default": "ALL",
"enum": [
"CARRIER",
"DRIVER",
"ALL"
]
},
"id": {
"type": "string",
"description": "Internal ID of the attachment.",
"example": "YK41K"
},
"lbExternalId": {
"type": "string",
"description": "External ID of the attachment.",
"example": "CS1235XX"
},
"loadLegId": {
"type": "string",
"description": "Load leg ID linked to the attachment.",
"example": "YK41K"
},
"shippingItemId": {
"type": "string",
"description": "Shipping item ID linked to the attachment.",
"example": "YK41K"
},
"creatorType": {
"type": "string",
"description": "Type of user who created the attachment. Can be either SHIPPER or CARRIER",
"example": "SHIPPER",
"enum": [
"CARRIER",
"SHIPPER"
]
},
"attachmentType": {
"type": "string",
"description": "The type of the attachment",
"example": "DISPATCH_SHEET",
"enum": [
"SHIPPER_ATTACHMENT",
"DISPATCH_SHEET",
"PICKUP_BOL",
"DELIVERY_BOL",
"EXTERNAL_BOL",
"INVOICE",
"PICKUP_DAMAGES_PICTURE",
"PICKUP_ODOMETER_PICTURE",
"DELIVERY_DAMAGES_PICTURE",
"DELIVERY_ODOMETER_PICTURE",
"OTHER"
]
},
"originalFileName": {
"type": "string",
"description": "Original name of the attachment as it was defined outside the platform.",
"example": "Dispatch Sheet"
},
"createdAt": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
},
"lastModified": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
}
},
"description": "Basic read only details and restrictions for different attachments included in the load by a shipper or a carrier."
}
}
},
"description": "Basic details about the items (vehicles and attachments) contained withing the load. Some of them, such as year, make, model and vin, could be set entirely as custom inputs."
}
},
"payments": {
"type": "array",
"description": "Payment details concerning the load.",
"items": {
"required": [
"carrierPayInCents",
"paymentTransactionType",
"paymentType"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the payment.",
"example": "YK41K"
},
"carrierPayInCents": {
"minimum": 0,
"type": "integer",
"description": "Requested full USD amount in cents the carrier is estimated to be paid.",
"format": "int64",
"example": 10000
},
"notes": {
"type": "string",
"description": "Text with details and notes about the payment. Part of the billing information.",
"example": "I prefer cards."
},
"paymentType": {
"type": "string",
"description": " COD - Payment occurs on delivery.
\n COP - Payment occurs on pickup.
\n USHIP - Payment occurs when customers deposit their funds and get a code in return.\n Whoever then gets the code can release the funds and withdraw them.
\n BILLING - Payment occurs when an invoice is presented to a carrier or from a carrier to a shipper.
\n",
"example": "COD",
"enum": [
"COD",
"COP",
"USHIP",
"BILLING"
]
},
"paymentTransactionType": {
"type": "string",
"description": " CUSTOMER_TO_CARRIER - The customer pays the carrier.
\n CARRIER_TO_SHIPPER - The carrier pays the shipper.
\n SHIPPER_TO_CARRIER - The shipper pays the carrier.
\n",
"example": "CUSTOMER_TO_CARRIER",
"enum": [
"CUSTOMER_TO_CARRIER",
"CARRIER_TO_SHIPPER",
"SHIPPER_TO_CARRIER"
]
},
"paymentMethod": {
"type": "string",
"description": " Defines the method used for paying the carrier. Depends on the payment type\n CASH - By cash.
\n BUSINESS_CHECK - Using a check.
\n CASHIERS_CHECK - Through a cash desk.
\n CERTIFIED_FUNDS - With funds guaranteed by the company/issuer certifying them.
\n COMPANY_CHECK - Using a formal company check.
\n COMCHECK - Using a paper check with additional labels and tracking numbers.
\n WIRE_TRANSFER - By transmitting money electronically (no physical exchange).
\n ACH - By transferring the money from one bank to another without using paper checks, wire transfers, credit cards or cash.
\n",
"example": "CASH",
"enum": [
"CASH",
"BUSINESS_CHECK",
"CASHIERS_CHECK",
"CERTIFIED_FUNDS",
"COMPANY_CHECK",
"COMCHECK",
"WIRE_TRANSFER",
"ACH"
]
},
"paymentTermsBeginType": {
"type": "string",
"description": " ON_PICKUP - During pickup process.
\n ON_DELIVERY - During delivery.
\n ON_BOL - After a signed BOL document is received.
\n ON_RECEIPT_INVOICE - After a receipt of invoice is received.
\n",
"example": "ON_BOL",
"enum": [
"ON_PICKUP",
"ON_DELIVERY",
"ON_BOL",
"ON_RECEIPT_INVOICE"
]
},
"paymentTermsType": {
"type": "string",
"description": "Defines when the actual payment will occur.",
"example": "IMMEDIATE",
"enum": [
"IMMEDIATE",
"TWO_DAYS",
"FIVE_DAYS",
"TEN_DAYS",
"FIFTEEN_DAYS",
"THIRTY_DAYS",
"SIXTY_DAYS"
]
}
},
"description": "Payment details concerning the load."
}
},
"carrierPayInCents": {
"maximum": 1000000000,
"minimum": 0,
"type": "integer",
"description": "Total price for the load, in USD.",
"format": "int64",
"example": 100000
},
"createdAt": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
},
"lastModified": {
"type": "string",
"description": "Modification timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
},
"type": {
"type": "string",
"description": "Load type",
"readOnly": true,
"enum": [
"STANDARD",
"MANAGED_ORDER",
"DRIVEAWAY",
"CHASE_DRIVER"
]
},
"contract": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the contract",
"example": "YK41K"
},
"shipper": {
"required": [
"name",
"primaryPhone"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the contact.",
"example": "YK41K"
},
"companyName": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Formal name of the company.",
"example": "Martin LLC"
},
"email": {
"maxLength": 254,
"minLength": 0,
"type": "string",
"description": "Email address.",
"example": "email@email.com"
},
"name": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Name(s) of the person.",
"example": "Martin Fuller"
},
"primaryPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Required primary phone used for contacting.",
"example": "1234567890"
},
"primaryPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the primary phone, if applicable.",
"example": "Do not call me before 8"
},
"secondaryPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Secondary phone used for contacting, if applicable.",
"example": "1234567890"
},
"secondaryPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the secondary phone, if applicable.",
"example": "Do not call me before 8"
},
"thirdPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Third phone used for contacting, if applicable.",
"example": "1234567890"
},
"thirdPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the third phone, if applicable.",
"example": "Do not call me before 8"
},
"workingHours": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Official working hours of the company/entity",
"example": "From 5 to 12"
},
"location": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
}
},
"description": "Required location information."
},
"type": {
"type": "string",
"description": "Contact type",
"example": "CUSTOMER",
"enum": [
"CUSTOMER",
"PICKUP",
"DELIVERY"
]
},
"notes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Contact notes, if applicable.",
"example": "Located in building A-C1"
}
}
},
"userAccount": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal posting user ID",
"example": "YK41K"
},
"userManagementId": {
"type": "string",
"description": "External ID of the user as seen in the User Management platform service.",
"example": "U-2VK5EDPDNVHGJHTYFSQ7USQYB4"
},
"name": {
"type": "string",
"description": "User's full name",
"example": "Martin"
},
"phone": {
"type": "string",
"description": "User's phone number",
"example": "5551237890"
},
"email": {
"type": "string",
"description": "User's email",
"example": "email@email.com"
},
"profilePictureUrl": {
"type": "string",
"description": "URL to profile picture of the driver",
"example": "https://www.image.com/picture.jpg"
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal posting company ID",
"example": "YK41K"
},
"userManagementId": {
"type": "string",
"description": "External ID of the company as seen in the User Management platform service.",
"example": "C-2VK5EDPDNVHGJHTYFSQ7USQYB4"
},
"name": {
"type": "string",
"description": "Company's full name",
"example": "Martin LLC"
},
"email": {
"type": "string",
"description": "Company's email",
"example": "company@example.com"
},
"accountingEmail": {
"type": "string",
"description": "Company's accounting email",
"example": "company@example.com"
},
"usDotNumber": {
"type": "string",
"description": "Unique US DOT number of the company.",
"example": "1234567"
},
"logoUrl": {
"type": "string",
"description": "URL of the company's logo",
"example": "https://www.image.com/logo.jpg"
}
}
}
}
}
},
"description": "Contact information about the shipper creating the load."
},
"attachments": {
"type": "array",
"description": "Details and restrictions regarding any attachments included in the load.",
"items": {
"type": "object",
"properties": {
"fileUrl": {
"type": "string",
"description": "Unique Url of the attachment.",
"example": "https://www.media.com/attachment1.jpg"
},
"shareWith": {
"type": "string",
"description": "CARRIER - Shared with the carrier.
\nDRIVER - Shared with the driver.
\nALL - Shared with both carrier and driver.
\n",
"example": "CARRIER",
"default": "ALL",
"enum": [
"CARRIER",
"DRIVER",
"ALL"
]
},
"id": {
"type": "string",
"description": "Internal ID of the attachment.",
"example": "YK41K"
},
"lbExternalId": {
"type": "string",
"description": "External ID of the attachment.",
"example": "CS1235XX"
},
"loadLegId": {
"type": "string",
"description": "Load leg ID linked to the attachment.",
"example": "YK41K"
},
"shippingItemId": {
"type": "string",
"description": "Shipping item ID linked to the attachment.",
"example": "YK41K"
},
"creatorType": {
"type": "string",
"description": "Type of user who created the attachment. Can be either SHIPPER or CARRIER",
"example": "SHIPPER",
"enum": [
"CARRIER",
"SHIPPER"
]
},
"attachmentType": {
"type": "string",
"description": "The type of the attachment",
"example": "DISPATCH_SHEET",
"enum": [
"SHIPPER_ATTACHMENT",
"DISPATCH_SHEET",
"PICKUP_BOL",
"DELIVERY_BOL",
"EXTERNAL_BOL",
"INVOICE",
"PICKUP_DAMAGES_PICTURE",
"PICKUP_ODOMETER_PICTURE",
"DELIVERY_DAMAGES_PICTURE",
"DELIVERY_ODOMETER_PICTURE",
"OTHER"
]
},
"originalFileName": {
"type": "string",
"description": "Original name of the attachment as it was defined outside the platform.",
"example": "Dispatch Sheet"
},
"createdAt": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
},
"lastModified": {
"type": "string",
"description": "Creation timestamp",
"format": "date-time",
"example": "2022-05-13T13:46:44.627Z"
}
},
"description": "Basic read only details and restrictions for different attachments included in the load by a shipper or a carrier."
}
},
"pickupContact": {
"required": [
"name",
"primaryPhone"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the contact.",
"example": "YK41K"
},
"companyName": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Formal name of the company.",
"example": "Martin LLC"
},
"email": {
"maxLength": 254,
"minLength": 0,
"type": "string",
"description": "Email address.",
"example": "email@email.com"
},
"name": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Name(s) of the person.",
"example": "Martin Fuller"
},
"primaryPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Required primary phone used for contacting.",
"example": "1234567890"
},
"primaryPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the primary phone, if applicable.",
"example": "Do not call me before 8"
},
"secondaryPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Secondary phone used for contacting, if applicable.",
"example": "1234567890"
},
"secondaryPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the secondary phone, if applicable.",
"example": "Do not call me before 8"
},
"thirdPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Third phone used for contacting, if applicable.",
"example": "1234567890"
},
"thirdPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the third phone, if applicable.",
"example": "Do not call me before 8"
},
"workingHours": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Official working hours of the company/entity",
"example": "From 5 to 12"
},
"location": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
}
},
"description": "Required location information."
},
"type": {
"type": "string",
"description": "Contact type",
"example": "CUSTOMER",
"enum": [
"CUSTOMER",
"PICKUP",
"DELIVERY"
]
},
"notes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Contact notes, if applicable.",
"example": "Located in building A-C1"
}
}
},
"deliveryContact": {
"required": [
"name",
"primaryPhone"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the contact.",
"example": "YK41K"
},
"companyName": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Formal name of the company.",
"example": "Martin LLC"
},
"email": {
"maxLength": 254,
"minLength": 0,
"type": "string",
"description": "Email address.",
"example": "email@email.com"
},
"name": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Name(s) of the person.",
"example": "Martin Fuller"
},
"primaryPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Required primary phone used for contacting.",
"example": "1234567890"
},
"primaryPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the primary phone, if applicable.",
"example": "Do not call me before 8"
},
"secondaryPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Secondary phone used for contacting, if applicable.",
"example": "1234567890"
},
"secondaryPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the secondary phone, if applicable.",
"example": "Do not call me before 8"
},
"thirdPhone": {
"pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$",
"type": "string",
"description": "Third phone used for contacting, if applicable.",
"example": "1234567890"
},
"thirdPhoneNotes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Notes related to the third phone, if applicable.",
"example": "Do not call me before 8"
},
"workingHours": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Official working hours of the company/entity",
"example": "From 5 to 12"
},
"location": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
}
},
"description": "Required location information."
},
"type": {
"type": "string",
"description": "Contact type",
"example": "CUSTOMER",
"enum": [
"CUSTOMER",
"PICKUP",
"DELIVERY"
]
},
"notes": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Contact notes, if applicable.",
"example": "Located in building A-C1"
}
}
},
"publicLinkInfo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the public link info.",
"example": "YK41K"
},
"publicLinkKey": {
"type": "string",
"description": "Key for the public link",
"example": "1231435435"
},
"publicLink": {
"type": "string",
"description": "Full URL for the public link.",
"example": "https://www.public-link.com"
}
},
"description": "Unique public URL used for tracking the load as it is transported from point A to point B."
},
"externalId": {
"type": "string",
"description": "External platform carrier ID",
"example": "123XX"
},
"load": {
"required": [
"useEnclosedTrailer",
"useM22InspectionGuide"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the load",
"example": "YK41K"
},
"dispatchInstructions": {
"type": "string",
"description": "Text instructions concerning the load's dispatch, if applicable.",
"example": "Please, do not come before 6."
},
"useEnclosedTrailer": {
"type": "boolean",
"description": "Required true/false statement identifying the trailer which will carry the load.",
"example": true
},
"useM22InspectionGuide": {
"type": "boolean",
"description": "Required true/false statement identifying which damage inspection method the load is associated with. Any vehicle is inspected upon pick up and delivery either in the standard or the M22 method.",
"example": true
},
"useGpsTracking": {
"type": "boolean",
"description": "true/false statement identifying whether GPS tracking is activated for the load",
"example": true,
"default": false
}
},
"description": "Load details"
},
"carrier": {
"required": [
"primaryPhone"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the contact",
"example": "YK41K"
},
"email": {
"type": "string",
"description": "Email address of the carrier",
"example": "email@email.com"
},
"name": {
"pattern": "(^[0-9a-zA-Z\\s'-.]+$)",
"type": "string",
"example": "Martin Fuller"
},
"primaryPhone": {
"type": "string",
"example": "1234567890"
},
"primaryPhoneNotes": {
"type": "string",
"description": "Notes related to the primary phone, if applicable.",
"example": "Do not call me before 8"
},
"secondaryPhone": {
"type": "string",
"description": "Secondary phone used for contacting, if applicable.",
"example": "1234567890"
},
"secondaryPhoneNotes": {
"type": "string",
"description": "Notes related to the secondary phone, if applicable.",
"example": "Do not call me before 8"
},
"thirdPhone": {
"type": "string",
"description": "Third phone used for contacting, if applicable.",
"example": "1234567890"
},
"thirdPhoneNotes": {
"type": "string",
"description": "Notes related to the third phone, if applicable.",
"example": "Do not call me before 8"
},
"logo": {
"type": "string",
"description": "URL of the carrier company's logo (if not a person)",
"example": "https://www.image.com/logo.jpg"
},
"usDot": {
"type": "integer",
"description": "Unique US DOT number of the carrier.",
"format": "int64",
"example": 1234567
},
"lbExternalId": {
"type": "string",
"description": "ID of the carrier entity as visible on the external platform",
"example": "123X"
},
"location": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
}
},
"description": "Required location information."
},
"userManagementId": {
"type": "string",
"description": "External ID of the carrier as seen in the User Management platform service ",
"example": "123X"
}
},
"description": "Contact information related to the carrier person/company."
},
"contractPricing": {
"type": "object",
"properties": {
"basePrice": {
"type": "number",
"description": "Base price from Contract Pricing",
"example": 70
},
"totalPrice": {
"type": "number",
"description": "Total price from Contract Pricing with surcharges and discounts",
"example": 200.45
},
"lineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the line item - discounts or surcharges",
"example": "SURCHARGE",
"enum": [
"SURCHARGE",
"DISCOUNT"
]
},
"description": {
"type": "string",
"description": "Shows how the item was calculated",
"example": "2$ Per Mile for 900 miles"
},
"title": {
"type": "string",
"example": "Fuel"
},
"price": {
"type": "number",
"description": "Price of each item",
"example": 130.45
}
}
}
},
"distance": {
"type": "number",
"description": "Distance for the calculation in miles",
"example": 2900
},
"pricePerMile": {
"type": "number",
"description": "Price per mile",
"example": 3
}
},
"description": "Shows whether the carrier has contract pricing with all details"
},
"driver": {
"required": [
"lbExternalId",
"phone"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the driver.",
"example": "YK41K"
},
"name": {
"pattern": "(^[0-9a-zA-Z\\s'-.]+$)",
"type": "string",
"description": "Name(s) of the driver.",
"example": "Martin Fuller"
},
"email": {
"type": "string",
"description": "Driver's email.",
"example": "email@email.com"
},
"phone": {
"type": "string",
"description": "Required primary phone used for contacting the driver.",
"example": "1234567890"
},
"additionalPhone": {
"type": "string",
"description": "Optional secondary phone used for contacting the driver.",
"example": "1234567890"
},
"lbExternalId": {
"type": "string",
"description": "ID of the driver as visible on the external platform.",
"example": "123X"
},
"profilePictureUrl": {
"type": "string",
"description": "URL to profile picture of the driver.",
"example": "https://www.image.com/picture.jpg"
},
"userManagementId": {
"type": "string",
"description": "External ID of the driver as seen in the User Management platform service.",
"example": "U-2VK5EDPDNVHGJHTYFSQ7USQYB4"
}
},
"description": "Contact information related to the driver assigned to the load."
},
"carrierOffers": {
"type": "array",
"description": "Information about the offer or offers (making up a negotiation) made by the carrier to the shipper regarding the final costs of transporting the load. Appears only after the load is created and a carrier offer for it was accepted.",
"items": {
"required": [
"expirationDate",
"priceInCents",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the carrierOffer.",
"example": "YK41K"
},
"priceInCents": {
"type": "integer",
"description": "Required total price (in cents) as according to the offer.",
"format": "int64",
"example": 100000
},
"carrierDot": {
"type": "string",
"description": "Unique USDOT number of the carrier.",
"example": "1111111"
},
"negotiationId": {
"type": "string",
"description": "Internal ID of the negotiation that occurred between the carrier and the shipper. Includes the last offer.",
"example": "123X"
},
"status": {
"type": "string",
"description": "Status of the last carrier offer.
\n\nACTIVE - Offer is active.
\nCANCELLED - Offer is canceled.
\nEXPIRED - Offer has been expired.
\nARCHIVED - Offer is archived.
\n",
"example": "active"
},
"externalId": {
"type": "string",
"description": "External ID of the last carrier offer.",
"example": "123X"
},
"companyId": {
"type": "string",
"description": "Internal ID of the carrier company.",
"example": "123X"
},
"expirationDate": {
"type": "string",
"description": "UTC Time of expiry of the negotiation. If the final offer of the negotiation is not. Concluded (accepted or declined) before this date, it will be automatically archived.",
"format": "date-time"
}
},
"description": "Information about the offer or offers (making up a negotiation) made by the carrier to the shipper regarding the final costs of transporting the load. Appears only after the load is created and a carrier offer for it was accepted."
}
},
"pickupSignatureRequired": {
"type": "boolean",
"description": "true/false statement indicating whether signature will be required on pickup.",
"example": false,
"default": true
},
"deliverySignatureRequired": {
"type": "boolean",
"description": "true/false statement indicating whether signature will be required on delivery.",
"example": false,
"default": true
},
"extRateCalculationId": {
"type": "string",
"description": "External ID of the rate engine calculation.",
"example": "YKXS23IJ"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
},
"httpStatus": {
"type": "integer",
"format": "int32"
},
"errorCode": {
"type": "integer",
"format": "int32"
},
"errorMessage": {
"type": "string"
},
"errorDetails": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"deprecated": true,
"security": [
{
"bearerAuth": []
}
]
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```