--- title: "Listing API" url: "https://stage-api-docs.centraldispatch.com/apis/stage-listing-api-2-0-0/versions/6459c118-c2b9-484e-816d-5657457559e4" --- # Listing API OpenAPI specification document. ````json {"openapi":"3.0.1","info":{"title":"Listing API","description":"Central Dispatch's Listing API allows customers to create, retrieve, update, and manage vehicle shipment listings on the marketplace.\n šŸ”‘ Scope: marketplace","contact":{"email":"datasyndicationsupport@centraldispatch.com"},"version":"2.0.0"},"servers":[{"url":"https://marketplace-api.centraldispatch.com","description":"Production server"}],"paths":{"/listings":{"post":{"tags":["Listings"],"summary":"Create Listing","description":"\nCreate a listing.\n\n#### šŸ‘„ Customer Type\n- Shipper \n\n#### šŸ“ Important Notes\n- The listing must have exactly 2 stops (pickup and delivery).\n- At least one vehicle must be specified, a maximum of 12 vehicles allowed per listing, no duplicate vehicle IDs allowed.\n- The response will contain a `Location` header that contains the fully qualified URL of the newly created resource. The final segment of the URL will be the ID of the resource.","operationId":"postListing","parameters":[{"name":"Content-Type","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Content-Type header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"requestBody":{"description":"`ListingRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingRequest"},"examples":{"ex.":{"value":{"shipperOrderId":"123-abc 900","externalId":"RND10 CHEV","trailerType":"OPEN","hasInOpVehicle":false,"loadSpecificTerms":"Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.","availableDate":"2025-02-20T00:00:00Z","expirationDate":"2025-03-10T00:00:00Z","desiredDeliveryDate":"2025-03-04T00:00:00Z","partnerReferenceId":"ORD-2023-0001","price":{"total":500,"cod":{"amount":200,"paymentMethod":"CASH_CERTIFIED_FUNDS","paymentLocation":"PICKUP"},"balance":{"amount":300,"paymentTime":"IMMEDIATELY","balancePaymentTermsBeginOn":"PICKUP","balancePaymentMethod":"CASH"}},"sla":{"duration":"P2D","timeZoneOffset":"-7:00","rolloverTime":"19:00:00","includeCurrentDayAfterRollOver":true},"stops":[{"stopNumber":1,"locationName":"ABC Cars lot","address":"345 W Elm St.","city":"Anaheim","state":"CA","postalCode":"92802","country":"US","phone":"949-555-1323","contactName":"Mickey Smith","contactPhone":"949-555-2434","geoCode":{"longitude":-117.91836265987132,"latitude":33.81228788622535},"locationType":"Dealership"},{"stopNumber":2,"locationName":"XYZ Inc.","address":"255 Sands Ave.","city":"Las Vegas","state":"NV","postalCode":"89169","country":"US","phone":"702-555-0101","contactName":"Dean Vega","contactPhone":"702-555-1212","geoCode":{"longitude":-115.16195281104913,"latitude":36.121343020081525},"locationType":"Dealership"}],"vehicles":[{"pickupStopNumber":1,"dropoffStopNumber":2,"externalVehicleId":"EXT123456","vin":"KL8CH6SA6NC001234","year":2022,"make":"Chevrolet","model":"Spark","trim":"LS","vehicleType":"CAR","color":"Red","licensePlate":"B314PIE","lotNumber":"LOT789","isInoperable":false,"tariff":1030.5,"additionalInfo":"The vehicle is in the back of the lot behind the big tree.","shippingSpecs":{"height":58,"width":62,"length":143,"weight":2246}}],"marketplaces":[{"marketplaceId":10000,"digitalOffersEnabled":true,"searchable":true,"offersAutoAcceptEnabled":true,"autoDispatchOnOfferAccepted":true,"predispatchNotes":"In order to pick up the keys you will have to walk through a lot with a big dog that protects it, he's chained but will bark at you.","customersExcludedFromOffers":["157a16f0-503d-4256-ba60-a4876e8eb9bb"]}],"tags":[{"name":"The number one","value":"1d1d1d1d-e89b-12d3-a456-426614174000"}],"transportationReleaseNotes":"You will need special clearance to get in the lot. Call Jean at 303-999-1212."}},"ex. minimal":{"value":{"availableDate":"2025-02-20T00:00:00Z","price":{"total":500,"cod":{"amount":500,"paymentMethod":"CASH_CERTIFIED_FUNDS","paymentLocation":"PICKUP"}},"stops":[{"stopNumber":1,"city":"Anaheim","state":"CA","postalCode":"92802"},{"stopNumber":2,"city":"Las Vegas","state":"NV","postalCode":"89169"}],"vehicles":[{"pickupStopNumber":1,"dropoffStopNumber":2,"vin":"KL8CH6SA6NC001234"}],"marketplaces":[{"marketplaceId":10000}],"tags":[]}}}}}},"responses":{"201":{"description":"Created. Successful request.","headers":{"Location":{"description":"Contains the fully qualified URL of the newly created or updated resource. The final segment of the URL will equal the ID of the resource.","schema":{"type":"string"},"example":"8675309"}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Data validation errors.\n - Missing required fields.\n - Invalid field formats.\n - Invalid field values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"402":{"description":"Payment Required\n\n**Scenarios:**\n\n - Your vehicle quota has been reached for the current period. Payment required to continue.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"403":{"description":"Forbidden. The attempted action is not permitted."},"415":{"description":"Unsupported Media Type\n\n**Scenarios:**\n\n - `Content-Type` version header is missing or invalid - v2 API requires `Content-Type: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"422":{"description":"Unprocessable Entity. Errors found in the request.\n\n**Scenarios:**\n\n - Vehicle validation: VIN 10-17 chars, Year 1900 to current+10.\n - Location validation: State must be 2 chars.\n - Price validation: 0 to 99,999,999.\n - Date validation: availableDate/expirationDate within 30 days.\n - Must have exactly 2 stops (pickup and delivery).\n - At least 1 vehicle, maximum 12 vehicles.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]},"get":{"tags":["Listings"],"summary":"Get Listings","description":"\nGet a collection of listings based on the specified search criteria.\n\n#### šŸ‘„ Customer Type\n- Shipper \n\n#### šŸ” Allowed Search Criteria\n`partnerReferenceId`: A user supplied ID used for reference.\n\n#### šŸ“ Important Notes\nBe sure to URL encode any parameters that contain spaces or special characters.\n","operationId":"getListingsByRefId","parameters":[{"name":"partnerReferenceId","in":"query","description":"A user supplied ID used for reference.","schema":{"type":"string","nullable":true},"example":"dad00000-e89b-12d3-a456-426614174000"},{"name":"start","in":"query","description":"Determines which record in the collection will be the first one displayed. This value is 1-based, meaning the count starts at 1.","schema":{"type":"integer","format":"int32","default":1},"example":1},{"name":"limit","in":"query","description":"The maximum number of items to be returned in the response.","schema":{"maximum":500,"minimum":0,"type":"integer","format":"int32","default":25},"example":10},{"name":"Accept","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v2; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingCollection"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"406":{"description":"Not Acceptable\n\n**Scenarios:**\n\n - `Accept` version header is missing or invalid - v2 requires: Accept: application/vnd.coxauto.v2+json.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/listings/id/{id}":{"get":{"tags":["Listings"],"summary":"Get Listing","description":"\nGet the listing for the provided listing ID.\n\n#### šŸ‘„ Customer Type\n- Shipper\n\n#### šŸ“ Important Notes\n- The ID of the resource is returned in resource's create endpoint. The response will contain a `Location` header that contains the fully qualified URL of the newly created resource. The final segment of the URL will be the ID of the resource.","operationId":"getListingId","parameters":[{"name":"id","in":"path","description":"The ID of the listing.","required":true,"schema":{"type":"integer","format":"int64"},"example":42220470},{"name":"Accept","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"Etag":{"description":"Contains the current version of the resource and should be used for the `If-Match` header on updates.","schema":{"type":"string"},"example":"8675300"},"Last-Modified":{"description":"Last-Modified","schema":{"type":"string"},"example":"2024-10-15T00:00:00Z"},"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v2; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingResponse"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Listing not found.\n - No listing `id` sent\n - Customer does not have access to this listing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsAlt"}}}},"406":{"description":"Not Acceptable\n\n**Scenarios:**\n\n - `Accept` version header is missing or invalid - v2 API requires: `Accept: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"422":{"description":"Unprocessable Entity. Errors found in the request.\n\n**Scenarios:**\n\n - `id` must not be empty.\n - '`id` must be greater than or equal to `300000000`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]},"put":{"tags":["Listings"],"summary":"Update Listing","description":"\nUpdate a listing.\n\n#### šŸ‘„ Customer Type\n- Shipper \n\n#### šŸ“ Important Notes\n- This operation replaces the entire listing.\n- All Create Listing validation rules apply.\n- The `If-Match` header is required and its value can be found in the `ETag` response header of the resource's GET by ID endpoint.\n\n#### āš ļø Migrating from v1?\nThis endpoint's behavior has changed. In v1, `vehicleId` was optional on update ā€” the system would attempt to match the vehicle using other fields. In v2, `vehicleId` is **required whenever you are updating an existing vehicle**. If you omit it for a vehicle you intended to update, the request will not fail ā€” instead, it will be processed as a new vehicle creation, and it **will count against your vehicle quota**. This is a common integration bug for teams porting v1 code, since the old client code often didn't set this field.\n\nšŸšØ **Action required**: update your integration to store and pass the `vehicleId` returned from your original POST (or from a GET on the listing/vehicle) on every subsequent PUT.","operationId":"putListing","parameters":[{"name":"id","in":"path","description":"The ID of the listing.","required":true,"schema":{"type":"integer","format":"int64"},"example":42220470},{"name":"If-Match","in":"header","description":"This is a required field to ensure the update is being completed on an item that has not changed since it was last read. The value of this field will be the value of the `ETag` header that was received on the preceding get call.","required":true,"schema":{"type":"integer"},"example":8675309},{"name":"Content-Type","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Content-Type header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"requestBody":{"description":"`ListingRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingRequest"},"examples":{"ex.":{"value":{"shipperOrderId":"123-abc 900","externalId":"RND10 CHEV","trailerType":"OPEN","loadSpecificTerms":"Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.","availableDate":"2025-02-20T00:00:00Z","expirationDate":"2025-03-10T00:00:00Z","desiredDeliveryDate":"2025-03-10T00:00:00Z","partnerReferenceId":"ORD-2023-0001","price":{"total":500,"cod":{"amount":200,"paymentMethod":"CASH_CERTIFIED_FUNDS","paymentLocation":"PICKUP"},"balance":{"amount":300,"paymentTime":"IMMEDIATELY","balancePaymentMethod":"CASH","balancePaymentTermsBeginOn":"PICKUP"}},"sla":{"duration":"P2D","timeZoneOffset":"-7:00","rolloverTime":"19:00:00","includeCurrentDayAfterRollOver":true},"stops":[{"stopId":"4e2efc84-6add-435c-9f12-8b19e3e5ba21","stopNumber":1,"locationName":"ABC Cars lot","address":"345 W Elm St.","city":"Anaheim","state":"CA","postalCode":"92802","country":"US","phone":"949-555-1323","contactName":"Mickey Smith","contactPhone":"949-555-2434","geoCode":{"longitude":-117.91836265987132,"latitude":33.81228788622535},"locationType":"Dealership"},{"stopId":"9b6e0fad-8722-4da1-907c-f9522c04ef12","stopNumber":2,"locationName":"XYZ Inc.","address":"255 Sands Ave.","city":"Las Vegas","state":"NV","postalCode":"89169","country":"US","phone":"702-555-0101","contactName":"Dean Vega","contactPhone":"702-555-1212","geoCode":{"longitude":-115.16195281104913,"latitude":36.121343020081525},"locationType":"Dealership"}],"vehicles":[{"pickupStopNumber":1,"dropoffStopNumber":2,"vehicleId":"b331c130-e89b-12d3-a456-426614174000","externalVehicleId":"EXT123456","vin":"KL8CH6SA6NC001234","year":2022,"make":"Chevrolet","model":"Spark","trim":"LS","vehicleType":"CAR","color":"Red","licensePlate":"B314PIE","lotNumber":"LOT789","isInoperable":false,"tariff":1030.5,"additionalInfo":"The vehicle is in the back of the lot behind the big tree.","shippingSpecs":{"height":58,"width":62,"length":143,"weight":2246}}],"marketplaces":[{"priorityId":1,"marketplaceId":10000,"digitalOffersEnabled":true,"searchable":true,"offersAutoAcceptEnabled":true,"autoDispatchOnOfferAccepted":true,"predispatchNotes":"In order to pick up the keys you will have to walk through a lot with a big dog that protects it, he's chained but will bark at you.","customersExcludedFromOffers":["157a16f0-503d-4256-ba60-a4876e8eb9bb"]}],"tags":[{"name":"The number one","value":"1d1d1d1d-e89b-12d3-a456-426614174000"}],"transportationReleaseNotes":"You will need special clearance to get in the lot. Call Jean at 303-999-1212."}}}}}},"responses":{"204":{"description":"No Content. Successful request."},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Data validation errors.\n - Missing required fields.\n - Invalid field formats.\n - Invalid field values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"402":{"description":"Payment Required\n\n**Scenarios:**\n\n - Your vehicle quota has been reached for the current period. Payment required to continue.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Listing not found.\n - Customer does not own this listing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"409":{"description":"Conflict. Update not allowed based on the current resource state.\n\n**Scenarios:**\n\n - ETag mismatch: Listing was modified by another request since retrieval.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"415":{"description":"Unsupported Media Type\n\n**Scenarios:**\n\n - `Content-Type` version header is missing or invalid - v2 API requires `Content-Type: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"422":{"description":"Unprocessable Entity. Errors found in the request.\n\n**Scenarios:**\n\n - Listing is out of date - `ETag` header value does not match current version.\n - Required fields missing.\n - `id` must not be empty.\n - `id` must be greater than or equal to `300000000`.\n - Vehicle validation: VIN 10-17 chars, Year 1900 to current+10.\n - Location validation: State must be 2 chars.\n - Price validation: 0 to 99,999,999.\n - Date validation: `availableDate`/`expirationDate` within 30 days.\n - Must have exactly 2 stops (pickup and delivery).\n - At least 1 vehicle, maximum 12 vehicles.\n - Business validation failures.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]},"delete":{"tags":["Listings"],"summary":"Delete Listing","description":"\nDelete a listing.\n\n#### šŸ‘„ Customer Type\n- Shipper","operationId":"deleteListing","parameters":[{"name":"id","in":"path","description":"The ID of the listing.","required":true,"schema":{"type":"integer","format":"int64"},"example":42220470},{"name":"Accept","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"responses":{"204":{"description":"No Content. Successful request."},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Listing not found.\n - Listing already deleted.\n - Customer does not own the listing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"406":{"description":"Not Acceptable\n\n**Scenarios:**\n\n - `Accept` version header is missing or invalid - v2 API requires: `Accept: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"422":{"description":"Unprocessable Entity. Errors found in the request.\n\n**Scenarios:**\n\n - `id` must not be empty.\n - '`id` must be greater than or equal to `300000000`.\n - Business rule violations preventing deletion.\n - Listing in invalid state for deletion (e.g., has active negotiations).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/listings/batch":{"post":{"tags":["Listings"],"summary":"Get Listings (Batch)","description":"\nGet a collection of listings for the provided listing IDs or URLs.\n\n#### šŸ‘„ Customer Type\n- Shipper","operationId":"getListingsBatch","parameters":[{"name":"Content-Type","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Content-Type header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"requestBody":{"description":"An array of listing IDs and/or listing URLs.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"examples":{"ex. with IDs":{"value":["42220470","300040271"]},"ex. with URLs":{"value":["https://marketplace-api.centraldispatch.com/listings/id/d159acc0-e89b-12d3-a456-426614174000","https://marketplace-api.centraldispatch.com/listings/id/2539f4b4-d3d6-45db-8df3-7ba768caba9b"]}}}},"required":true},"responses":{"200":{"description":"OK. Successful request.","headers":{"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v2; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingCollection"}}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Invalid request body.\n - Empty or null listing IDs array.\n - Invalid listing ID format in array.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"406":{"description":"Not Acceptable\n\n**Scenarios:**\n\n - `Accept` version header is missing or invalid - v2 API requires: `Accept: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/listings/mine":{"get":{"tags":["Listings"],"summary":"Get My Listings","description":"\nGet a collection of listings that belong to the calling customer.\n\n#### šŸ‘„ Customer Type\n- Shipper \n\n#### šŸ” Allowed Search Criteria\n`partnerReferenceId`: A user supplied ID used for reference.\n`externalId`: An identifier managed by the user. Shippers can use this field to map a record (e.g. order, shipment, dispatch) in their local TMS to a Central Dispatch record. This value is displayed as the load number on the Central Dispatch website.\n`shipperOrderId`: The ID of the shipper order.\n\n#### šŸ“ Important Notes\nBe sure to URL encode any parameters that contain spaces or special characters.\nResults will be paginated. Navigate through the results using the `next` value.\n\n#### Example\n```bash\ncurl -X GET https://api.centraldispatch.com/listings/mine?limit(1,10)%partnerReferenceId=12345\n```\n","operationId":"getListingsMine","parameters":[{"name":"limit(1,2)","in":"query","description":"The maximum number of items to be returned in the response.\n - 1 = The record number to start with, 1-based integer, default 1.\n - 2 = number of results to return, integer, default 25, maximum 500.","schema":{"type":"string"},"example":"limit(1,10)"},{"name":"partnerReferenceId","in":"query","description":"A user supplied ID used for reference.","schema":{"maxLength":50,"type":"string"},"example":"25-KL8CH6"},{"name":"externalId","in":"query","description":"An identifier managed by the user. Shippers can use this field to map a record (e.g. order, shipment, dispatch) in their local TMS to a Central Dispatch record. This value is displayed as the load number on the Central Dispatch website.","schema":{"maxLength":50,"type":"string"},"example":"RND10 CHEV"},{"name":"shipperOrderId","in":"query","description":"The ID of the shipper order.","schema":{"maxLength":50,"type":"string"},"example":"123-abc 900"},{"name":"Accept","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v2; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingCollection"}}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Missing or malformed customer ID in token.\n - Invalid limit values (must be positive, within max range).\n - Invalid parameter or validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"406":{"description":"Not Acceptable\n\n**Scenarios:**\n\n - `Accept` version header is missing or invalid - v2 API requires: `Accept: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}},"/draft-listings":{"post":{"tags":["Draft-Listings"],"summary":"Create Draft Listing","description":"\nCreate a draft listing.\n\n#### šŸ‘„ Customer Type\n- Shipper\n\n#### šŸ“ Important Notes\n- A draft is private work-in-progress. It is not published to the marketplace, is not searchable by carriers, and cannot receive offers or be dispatched until it is published.\n- Every field except one is optional, so a partially complete vehicle shipment can be stored and finished later. At least one user-entered field must be supplied.\n- Only stored values are validated. The full set of listing rules is enforced when the draft is published, so a draft that saves successfully can still be rejected at publish time.\n- The draft's `listingStatus` is always `DRAFT`.\n- The response will contain a `Location` header that contains the fully qualified URL of the newly created resource. The final segment of the URL will be the ID of the resource.\n- The response will include an `ETag` header, which should be used for the `If-Match` header in subsequent updates.","operationId":"postDraftListing","parameters":[{"name":"Content-Type","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Content-Type header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"requestBody":{"description":"`DraftListingRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftListingRequest"},"examples":{"ex. partial draft":{"value":{"shipperOrderId":"123-abc 900","availableDate":"2025-02-20T00:00:00Z","vehicles":[{"vin":"KL8CH6SA6NC001234","year":2022,"make":"Chevrolet","model":"Spark"}]}},"ex. complete draft":{"value":{"shipperOrderId":"123-abc 900","externalId":"RND10 CHEV","trailerType":"OPEN","hasInOpVehicle":false,"loadSpecificTerms":"Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.","availableDate":"2025-02-20T00:00:00Z","expirationDate":"2025-03-10T00:00:00Z","desiredDeliveryDate":"2025-03-04T00:00:00Z","partnerReferenceId":"ORD-2023-0001","price":{"total":500,"cod":{"amount":200,"paymentMethod":"CASH_CERTIFIED_FUNDS","paymentLocation":"PICKUP"},"balance":{"amount":300,"paymentTime":"IMMEDIATELY","balancePaymentTermsBeginOn":"PICKUP","balancePaymentMethod":"CASH"}},"sla":{"duration":"P2D","timeZoneOffset":"-7:00","rolloverTime":"19:00:00","includeCurrentDayAfterRollOver":true},"stops":[{"stopNumber":1,"locationName":"ABC Cars lot","address":"345 W Elm St.","city":"Anaheim","state":"CA","postalCode":"92802","country":"US","contactName":"Mickey Smith","contactPhone":"949-555-2434","geoCode":{"longitude":-117.91836265987132,"latitude":33.81228788622535},"locationType":"Dealership"},{"stopNumber":2,"locationName":"XYZ Inc.","address":"255 Sands Ave.","city":"Las Vegas","state":"NV","postalCode":"89169","country":"US","contactName":"Dean Vega","contactPhone":"702-555-1212","geoCode":{"longitude":-115.16195281104913,"latitude":36.121343020081525},"locationType":"Dealership"}],"vehicles":[{"pickupStopNumber":1,"dropoffStopNumber":2,"externalVehicleId":"EXT123456","vin":"KL8CH6SA6NC001234","year":2022,"make":"Chevrolet","model":"Spark","trim":"LS","vehicleType":"CAR","color":"Red","isInoperable":false,"tariff":1030.5}],"marketplaces":[{"marketplaceId":10000,"searchable":true,"makeOffersEnabled":true}]}}}}}},"responses":{"201":{"description":"Created. Successful request.","headers":{"Location":{"description":"Contains the fully qualified URL of the newly created or updated resource. The final segment of the URL will equal the ID of the resource.","schema":{"type":"string"},"example":"8675309"},"Etag":{"description":"Contains the current version of the resource and should be used for the `If-Match` header on updates.","schema":{"type":"string"},"example":"8675300"}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Missing or malformed customer ID in the access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"415":{"description":"Unsupported Media Type\n\n**Scenarios:**\n\n - `Content-Type` version header is missing or invalid - v2 API requires `Content-Type: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"422":{"description":"Unprocessable Entity. Errors found in the request.\n\n**Scenarios:**\n\n - The draft contains no user-entered field.\n - A supplied field failed validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable\n\n**Scenarios:**\n\n - The listing service is unavailable or did not respond in time. The request can be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}}},"security":[{"Bearer":[]}]}},"/draft-listings/id/{id}":{"get":{"tags":["Draft-Listings"],"summary":"Get Draft Listing","description":"\nGet the draft listing for the provided draft listing ID.\n\n#### šŸ‘„ Customer Type\n- Shipper\n\n#### šŸ“ Important Notes\n- Only your own drafts can be retrieved. A draft belonging to another customer is reported as not found.\n- The response will include an `ETag` header, which should be used for the `If-Match` header in subsequent updates.\n- The ID of the resource is returned in resource's create endpoint. The response will contain a `Location` header that contains the fully qualified URL of the newly created resource. The final segment of the URL will be the ID of the resource.","operationId":"getDraftListingId","parameters":[{"name":"id","in":"path","description":"The ID of the listing.","required":true,"schema":{"type":"integer","format":"int64"},"example":42220470},{"name":"Accept","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"Etag":{"description":"Contains the current version of the resource and should be used for the `If-Match` header on updates.","schema":{"type":"string"},"example":"8675300"},"Last-Modified":{"description":"Last-Modified","schema":{"type":"string"},"example":"2024-10-15T00:00:00Z"},"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v2; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftListingResponse"}}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Missing or malformed customer ID in the access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Draft listing not found.\n - The draft listing belongs to another customer.\n - The draft listing has already been published.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"406":{"description":"Not Acceptable\n\n**Scenarios:**\n\n - `Accept` version header is missing or invalid - v2 API requires: `Accept: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable\n\n**Scenarios:**\n\n - The listing service is unavailable or did not respond in time. The request can be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}}},"security":[{"Bearer":[]}]},"put":{"tags":["Draft-Listings"],"summary":"Update Draft Listing","description":"\nUpdate a draft listing.\n\n#### šŸ‘„ Customer Type\n- Shipper\n\n#### šŸ“ Important Notes\n- This operation replaces the entire draft. Any field omitted from the request is cleared, so send the whole draft on every update.\n- The draft remains a draft. Updating it does not publish it to the marketplace.\n- The `If-Match` header is required and its value can be found in the `ETag` response header of the resource's GET by ID endpoint.\n- A stale `If-Match` value is rejected with `422`, and the stored draft is left unchanged. Re-read the draft to obtain the current `ETag` before retrying.","operationId":"putDraftListing","parameters":[{"name":"id","in":"path","description":"The ID of the listing.","required":true,"schema":{"type":"integer","format":"int64"},"example":42220470},{"name":"If-Match","in":"header","description":"This is a required field to ensure the update is being completed on an item that has not changed since it was last read. The value of this field will be the value of the `ETag` header that was received on the preceding get call.","required":true,"schema":{"type":"integer"},"example":8675309},{"name":"Content-Type","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Content-Type header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"requestBody":{"description":"`DraftListingRequest`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftListingRequest"},"examples":{"ex. partial draft":{"value":{"shipperOrderId":"123-abc 900","availableDate":"2025-02-20T00:00:00Z","vehicles":[{"vin":"KL8CH6SA6NC001234","year":2022,"make":"Chevrolet","model":"Spark"}]}},"ex. complete draft":{"value":{"shipperOrderId":"123-abc 900","externalId":"RND10 CHEV","trailerType":"OPEN","hasInOpVehicle":false,"loadSpecificTerms":"Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.","availableDate":"2025-02-20T00:00:00Z","expirationDate":"2025-03-10T00:00:00Z","desiredDeliveryDate":"2025-03-04T00:00:00Z","partnerReferenceId":"ORD-2023-0001","price":{"total":500,"cod":{"amount":200,"paymentMethod":"CASH_CERTIFIED_FUNDS","paymentLocation":"PICKUP"},"balance":{"amount":300,"paymentTime":"IMMEDIATELY","balancePaymentTermsBeginOn":"PICKUP","balancePaymentMethod":"CASH"}},"sla":{"duration":"P2D","timeZoneOffset":"-7:00","rolloverTime":"19:00:00","includeCurrentDayAfterRollOver":true},"stops":[{"stopNumber":1,"locationName":"ABC Cars lot","address":"345 W Elm St.","city":"Anaheim","state":"CA","postalCode":"92802","country":"US","contactName":"Mickey Smith","contactPhone":"949-555-2434","geoCode":{"longitude":-117.91836265987132,"latitude":33.81228788622535},"locationType":"Dealership"},{"stopNumber":2,"locationName":"XYZ Inc.","address":"255 Sands Ave.","city":"Las Vegas","state":"NV","postalCode":"89169","country":"US","contactName":"Dean Vega","contactPhone":"702-555-1212","geoCode":{"longitude":-115.16195281104913,"latitude":36.121343020081525},"locationType":"Dealership"}],"vehicles":[{"pickupStopNumber":1,"dropoffStopNumber":2,"externalVehicleId":"EXT123456","vin":"KL8CH6SA6NC001234","year":2022,"make":"Chevrolet","model":"Spark","trim":"LS","vehicleType":"CAR","color":"Red","isInoperable":false,"tariff":1030.5}],"marketplaces":[{"marketplaceId":10000,"searchable":true,"makeOffersEnabled":true}]}}}}}},"responses":{"204":{"description":"No Content. Successful request.","headers":{"Etag":{"description":"Contains the current version of the resource and should be used for the `If-Match` header on updates.","schema":{"type":"string"},"example":"8675300"}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Missing or malformed customer ID in the access token.\n - The `If-Match` header is missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Draft listing not found.\n - The draft listing belongs to another customer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"415":{"description":"Unsupported Media Type\n\n**Scenarios:**\n\n - `Content-Type` version header is missing or invalid - v2 API requires `Content-Type: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"422":{"description":"Unprocessable Entity. Errors found in the request.\n\n**Scenarios:**\n\n - The draft listing is out of date - the `If-Match` header value does not match the current version.\n - The draft contains no user-entered field.\n - A supplied field failed validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable\n\n**Scenarios:**\n\n - The listing service is unavailable or did not respond in time. The request can be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Draft-Listings"],"summary":"Delete Draft Listing","description":"\nDelete a draft listing.\n\n#### šŸ‘„ Customer Type\n- Shipper\n\n#### šŸ“ Important Notes\n- The draft is removed permanently and cannot be recovered.\n- Only your own drafts can be deleted. A draft belonging to another customer is reported as not found and is left untouched.\n- Deleting a draft has no effect on any listing already published from it.","operationId":"deleteDraftListing","parameters":[{"name":"id","in":"path","description":"The ID of the listing.","required":true,"schema":{"type":"integer","format":"int64"},"example":42220470},{"name":"Accept","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"responses":{"204":{"description":"No Content. Successful request."},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Missing or malformed customer ID in the access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Draft listing not found.\n - The draft listing was already deleted.\n - The draft listing belongs to another customer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"406":{"description":"Not Acceptable\n\n**Scenarios:**\n\n - `Accept` version header is missing or invalid - v2 API requires: `Accept: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable\n\n**Scenarios:**\n\n - The listing service is unavailable or did not respond in time. The request can be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}}},"security":[{"Bearer":[]}]}},"/listings/ref/draft-listings/id/{draftListingId}":{"post":{"tags":["Draft-Listings"],"summary":"Publish Draft Listing","description":"\nPublish a draft listing, turning it into an active listing on the marketplace.\n\n#### šŸ‘„ Customer Type\n- Shipper\n\n#### šŸ“ Important Notes\n- The created resource is a listing, not a draft. It is returned in the response body and its URL is in the `Location` header.\n- The new listing keeps the draft's ID, and the draft is consumed - a second publish of the same ID is reported as not found.\n- Publishing enforces the complete set of Create Listing rules, so a draft that saved successfully can still be rejected here with `422`. Correct the draft with Update Draft Listing and publish again.\n- The `If-Match` header is required and its value can be found in the `ETag` response header of the resource's GET by ID endpoint.\n- A stale `If-Match` value is rejected with `422`, and the draft is left intact and unpublished.","operationId":"postPublishDraftListing","parameters":[{"name":"draftListingId","in":"path","description":"The ID of the listing.","required":true,"schema":{"type":"integer","format":"int64"},"example":42220470},{"name":"If-Match","in":"header","description":"This is a required field to ensure the update is being completed on an item that has not changed since it was last read. The value of this field will be the value of the `ETag` header that was received on the preceding get call.","required":true,"schema":{"type":"integer"},"example":8675309},{"name":"Content-Type","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Content-Type header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"responses":{"201":{"description":"Created. Successful request.","headers":{"Location":{"description":"Contains the fully qualified URL of the newly created or updated resource. The final segment of the URL will equal the ID of the resource.","schema":{"type":"string"},"example":"8675309"},"Etag":{"description":"Contains the current version of the resource and should be used for the `If-Match` header on updates.","schema":{"type":"string"},"example":"8675300"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingResponse"}}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - The `If-Match` header is missing.\n - Missing or malformed customer ID in the access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.\n\n**Scenarios:**\n\n - Draft listing not found.\n - The draft listing belongs to another customer.\n - The draft listing has already been published.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"406":{"description":"Not Acceptable\n\n**Scenarios:**\n\n - `Accept` version header is missing or invalid - v2 API requires: `Accept: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"409":{"description":"Conflict. Update not allowed based on the current resource state.\n\n**Scenarios:**\n\n - The listing could not be created because of a conflict, such as a vehicle quota conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"415":{"description":"Unsupported Media Type\n\n**Scenarios:**\n\n - `Content-Type` version header is missing or invalid - v2 API requires `Content-Type: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"422":{"description":"Unprocessable Entity. Errors found in the request.\n\n**Scenarios:**\n\n - The draft listing is out of date - the `If-Match` header value does not match the current version.\n - The draft is incomplete or invalid as a listing. All Create Listing validation rules apply.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable\n\n**Scenarios:**\n\n - The listing service is unavailable or did not respond in time. The draft may or may not have been published, so re-read it before retrying.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}}},"security":[{"Bearer":[]}]}},"/draft-listings/mine":{"get":{"tags":["Draft-Listings"],"summary":"Get My Draft Listings","description":"\nGet a collection of draft listings that belong to the calling customer, newest first.\n\n#### šŸ‘„ Customer Type\n- Shipper\n\n#### šŸ“ Important Notes\n- Results will be paginated. Navigate through the results using the `next` value.\n- `count` is the total number of drafts you own, not the size of the current page, so `next` is present exactly when more drafts remain.\n- Drafts cannot be filtered by field. A draft stores whatever the shipper has entered so far, so any search criterion would silently hide incomplete work. Unsupported query parameters are rejected with `400` rather than ignored. To retrieve specific drafts by ID, use Get Draft Listings (Batch).\n- Be sure to URL encode any parameters that contain spaces or special characters.\n","operationId":"getDraftListingsMine","parameters":[{"name":"limit(1,2)","in":"query","description":"The maximum number of items to be returned in the response.\n - 1 = The record number to start with, 1-based integer, default 1.\n - 2 = number of results to return, integer, default 25, maximum 500.","schema":{"type":"string"},"example":"limit(1,10)"},{"name":"Accept","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v2; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftListingPaginatedCollection"}}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Missing or malformed customer ID in the access token.\n - An unsupported query parameter was supplied - draft listings cannot be filtered by field.\n - Invalid `limit` values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"406":{"description":"Not Acceptable\n\n**Scenarios:**\n\n - `Accept` version header is missing or invalid - v2 API requires: `Accept: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable\n\n**Scenarios:**\n\n - The listing service is unavailable or did not respond in time. The request can be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}}},"security":[{"Bearer":[]}]}},"/draft-listings/batch":{"post":{"tags":["Draft-Listings"],"summary":"Get Draft Listings (Batch)","description":"\nGet a collection of draft listings for the provided draft listing IDs or URLs.\n\n#### šŸ‘„ Customer Type\n- Shipper\n\n#### šŸ“ Important Notes\n- Each entry may be either a bare numeric draft listing ID or the full URL of a draft listing.\n- A maximum of 50 IDs may be requested at once.\n- Only your own drafts are returned. An ID that does not exist, has been published, or belongs to another customer is omitted from the response rather than reported as an error, so the response may contain fewer items than IDs requested.\n- The response is not paginated - `count` is the number of items returned.","operationId":"getDraftListingsBatch","parameters":[{"name":"Content-Type","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Content-Type header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"requestBody":{"description":"An array of draft listing IDs and/or draft listing URLs.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"examples":{"ex. with IDs":{"value":["42220470","43000470"]},"ex. with URLs":{"value":["https://marketplace-api.centraldispatch.com/draft-listings/id/42220470","https://marketplace-api.centraldispatch.com/draft-listings/id/43000470"]}}}},"required":true},"responses":{"200":{"description":"OK. Successful request.","headers":{"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v2; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftListingCollection"}}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - More than 50 draft listing IDs were requested.\n - Missing or malformed customer ID in the access token.\n - Invalid request body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"406":{"description":"Not Acceptable\n\n**Scenarios:**\n\n - `Accept` version header is missing or invalid - v2 API requires: `Accept: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"415":{"description":"Unsupported Media Type\n\n**Scenarios:**\n\n - `Content-Type` version header is missing or invalid - v2 API requires `Content-Type: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable\n\n**Scenarios:**\n\n - The listing service is unavailable or did not respond in time. The request can be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsWithProperties"}}}}},"security":[{"Bearer":[]}]}},"/listing-vehicles/mine":{"get":{"tags":["Listing-Vehicles"],"summary":"Get My Vehicles","description":"\nGet the vehicles in listings that belong to the calling customer.\n\n#### šŸ‘„ Customer Type\n- Shipper \n\n#### šŸ” Allowed Search Criteria\n`externalVehicleId`: A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record.\n`listingId`: The ID of the listing.\n\n#### šŸ“ Important Notes\nBe sure to URL encode any parameters that contain spaces or special characters.\nResults will be paginated. Navigate through the results using the `next` value.\n\n#### Example\n```bash\ncurl -X GET https://api.centraldispatch.com/listing-vehicles/mine?limit(1,10)%listingId=400000000\n```\n","operationId":"getMyVehicles","parameters":[{"name":"externalVehicleId","in":"query","description":"A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record.","schema":{"type":"string"},"example":"EXT123456"},{"name":"listingId","in":"query","description":"The ID of the listing.","schema":{"type":"string"},"example":"42220470"},{"name":"Accept","in":"header","description":"The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 2.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v2+json`.","required":true,"schema":{"type":"string"},"example":"application/vnd.coxauto.v2+json"}],"responses":{"200":{"description":"OK. Successful request.","headers":{"Etag":{"description":"Contains the current version of the resource and should be used for the `If-Match` header on updates.","schema":{"type":"string"},"example":"8675300"},"X-CoxAuto-Media-Type":{"description":"Contains the major version and format information.","schema":{"type":"string"},"example":"coxauto.v2; format=json"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCollection"}}}},"400":{"description":"Bad Request. Check the request payload.\n\n**Scenarios:**\n\n - Missing or malformed customer ID in token.\n - Invalid limit values (must be positive, within max range).\n - Invalid parameter or validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"401":{"description":"Unauthorized. Authentication failed or missing."},"403":{"description":"Forbidden. The attempted action is not permitted."},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"406":{"description":"Not Acceptable\n\n**Scenarios:**\n\n - `Accept` version header is missing or invalid - v2 API requires: `Accept: application/vnd.coxauto.v2+json`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"422":{"description":"Unprocessable Entity. Errors found in the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"429":{"description":"Too Many Requests. Rate limit exceeded."},"500":{"description":"Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"503":{"description":"Service Unavailable. Temporary service interruption."}},"security":[{"Bearer":[]}]}}},"components":{"schemas":{"BalanceRequest":{"type":"object","properties":{"amount":{"minimum":0,"type":"number","description":"The balance amount that will be due after the COD/COP payment is applied.","format":"double","default":0,"example":300},"amountCurrency":{"$ref":"#/components/schemas/Currency"},"paymentTime":{"enum":["FIFTEEN_BUSINESS_DAYS","FIVE_BUSINESS_DAYS","IMMEDIATELY","TEN_BUSINESS_DAYS","THIRTY_BUSINESS_DAYS","TWO_BUSINESS_DAYS"],"type":"string","description":"The time frame when the balance payment is due. This list is not exhaustive and additional values may be added at any time.","default":"IMMEDIATELY","nullable":true,"example":"IMMEDIATELY"},"balancePaymentTermsBeginOn":{"enum":["DELIVERY","PICKUP","RECEIVING_SIGNED_BOL"],"type":"string","description":"The terms for beginning balance payment. This list is not exhaustive and additional values may be added at any time.","default":"PICKUP","nullable":true,"example":"PICKUP"},"balancePaymentMethod":{"enum":["CASH","CERTIFIED_FUNDS","COMCHEK","COMPANY_CHECK","TCH"],"type":"string","description":"The payment method with which the balance due payment will be paid. This list is not exhaustive and additional values may be added at any time.","default":"CASH","nullable":true,"example":"CASH"}},"description":"Details of the balance.","nullable":true},"BalanceResponse":{"type":"object","properties":{"amount":{"type":"number","description":"The balance amount that will be due after the COD/COP payment is applied.","format":"double","example":300},"amountCurrency":{"$ref":"#/components/schemas/Currency"},"paymentTime":{"enum":["FIFTEEN_BUSINESS_DAYS","FIVE_BUSINESS_DAYS","IMMEDIATELY","TEN_BUSINESS_DAYS","THIRTY_BUSINESS_DAYS","TWO_BUSINESS_DAYS"],"type":"string","description":"The time frame when the balance payment is due. This list is not exhaustive and additional values may be added at any time.","example":"IMMEDIATELY"},"balancePaymentTermsBeginOn":{"enum":["DELIVERY","PICKUP","RECEIVING_SIGNED_BOL"],"type":"string","description":"The terms for beginning balance payment. This list is not exhaustive and additional values may be added at any time.","example":"PICKUP"},"balancePaymentMethod":{"enum":["CASH","CERTIFIED_FUNDS","COMCHEK","COMPANY_CHECK","TCH"],"type":"string","description":"The payment method with which the balance due payment will be paid. This list is not exhaustive and additional values may be added at any time.","example":"CASH"}},"description":"Details of the balance."},"CodRequest":{"type":"object","properties":{"amount":{"minimum":0,"type":"number","description":"The cash on delivery (COD) or cash on pick up (COP) amount due.","format":"double","default":0,"example":200},"amountCurrency":{"$ref":"#/components/schemas/Currency"},"paymentMethod":{"enum":["CASH_CERTIFIED_FUNDS","CHECK"],"type":"string","description":"The method for the COD/COP payment. This list is not exhaustive and additional values may be added at any time.","default":"CASH_CERTIFIED_FUNDS","nullable":true,"example":"CASH_CERTIFIED_FUNDS"},"paymentLocation":{"enum":["DELIVERY","PICKUP"],"type":"string","description":"The location that COD/COP payment is due. This list is not exhaustive and additional values may be added at any time.","default":"PICKUP","nullable":true,"example":"PICKUP"}},"description":"Details of the cash on delivery or cash on pick-up (COD/COP).","nullable":true},"CodResponse":{"type":"object","properties":{"amount":{"type":"number","description":"The cash on delivery (COD) or cash on pick up (COP) amount due.","format":"double","example":200},"amountCurrency":{"$ref":"#/components/schemas/Currency"},"paymentMethod":{"enum":["CASH_CERTIFIED_FUNDS","CHECK"],"type":"string","description":"The method for the COD/COP payment. This list is not exhaustive and additional values may be added at any time.","example":"CASH_CERTIFIED_FUNDS"},"paymentLocation":{"enum":["DELIVERY","PICKUP"],"type":"string","description":"The location that COD/COP payment is due. This list is not exhaustive and additional values may be added at any time.","example":"PICKUP"}},"description":"Details of cash on delivery or cash on pick up (COD/COP)."},"Currency":{"enum":["USD"],"type":"string","description":"The currency of the monetary field. This list is not exhaustive and additional values may be added at any time.","default":"USD","example":"USD"},"DraftBalanceRequest":{"type":"object","properties":{"amount":{"minimum":0,"type":"number","description":"The balance amount that will be due after the COD/COP payment is applied.","format":"double","default":0,"nullable":true,"example":300},"amountCurrency":{"$ref":"#/components/schemas/Currency"},"paymentTime":{"enum":["FIFTEEN_BUSINESS_DAYS","FIVE_BUSINESS_DAYS","IMMEDIATELY","TEN_BUSINESS_DAYS","THIRTY_BUSINESS_DAYS","TWO_BUSINESS_DAYS"],"type":"string","description":"The time frame when the balance payment is due. This list is not exhaustive and additional values may be added at any time.","default":"IMMEDIATELY","nullable":true,"example":"IMMEDIATELY"},"balancePaymentTermsBeginOn":{"enum":["DELIVERY","PICKUP","RECEIVING_SIGNED_BOL"],"type":"string","description":"The terms for beginning balance payment. This list is not exhaustive and additional values may be added at any time.","default":"PICKUP","nullable":true,"example":"PICKUP"},"balancePaymentMethod":{"enum":["CASH","CERTIFIED_FUNDS","COMCHEK","COMPANY_CHECK","TCH"],"type":"string","description":"The payment method with which the balance due payment will be paid. This list is not exhaustive and additional values may be added at any time.","default":"CASH","nullable":true,"example":"CASH"}},"description":"Details of the balance portion of a draft listing price.","nullable":true},"DraftBalanceResponse":{"type":"object","properties":{"amount":{"type":"number","description":"The balance amount that will be due after the COD/COP payment is applied.","format":"double","example":300},"amountCurrency":{"$ref":"#/components/schemas/Currency"},"paymentTime":{"enum":["FIFTEEN_BUSINESS_DAYS","FIVE_BUSINESS_DAYS","IMMEDIATELY","TEN_BUSINESS_DAYS","THIRTY_BUSINESS_DAYS","TWO_BUSINESS_DAYS"],"type":"string","description":"The time frame when the balance payment is due. This list is not exhaustive and additional values may be added at any time.","example":"IMMEDIATELY"},"balancePaymentTermsBeginOn":{"enum":["DELIVERY","PICKUP","RECEIVING_SIGNED_BOL"],"type":"string","description":"The terms for beginning balance payment. This list is not exhaustive and additional values may be added at any time.","example":"PICKUP"},"balancePaymentMethod":{"enum":["CASH","CERTIFIED_FUNDS","COMCHEK","COMPANY_CHECK","TCH"],"type":"string","description":"The payment method with which the balance due payment will be paid. This list is not exhaustive and additional values may be added at any time.","example":"CASH"}},"description":"Details of the balance portion of a draft listing price."},"DraftCodRequest":{"type":"object","properties":{"amount":{"minimum":0,"type":"number","description":"The cash on delivery (COD) or cash on pick up (COP) amount due.","format":"double","default":0,"nullable":true,"example":200},"amountCurrency":{"$ref":"#/components/schemas/Currency"},"paymentMethod":{"enum":["CASH_CERTIFIED_FUNDS","CHECK"],"type":"string","description":"The method for the COD/COP payment. This list is not exhaustive and additional values may be added at any time.","default":"CASH_CERTIFIED_FUNDS","nullable":true,"example":"CASH_CERTIFIED_FUNDS"},"paymentLocation":{"enum":["DELIVERY","PICKUP"],"type":"string","description":"The location that COD/COP payment is due. This list is not exhaustive and additional values may be added at any time.","default":"PICKUP","nullable":true,"example":"PICKUP"}},"description":"Details of the cash on delivery portion of a draft listing price.","nullable":true},"DraftCodResponse":{"type":"object","properties":{"amount":{"type":"number","description":"The cash on delivery (COD) or cash on pick up (COP) amount due.","format":"double","example":200},"amountCurrency":{"$ref":"#/components/schemas/Currency"},"paymentMethod":{"enum":["CASH_CERTIFIED_FUNDS","CHECK"],"type":"string","description":"The method for the COD/COP payment. This list is not exhaustive and additional values may be added at any time.","example":"CASH_CERTIFIED_FUNDS"},"paymentLocation":{"enum":["DELIVERY","PICKUP"],"type":"string","description":"The location that COD/COP payment is due. This list is not exhaustive and additional values may be added at any time.","example":"PICKUP"}},"description":"Details of the cash on delivery portion of a draft listing price."},"DraftGeoCodeRequest":{"type":"object","properties":{"longitude":{"type":"number","description":"The longitude of the location.","format":"double","nullable":true,"example":-117.91836265987132},"latitude":{"type":"number","description":"The latitude of the location.","format":"double","nullable":true,"example":33.81228788622535}},"description":"Details of the geographic coordinates of a stop on a draft listing.","nullable":true},"DraftGeoCodeResponse":{"type":"object","properties":{"longitude":{"type":"number","description":"The longitude of the location.","format":"double","nullable":true,"example":-117.91836265987132},"latitude":{"type":"number","description":"The latitude of the location.","format":"double","nullable":true,"example":33.81228788622535}},"description":"Details of the geographic coordinates of a stop on a draft listing.","nullable":true},"DraftListingCollection":{"type":"object","properties":{"href":{"type":"string","description":"The URL used to query the current collection of the resource.","example":"https://marketplace-api.centraldispatch.com/draft-listings/batch"},"count":{"type":"integer","description":"The total count of resources in the collection.","format":"int32","example":23},"items":{"type":"array","items":{"$ref":"#/components/schemas/DraftListingResponse"},"description":"A collection of records."}},"description":"A collection of draft listings."},"DraftListingPaginatedCollection":{"type":"object","properties":{"href":{"type":"string","description":"The URL used to query the current collection of the resource.","example":"https://marketplace-api.centraldispatch.com/draft-listings/mine?limit(5,1)"},"first":{"type":"string","description":"The URL to the first page of the collection.","nullable":true,"example":"https://marketplace-api.centraldispatch.com/draft-listings/mine?limit(1,1)"},"previous":{"type":"string","description":"The URL to the previous page of the collection, if available.","nullable":true,"example":"https://marketplace-api.centraldispatch.com/draft-listings/mine?limit(4,1)"},"next":{"type":"string","description":"The URL to the next page of the collection, if available.","nullable":true,"example":"https://marketplace-api.centraldispatch.com/draft-listings/mine?limit(6,1)"},"limit":{"type":"integer","description":"The maximum number of items to be returned in the response.","format":"int32","example":1},"count":{"type":"integer","description":"The total count of resources in the collection.","format":"int32","example":23},"items":{"type":"array","items":{"$ref":"#/components/schemas/DraftListingResponse"},"description":"A collection of records."}},"description":"A paginated collection of draft listings."},"DraftListingRequest":{"type":"object","properties":{"shipperOrderId":{"maxLength":50,"type":"string","description":"The ID of the shipper order.","nullable":true,"example":"123-abc 900"},"externalId":{"maxLength":50,"type":"string","description":"An identifier managed by the user. Shippers can use this field to map a record (e.g. order, shipment, dispatch) in their local TMS to a Central Dispatch record. This value is displayed as the load number on the Central Dispatch website.","nullable":true,"example":"RND10 CHEV"},"trailerType":{"enum":["DRIVEAWAY","ENCLOSED","OPEN"],"type":"string","description":"The trailer type. This list is not exhaustive and additional values may be added at any time.","default":"OPEN","nullable":true,"example":"OPEN"},"loadSpecificTerms":{"maxLength":500,"type":"string","description":"These are provisions added to a contract that specify extra obligations, rights, or conditions beyond the standard terms.\r\nReal Life Example: Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.\r\nRules: This information will be visible only to the assigned carrier after the load is dispatched, and it will no longer be editable at that point.","nullable":true,"example":"Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied."},"requiresInspection":{"type":"boolean","description":"Indicates the shipper requests for the carrier to use the Central Dispatch Mobile App to perform vehicle inspection at pickup and delivery. If true, the carrier will be asked to acknowledge the request before accepting the load.","default":false,"nullable":true,"example":true},"requiresDriverVerificationAtPickup":{"type":"boolean","description":"Indicates if the driver verification process is required. A driver must be assigned to the load before delivery. Information will be emailed to the contact physically present at the pickup location for use in verifying the driver's identification. The Central Dispatch Mobile App must be used to perform the pickup and delivery inspection. (Only currently applicable to select private Marketplaces).","default":false,"nullable":true,"example":true},"availableDate":{"type":"string","description":"The available date of the listing, in UTC/ISO 8601 format. Must not be before today or later than 30 days from today.","format":"date-time","example":"2025-02-20T00:00:00Z"},"expirationDate":{"type":"string","description":"The expiration date of the listing, in UTC/ISO 8601 format. Must not be before today or later than 30 days from today. Will default to after creation date if not supplied.","format":"date-time","nullable":true,"example":"2025-03-10T00:00:00Z"},"desiredDeliveryDate":{"type":"string","description":"The desired delivery date of the listing, in UTC/ISO 8601 format. Must be equal or greater than `availableDate` and not before today or later than 30 days from today (optional).","format":"date-time","nullable":true,"example":"2025-03-04T00:00:00Z"},"partnerReferenceId":{"maxLength":50,"type":"string","description":"A user supplied ID used for reference.","nullable":true,"example":"969175d4-a3f8-4e43-b64f-a95d77475aa0"},"price":{"$ref":"#/components/schemas/DraftPriceRequest"},"sla":{"$ref":"#/components/schemas/DraftSlaRequest"},"stops":{"type":"array","items":{"$ref":"#/components/schemas/DraftStopRequest"},"description":"A collection of stops associated with the listing. A minimum of two stops is required, one for pickup and one for delivery."},"vehicles":{"type":"array","items":{"$ref":"#/components/schemas/DraftVehicleRequest"},"description":"A collection of vehicles associated with the listing. A minimum of one vehicle is required."},"marketplaces":{"type":"array","items":{"$ref":"#/components/schemas/DraftMarketplaceRequest"},"description":"A collection of marketplaces associated with the listing."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagRequest"},"description":"A collection of tags associated with the listing.","nullable":true},"transportationReleaseNotes":{"type":"string","description":"Displayed in Central Dispatch website/app as \"Transport Special Instructions\", these are specific guidelines or details for the safe and efficient pick up, delivery, or transportation of a load. This may contain sensitive data and is not available prior to acceptance of terms by a carrier.\r\nRules: This information is visible only to the assigned carrier after the load is dispatched and remains editable at any time.","nullable":true,"example":"You will need special clearance to get in the lot. Call Jean at 303-999-1212."},"dispatchId":{"type":"string","description":"If creating a listing from a canceled dispatch, provide the dispatch ID on Create Listing to qualify for quota exemption on matching vehicles. For each vehicle whose VIN matches a vehicle on the original dispatch, the prior quota allocation may be reused instead of incrementing. Not required and has no effect on Update Listing.","format":"uuid","nullable":true,"example":"d159acc0-e89b-12d3-a456-426614174000"}},"description":"Details of a draft listing to be created or updated."},"DraftListingResponse":{"type":"object","properties":{"listingId":{"type":"integer","description":"The ID of the listing.","format":"int64","example":42220470},"shipperId":{"type":"string","description":"The ID of the Central Dispatch customer who is the shipper.","format":"uuid","example":"afd2fb59-b89d-4572-8f9a-e57f82a61c68"},"shipperOrderId":{"type":"string","description":"The ID of the shipper order.","nullable":true,"example":"123-abc 900"},"partnerReferenceId":{"type":"string","description":"A user supplied ID used for reference.","nullable":true,"example":"25-KL8CH6"},"externalId":{"type":"string","description":"An identifier managed by the user. Shippers can use this field to map a record (e.g. order, shipment, dispatch) in their local TMS to a Central Dispatch record. This value is displayed as the load number on the Central Dispatch website.","nullable":true,"example":"RND10 CHEV"},"loadSpecificTerms":{"type":"string","description":"These are provisions added to a contract that specify extra obligations, rights, or conditions beyond the standard terms.\r\nReal Life Example: Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.\r\nRules: This information will be visible only to the assigned carrier after the load is dispatched, and it will no longer be editable at that point.","nullable":true,"example":"Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied."},"href":{"type":"string","description":"The fully qualified URL of the listing.","example":"https://marketplace-api.centraldispatch.com/listings/id/42220470"},"totalDistanceInMiles":{"type":"integer","description":"The total travel distance in miles.","format":"int32","example":267},"hasInOpVehicle":{"type":"boolean","description":"Indicates whether the vehicle is inoperable.","example":false},"availableDate":{"type":"string","description":"The available date of the listing, in UTC/ISO 8601 format.","format":"date-time","example":"2025-11-05T00:00:00.000Z"},"createdOn":{"type":"string","description":"The date and time the listing was created, in UTC/ISO 8601 format.","format":"date-time","example":"2024-10-15T00:00:00Z"},"deletedDate":{"type":"string","description":"The date and time the listing was deleted, in UTC/ISO 8601 format.","format":"date-time","nullable":true,"example":"2024-09-10T00:00:00Z"},"archivedDate":{"type":"string","description":"The date and time the listing was archived, in UTC/ISO 8601 format.","format":"date-time","nullable":true,"example":"2024-08-01T00:00:00Z"},"expirationDate":{"type":"string","description":"The expiration date of the listing, in UTC/ISO 8601 format.","format":"date-time","example":"2025-08-15T00:00:00.000Z"},"desiredDeliveryDate":{"type":"string","description":"The desired delivery date of the listing, in UTC/ISO 8601 format.","format":"date-time","nullable":true,"example":"2025-03-04T00:00:00Z"},"source":{"$ref":"#/components/schemas/Source"},"trailerType":{"enum":["DRIVEAWAY","ENCLOSED","OPEN"],"type":"string","description":"The trailer type. This list is not exhaustive and additional values may be added at any time.","example":"OPEN"},"listingStatus":{"$ref":"#/components/schemas/ListingStatus"},"partnerId":{"type":"string","description":"The Central Dispatch ID of the partner who created or last updated the transaction on behalf of the customer. Will be null if the customer made the API call directly.","nullable":true,"example":"b6e8c9e4-989a-4b37-8dd7-99fd34882bd0"},"clientId":{"type":"string","description":"The Central Dispatch ID of the user who created or last updated the resource.","nullable":true,"example":"6e93ff07-6ea6-4239-b502-7bf4f68d2600"},"requiresInspection":{"type":"boolean","description":"Indicates the shipper requests for the carrier to use the Central Dispatch Mobile App to perform vehicle inspection at pickup and delivery. If true, the carrier will be asked to acknowledge the request before accepting the load.","nullable":true,"example":false},"requiresDriverVerificationAtPickup":{"type":"boolean","description":"Indicates if the driver verification process is required. A driver must be assigned to the load before delivery. Information will be emailed to the contact physically present at the pickup location for use in verifying the driver's identification. The Central Dispatch Mobile App must be used to perform the pickup and delivery inspection. (Only currently applicable to select private Marketplaces).","nullable":true,"example":false},"price":{"$ref":"#/components/schemas/DraftPriceResponse"},"sla":{"$ref":"#/components/schemas/DraftSlaResponse"},"vehicles":{"type":"array","items":{"$ref":"#/components/schemas/DraftVehicleResponse"},"description":"A collection of vehicles associated with the listing."},"stops":{"type":"array","items":{"$ref":"#/components/schemas/DraftStopResponse"},"description":"A collection of stops associated with the listing."},"marketplaces":{"type":"array","items":{"$ref":"#/components/schemas/DraftMarketplaceResponse"},"description":"A collection of marketplaces associated with the listing."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResponse"},"description":"A collection of tags associated with the listing.","nullable":true}},"description":"Details of a draft listing."},"DraftMarketplaceRequest":{"type":"object","properties":{"marketplaceId":{"type":"integer","description":"The ID of the Central Dispatch Marketplace. There are three types of Marketplaces:\r\n\r\n- **Public**: The public Marketplace ID is `10000`.\r\n- **Test**: Test Marketplace IDs will be provided to you by Central Dispatch.\r\n- **Private**: Private Marketplace IDs will be provided to you by Central Dispatch, if necessary.","format":"int32","example":10000},"digitalOffersEnabled":{"type":"boolean","description":"Indicates whether digital offers are enabled for this Marketplace on this listing. Digital offers functionality is currently only available for select private Marketplaces. When `true` the following are required: \r\n - `sla` is required. \r\n - `stops` address is required.\r\n - `vehicles` all vehicles must have VIN.","default":false,"nullable":true,"example":true},"searchable":{"type":"boolean","description":"Controls whether the listing appears in Marketplace search results. Allows listings to be posted but not publicly searchable. When `true`: listing is visible and searchable on this Marketplace. When `false`: listing is hidden from Marketplace search.","default":false,"nullable":true,"example":true},"offersAutoAcceptEnabled":{"type":"boolean","description":"Allows carrriers to digitially accept an offer. The button will be visible for this Marketplace on this listing. Requires `digitalOffersEnabled` to be true.","default":false,"nullable":true,"example":false},"predispatchNotes":{"maxLength":500,"type":"string","description":"Provides general preparation instructions for shipments. This should not contain sensitive data as it is made available prior to acceptance of terms by a carrier.\r\nRules: This information will always be visible to carriers, and it will no longer be editable once the load is dispatched.","nullable":true,"example":"In order to pick up the keys you will have to walk through a lot with a big dog that protects it, he's chained but will bark at you."},"excludeCustomersFromOffers":{"type":"array","items":{"type":"string","format":"uuid"},"description":"A collection of customer IDs excluded from offers.","nullable":true,"example":["0ca91a43-fbee-4c05-9a6c-aa5c63888f5c","d4efb4d9-2418-4070-b2f9-46317d578a31"]},"autoDispatchOnOfferAccepted":{"type":"boolean","description":"Automatically creates a dispatch when a carrier accepts an offer on the listing. If not specified, the value defaults to the configuration of the marketplace the listing is posted to. If explicitly provided, the supplied value takes precedence.","default":false,"nullable":true,"example":true},"makeOffersEnabled":{"type":"boolean","description":"Allows carriers to make an offer on the listing. The button will be visible for this Marketplace on this listing. Requires `digitalOffersEnabled` to be true. Defaults to the value of `digitalOffersEnabled` if null.","nullable":true,"example":true}},"description":"Details of a marketplace on a draft listing."},"DraftMarketplaceResponse":{"type":"object","properties":{"marketplaceId":{"type":"integer","description":"The ID of the Central Dispatch Marketplace. There are three types of Marketplaces:\r\n\r\n- **Public**: The public Marketplace ID is `10000`.\r\n- **Test**: Test Marketplace IDs will be provided to you by Central Dispatch.\r\n- **Private**: Private Marketplace IDs will be provided to you by Central Dispatch, if necessary.","format":"int32","example":10000},"digitalOffersEnabled":{"type":"boolean","description":"Indicates whether digital offers are enabled for this Marketplace on this listing. Digital offers functionality is currently only available for select private Marketplaces.","example":true},"searchable":{"type":"boolean","description":"Controls whether the listing appears in Marketplace search results. Allows listings to be posted but not publicly searchable. When `true`: listing is visible and searchable on this Marketplace. When `false`: listing is hidden from Marketplace search.","example":true},"offersAutoAcceptEnabled":{"type":"boolean","description":"Allows carrriers to digitially accept an offer. The button will be visible for this Marketplace on this listing. Requires `digitalOffersEnabled` to be true.","example":true},"predispatchNotes":{"type":"string","description":"Provides general preparation instructions for shipments. This should not contain sensitive data as it is made available prior to acceptance of terms by a carrier.\r\nRules: This information will always be visible to carriers, and it will no longer be editable once the load is dispatched.","nullable":true,"example":"In order to pick up the keys you will have to walk through a lot with a big dog that protects it, he's chained but will bark at you."},"customersExcludedFromOffers":{"type":"array","items":{"type":"string","format":"uuid"},"description":"A collection of customer IDs excluded from offers.","nullable":true,"example":["d5c62b14-cbd1-11ee-9a0e-0242ac110002","157a16f0-503d-4256-ba60-a4876e8eb9bb"]},"autoDispatchOnOfferAccepted":{"type":"boolean","description":"Automatically creates a dispatch when a carrier accepts an offer on the listing. If not specified, the value defaults to the configuration of the marketplace the listing is posted to. If explicitly provided, the supplied value takes precedence.","example":true},"makeOffersEnabled":{"type":"boolean","description":"Allows carriers to make an offer on the listing. The button will be visible for this Marketplace on this listing. Requires `digitalOffersEnabled` to be true.","nullable":true,"example":true}},"description":"Details of a marketplace on a draft listing."},"DraftPriceRequest":{"type":"object","properties":{"total":{"minimum":0.01,"type":"number","description":"The total amount to be paid for completing the dispatch.","format":"double","example":500},"totalCurrency":{"$ref":"#/components/schemas/Currency"},"cod":{"$ref":"#/components/schemas/DraftCodRequest"},"balance":{"$ref":"#/components/schemas/DraftBalanceRequest"}},"description":"Details of the price of a draft listing."},"DraftPriceResponse":{"type":"object","properties":{"total":{"type":"number","description":"The total amount to be paid for completing the dispatch.","format":"double","example":500},"totalCurrency":{"$ref":"#/components/schemas/Currency"},"cod":{"$ref":"#/components/schemas/DraftCodResponse"},"balance":{"$ref":"#/components/schemas/DraftBalanceResponse"}},"description":"Details of the price of a draft listing."},"DraftSlaRequest":{"type":"object","properties":{"duration":{"type":"string","description":"How many days the customer has to pick up/deliver. The format is ISO 8601 duration format `P{duration in days}D` where the number of days comes from when the listing becomes available. For example, `P2D` means 2 days. This sets the deadline for completing the transport.","example":"P2D"},"timeZoneOffset":{"type":"string","description":"Which time zone to use for SLA calculations. For example, `-5.00` represents Eastern Time and `+0.00` represents UTC/GMT. Can be negative. Acceptable range: -12:00 to +14:00 hours.","default":"00:00:00","nullable":true,"example":"-7:00"},"rolloverTime":{"pattern":"^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$","type":"string","description":"The time of day the \"business day\" ends. For example, 17:30 means 5:30 PM. If the load is accepted after this time and available for immediate pickup, the ability for it to be picked up on the same day is determined by `includeCurrentDayAfterRollOver`.","default":"00:00:00","nullable":true,"example":"19:00:00"},"includeCurrentDayAfterRollOver":{"type":"boolean","description":"Indicates whether the load can be picked up after the rollover time if it is available on the same day the load is accepted. This could be do to the pickup location not being open or reachable after the rollover time. Does not apply to listings with availableDate in the future.\r\nExample with 5:30 PM rollover:\r\nWhen true: When accepting the load, the carrier can choose to pick it up after 5:30 PM. Sla duration starts tomorrow and ends on day 3.\r\nWhen false: When accepting the load, the carrier cannot choose to pick it up after 5:30 PM today. It can only be picked up tomorrow as the pickup location has closed at the rollover time. Sla duration starts tomorrow and ends on day 3.","example":true}},"description":"Details of the service level agreement of a draft listing."},"DraftSlaResponse":{"type":"object","properties":{"duration":{"type":"string","description":"How many days the customer has to pick up/deliver. The format is ISO 8601 duration format `P{duration in days}D` where the number of days comes from when the listing becomes available. For example, `P2D` means 2 days. This sets the deadline for completing the transport.","example":"P2D"},"timeZoneOffset":{"type":"string","description":"Which time zone to use for SLA calculations. For example, `-5.00` represents Eastern Time and `+0.00` represents UTC/GMT. Can be negative. Acceptable range: -12:00 to +14:00 hours.","example":"-7:00"},"rolloverTime":{"pattern":"^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$","type":"string","description":"The time of day the \"business day\" ends. For example, 17:30 means 5:30 PM. If the load is accepted after this time and available for immediate pickup, the ability for it to be picked up on the same day is determined by `includeCurrentDayAfterRollOver`.","example":"19:00:00"},"includeCurrentDayAfterRollOver":{"type":"boolean","description":"Indicates whether the load can be picked up after the rollover time if it is available on the same day the load is accepted. This could be do to the pickup location not being open or reachable after the rollover time. Does not apply to listings with availableDate in the future.\r\nExample with 5:30 PM rollover:\r\nWhen true: When accepting the load, the carrier can choose to pick it up after 5:30 PM. Sla duration starts tomorrow and ends on day 3.\r\nWhen false: When accepting the load, the carrier cannot choose to pick it up after 5:30 PM today. It can only be picked up tomorrow as the pickup location has closed at the rollover time. Sla duration starts tomorrow and ends on day 3.","example":true}},"description":"Details of the service level agreement of a draft listing."},"DraftStopRequest":{"type":"object","properties":{"stopId":{"type":"string","description":"The system assigned UUID of the stop. Read-only on create (POST). Required on update (PUT).","format":"uuid"},"stopNumber":{"type":"integer","description":"The sequential number of the stop along the route e.g. 1 is the pick up stop and 2 is the delivery stop.","format":"int32","example":1},"locationName":{"maxLength":200,"type":"string","description":"The name of the stop.","nullable":true,"example":"ABC Cars lot"},"address":{"maxLength":100,"type":"string","description":"The street address.","nullable":true,"example":"345 W Elm St."},"address2":{"maxLength":100,"type":"string","description":"Additional street address line.","nullable":true,"example":"2nd Floor"},"city":{"maxLength":50,"type":"string","description":"The city.","example":"Anaheim"},"state":{"type":"string","description":"The state.","example":"CA"},"postalCode":{"maxLength":20,"type":"string","description":"The ZIP code. Must be a valid United States ZIP code or Canadian postal code.","example":"92802"},"country":{"maxLength":2,"type":"string","description":"The country code. US or CA.","nullable":true,"example":"US"},"phone":{"maxLength":50,"type":"string","description":"The primary phone number of the contact.","nullable":true,"example":"949-555-1323"},"phone2":{"maxLength":50,"type":"string","description":"An additional phone number of the contact.","nullable":true,"example":"949-555-2434"},"phone3":{"maxLength":50,"type":"string","description":"An additional phone number of the contact.","nullable":true,"example":"949-555-3545"},"siteId":{"type":"string","description":"The ID of the site.","nullable":true,"example":"ABC"},"contactName":{"maxLength":100,"type":"string","description":"The name of the contact.","nullable":true,"example":"Mickey Smith"},"contactPhone":{"maxLength":50,"type":"string","description":"The primary phone number of the contact.","nullable":true,"example":"949-555-1323"},"contactCellPhone":{"maxLength":50,"type":"string","description":"The cell phone number of the contact.","nullable":true,"example":"949-555-1212"},"buyerNumber":{"maxLength":70,"type":"string","description":"The buyer reference number.","nullable":true,"example":"12345"},"metroArea":{"maxLength":150,"type":"string","description":"The metro area of the stop.","nullable":true,"example":"Orange County"},"twic":{"type":"boolean","description":"Indicates whether the stop requires driver to have a Transportation Worker Identification Credential (TWIC). A TWIC is a credential required by the Maritime Transportation Security Act for carriers to access some locations. If you are not sure if a TWIC is needed, please contact the location.","default":false,"example":true},"geoCode":{"$ref":"#/components/schemas/DraftGeoCodeRequest"},"locationType":{"enum":["Unspecified","AirportRentalCenter","Auction","AuctionSatelliteLot","CommercialBusiness","CorporateOfficePlant","CrossDockSatelliteStagingLot","Dealership","Impound","MarshallingYard","MilitaryBase","MobileAuction","Port","RailYard","ReconFacility","RentalCarRetailSite","Repo","Residence","ServiceCenter","ConsumerMoves","Terminal","Other","MechanicShop","Warehouse","ParkingLot"],"type":"string","description":"The facility type of the stop. This list is not exhaustive and additional values may be added at any time.","default":"Unspecified","nullable":true,"example":"Dealership"},"contactEmailAddress":{"type":"string","description":"The email address of the contact. Must be a valid email address format.","nullable":true,"example":"mickey@snoogle.com"}},"description":"Details of a stop on a draft listing."},"DraftStopResponse":{"type":"object","properties":{"stopId":{"type":"string","description":"The system assigned UUID of the stop.","format":"uuid","example":"4e2efc84-6add-435c-9f12-8b19e3e5ba21"},"stopNumber":{"type":"integer","description":"The sequential number of the stop along the route e.g. 1 is the pick up stop and 2 is the delivery stop.","format":"int32","example":1},"locationName":{"type":"string","description":"The name of the stop.","nullable":true,"example":"ABC Cars lot"},"address":{"type":"string","description":"The street address.","nullable":true,"example":"345 W Elm St."},"address2":{"type":"string","description":"Additional street address line.","nullable":true,"example":"2nd Floor"},"city":{"type":"string","description":"The city.","nullable":true,"example":"Anaheim"},"state":{"type":"string","description":"The state.","nullable":true,"example":"CA"},"postalCode":{"type":"string","description":"The ZIP code. Must be a valid United States ZIP code or Canadian postal code.","nullable":true,"example":"92802"},"country":{"type":"string","description":"The country code. US or CA.","nullable":true,"example":"US"},"distanceToNextStopInMiles":{"type":"integer","description":"The distance to the next stop in miles.","format":"int32","example":267},"phone":{"type":"string","description":"The primary phone number of the contact.","nullable":true,"example":"949-555-1323"},"phone2":{"type":"string","description":"An additional phone number of the contact.","nullable":true,"example":"949-555-2434"},"phone3":{"type":"string","description":"An additional phone number of the contact.","nullable":true,"example":"949-555-3545"},"siteId":{"type":"string","description":"The ID of the site.","nullable":true,"example":"ABC"},"contactName":{"type":"string","description":"The name of the contact.","nullable":true,"example":"Mickey Smith"},"contactPhone":{"type":"string","description":"The primary phone number of the contact.","nullable":true,"example":"949-555-1323"},"contactCellPhone":{"type":"string","description":"The cell phone number of the contact.","nullable":true,"example":"949-555-1212"},"contactEmailAddress":{"type":"string","description":"The email address of the contact. Must be a valid email address format.","nullable":true,"example":"mickey@snoogle.com"},"metroArea":{"type":"string","description":"The metro area of the stop.","nullable":true,"example":"Orange County"},"locationType":{"enum":["Unspecified","AirportRentalCenter","Auction","AuctionSatelliteLot","CommercialBusiness","CorporateOfficePlant","CrossDockSatelliteStagingLot","Dealership","Impound","MarshallingYard","MilitaryBase","MobileAuction","Port","RailYard","ReconFacility","RentalCarRetailSite","Repo","Residence","ServiceCenter","ConsumerMoves","Terminal","Other","MechanicShop","Warehouse","ParkingLot"],"type":"string","description":"The facility type of the stop. This list is not exhaustive and additional values may be added at any time.","example":"Dealership"},"geoCode":{"$ref":"#/components/schemas/DraftGeoCodeResponse"},"twic":{"type":"boolean","description":"Indicates whether the stop requires driver to have a Transportation Worker Identification Credential (TWIC). A TWIC is a credential required by the Maritime Transportation Security Act for carriers to access some locations. If you are not sure if a TWIC is needed, please contact the location.","example":true},"buyerNumber":{"type":"string","description":"The buyer reference number.","nullable":true,"example":"12345"}},"description":"Details of a stop on a draft listing."},"DraftVehicleRequest":{"type":"object","properties":{"vehicleId":{"type":"string","description":"The system assigned UUID of the vehicle.\r\n\r\n- **POST (Create)**: Read-only. Do not include a client-supplied value ā€” the system generates this on creation.\r\n- **PUT (Update)**: Required only if you are updating an existing vehicle ā€” supply the `vehicleId` of the vehicle you intend to update. Omit it to add a new vehicle to the listing.\r\n\r\nāš ļø Important: If `vehicleId` is omitted on a PUT request for a vehicle you intended to update, the system cannot match the request to an existing vehicle and will treat it as a new vehicle creation. This will count against your vehicle quota.","format":"uuid"},"externalVehicleId":{"maxLength":50,"type":"string","description":"A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record.","nullable":true,"example":"EXT123456"},"pickupStopNumber":{"type":"integer","description":"The stop number where the vehicle will be picked up.","format":"int32","example":1},"dropoffStopNumber":{"type":"integer","description":"The sequential stop number where the vehicle will be delivered. Must be greater than `pickupStopNumber`.","format":"int32","example":2},"vin":{"maxLength":50,"type":"string","description":"The vehicle identification number (VIN). Required if `year`, `make` and `model` are null.","nullable":true,"example":"KL8CH6SA6NC001234"},"year":{"type":"integer","description":"The 4 digit year of the vehicle. Required if `vin` is null.","format":"int32","nullable":true,"example":2022},"make":{"maxLength":50,"type":"string","description":"The manufacturer's make of the vehicle. Required if `vin` is null.","nullable":true,"example":"Chevrolet"},"model":{"maxLength":50,"type":"string","description":"The manufacturer's model of the vehicle. Required if `vin` is null.","nullable":true,"example":"Spark"},"trim":{"maxLength":100,"type":"string","description":"The manufacturer's trim of the vehicle.","nullable":true,"example":"LS"},"vehicleType":{"enum":["ATV","BOAT","CAR","HEAVY_EQUIPMENT","LARGE_YACHT","MOTORCYCLE","OTHER","PICKUP","RV","SUV","TRAVEL_TRAILER","VAN"],"type":"string","description":"The type of vehicle e.g. CAR, PICKUP, SUV. This list is not exhaustive and additional values may be added at any time.","default":"OTHER","nullable":true,"example":"CAR"},"vehicleTypeOther":{"maxLength":100,"type":"string","description":"The description of the vehicle type. Will default to `Other` when null and `vehicleType` is `OTHER`.","nullable":true,"example":"Golf Cart"},"color":{"maxLength":100,"type":"string","description":"The color of the vehicle.","nullable":true,"example":"Red"},"licensePlate":{"maxLength":20,"type":"string","description":"The license plate of the vehicle.","nullable":true,"example":"B314PIE"},"licensePlateState":{"maxLength":2,"type":"string","description":"The two-letter state abbreviation of the vehicle's license plate.","nullable":true,"example":"CA"},"lotNumber":{"maxLength":50,"type":"string","description":"The lot number of the vehicle.","nullable":true,"example":"LOT789"},"isInoperable":{"type":"boolean","description":"Indicates whether the vehicle is inoperable.","default":false,"nullable":true,"example":false},"tariff":{"type":"number","description":"The tariff on the vehicle.","format":"double","nullable":true,"example":1030.5},"tariffCurrency":{"$ref":"#/components/schemas/Currency"},"additionalInfo":{"maxLength":500,"type":"string","description":"Additional information.","nullable":true,"example":"The vehicle is in the back of the lot behind the big tree."},"oversized":{"type":"boolean","description":"Indicates whether the load is oversized.","default":false,"nullable":true,"example":false},"shippingSpecs":{"$ref":"#/components/schemas/ShippingSpecsRequest"},"vehicleAttributes":{"type":"array","items":{"$ref":"#/components/schemas/VehicleAttributeRequest"},"description":"A collection of vehicle attributes.","nullable":true},"noKeys":{"type":"boolean","description":"Indicates whether the vehicle has no keys.","default":false,"nullable":true,"example":true},"noTires":{"type":"boolean","description":"Indicates whether the vehicle has no tires.","default":false,"nullable":true,"example":false},"flatTire":{"type":"boolean","description":"Indicates whether the vehicle has a flat tire.","default":false,"nullable":true,"example":true},"frameDamage":{"type":"boolean","description":"Indicates whether the vehicle has frame damage.","default":false,"nullable":true,"example":false},"doesNotRun":{"type":"boolean","description":"Indicates whether the vehicle does not run.","default":false,"nullable":true,"example":true},"doesNotSteer":{"type":"boolean","description":"Indicates whether the vehicle does not steer.","default":false,"nullable":true,"example":false},"doesNotRoll":{"type":"boolean","description":"Indicates whether the vehicle does not roll.","default":false,"nullable":true,"example":false},"inOpNotes":{"maxLength":200,"type":"string","description":"Notes about the inoperable condition of the vehicle.","nullable":true,"example":"Vehicle does not start."}},"description":"Details of a vehicle on a draft listing."},"DraftVehicleResponse":{"type":"object","properties":{"vehicleId":{"type":"string","description":"The ID of the vehicle.","format":"uuid","example":"b331c130-e89b-12d3-a456-426614174000"},"externalVehicleId":{"type":"string","description":"A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record.","nullable":true,"example":"EXT123456"},"pickupStopNumber":{"type":"integer","description":"The stop number where the vehicle will be picked up.","format":"int32","example":1},"dropOffStopNumber":{"type":"integer","description":"The sequential stop number where the vehicle will be delivered.","format":"int32","example":2},"vin":{"type":"string","description":"The vehicle identification number (VIN).","nullable":true,"example":"KL8CH6SA6NC001234"},"year":{"type":"integer","description":"The 4 digit year of the vehicle.","format":"int32","nullable":true,"example":2022},"make":{"type":"string","description":"The manufacturer's make of the vehicle.","nullable":true,"example":"Chevrolet"},"model":{"type":"string","description":"The manufacturer's model of the vehicle.","nullable":true,"example":"Spark"},"trim":{"type":"string","description":"The manufacturer's trim of the vehicle.","nullable":true,"example":"LS"},"vehicleType":{"enum":["ATV","BOAT","CAR","HEAVY_EQUIPMENT","LARGE_YACHT","MOTORCYCLE","OTHER","PICKUP","RV","SUV","TRAVEL_TRAILER","VAN"],"type":"string","description":"The type of vehicle e.g. CAR, PICKUP, SUV. This list is not exhaustive and additional values may be added at any time."},"vehicleTypeOther":{"type":"string","description":"The description of the vehicle type.","nullable":true,"example":"CAR"},"color":{"type":"string","description":"The color of the vehicle.","nullable":true,"example":"Red"},"licensePlate":{"type":"string","description":"The license plate of the vehicle.","nullable":true,"example":"B314PIE"},"licensePlateState":{"type":"string","description":"The two-letter state abbreviation of the vehicle's license plate.","nullable":true,"example":"CA"},"lotNumber":{"type":"string","description":"The lot number of the vehicle.","nullable":true,"example":"LOT789"},"isInoperable":{"type":"boolean","description":"Indicates whether the vehicle is inoperable.","example":false},"tariff":{"type":"number","description":"The tariff on the vehicle.","format":"double","nullable":true,"example":1030.5},"tariffCurrency":{"$ref":"#/components/schemas/Currency"},"additionalInfo":{"type":"string","description":"Additional information.","nullable":true,"example":"The vehicle is in the back of the lot behind the big tree."},"oversized":{"type":"boolean","description":"Indicates whether the load is oversized.","example":false},"shippingSpecs":{"$ref":"#/components/schemas/ShippingSpecsResponse"},"vehicleAttributes":{"type":"array","items":{"$ref":"#/components/schemas/VehicleAttributeResponse"},"description":"A collection of vehicle attributes.","nullable":true},"noKeys":{"type":"boolean","description":"Indicates whether the vehicle has no keys.","example":true},"noTires":{"type":"boolean","description":"Indicates whether the vehicle has no tires.","example":false},"flatTire":{"type":"boolean","description":"Indicates whether the vehicle has a flat tire.","example":true},"frameDamage":{"type":"boolean","description":"Indicates whether the vehicle has frame damage.","example":false},"doesNotRun":{"type":"boolean","description":"Indicates whether the vehicle does not run.","example":true},"doesNotSteer":{"type":"boolean","description":"Indicates whether the vehicle does not steer.","example":false},"doesNotRoll":{"type":"boolean","description":"Indicates whether the vehicle does not roll.","example":false},"inOpNotes":{"type":"string","description":"Notes about the inoperable condition of the vehicle.","nullable":true,"example":"Vehicle does not start."}},"description":"Details of a vehicle on a draft listing."},"Error":{"type":"object","properties":{"code":{"type":"string","description":"The code used for the issue.","nullable":true,"example":"resource.issue_type"},"message":{"type":"string","description":"A detailed message.","nullable":true,"example":"The issue happened because something is wrong."},"property":{"type":"string","description":"The property to which the issue is associated.","nullable":true,"example":"person"},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional properties related to the issue.","nullable":true,"example":{"firstName":"D0nn@","lastName":"Sm!th"}}},"description":"Details of an error or issue."},"ErrorAlt":{"type":"object","properties":{"errorID":{"type":"string","description":"The ID of the error.","nullable":true,"example":"157a16f0-503d-4256-ba60-a4876e8eb9bb"},"code":{"type":"string","description":"The code used for the issue.","nullable":true,"example":"resource.issue_type"},"description":{"type":"string","description":"A detailed message.","nullable":true,"example":"The issue happened because something is wrong."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ErrorAltProperty"},"description":"Properties related to the issue.","nullable":true}},"description":"Details of an error or issue."},"ErrorAltProperty":{"type":"object","properties":{"property":{"type":"string","description":"The name of the property.","nullable":true,"example":"person"},"value":{"type":"string","description":"The value of the property.","nullable":true,"example":"J0hn D03"}},"description":"Details of an error's property."},"Errors":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"},"description":"A collection of errors.","nullable":true}},"description":"An error occurred, and the request could not be completed."},"ErrorsAlt":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorAlt"},"description":"A collection of errors.","nullable":true}},"description":"An error occurred, and the request could not be completed."},"ErrorsWithProperties":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorWithProperties"},"description":"A collection of errors.","nullable":true}},"description":"An error occurred, and the request could not be completed."},"ErrorWithProperties":{"type":"object","properties":{"code":{"type":"string","description":"The code used for the issue.","nullable":true,"example":"resource.issue_type"},"message":{"type":"string","description":"A detailed message.","nullable":true,"example":"The issue happened because something is wrong."},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ErrorAltProperty"},"description":"Properties related to the issue.","nullable":true}},"description":"Details of an error or issue."},"GeoCodeRequest":{"type":"object","properties":{"longitude":{"type":"number","description":"The longitude of the location.","format":"double","example":-117.91836265987132},"latitude":{"type":"number","description":"The latitude of the location.","format":"double","example":33.81228788622535}},"description":"Details of the geographical coordinates for a location.","nullable":true},"GeoCodeResponse":{"type":"object","properties":{"longitude":{"type":"number","description":"The longitude of the location.","format":"double","example":-117.91836265987132},"latitude":{"type":"number","description":"The latitude of the location.","format":"double","example":33.81228788622535}},"description":"Details of the geographical coordinates for a location.","nullable":true},"ListingCollection":{"type":"object","properties":{"href":{"type":"string","description":"The URL used to query the current collection of the resource.","example":"https://marketplace-api.centraldispatch.com/listings?limit(5,1)"},"count":{"type":"integer","description":"The total count of resources in the collection.","format":"int32","example":23},"items":{"type":"array","items":{"$ref":"#/components/schemas/ListingResponse"},"description":"A collection of records."}},"description":"A collection of listings."},"ListingRequest":{"type":"object","properties":{"shipperOrderId":{"maxLength":50,"type":"string","description":"The ID of the shipper order.","nullable":true,"example":"123-abc 900"},"externalId":{"maxLength":50,"type":"string","description":"An identifier managed by the user. Shippers can use this field to map a record (e.g. order, shipment, dispatch) in their local TMS to a Central Dispatch record. This value is displayed as the load number on the Central Dispatch website.","nullable":true,"example":"RND10 CHEV"},"trailerType":{"enum":["DRIVEAWAY","ENCLOSED","OPEN"],"type":"string","description":"The trailer type. This list is not exhaustive and additional values may be added at any time.","default":"OPEN","nullable":true,"example":"OPEN"},"loadSpecificTerms":{"maxLength":500,"type":"string","description":"These are provisions added to a contract that specify extra obligations, rights, or conditions beyond the standard terms.\r\nReal Life Example: Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.\r\nRules: This information will be visible only to the assigned carrier after the load is dispatched, and it will no longer be editable at that point.","nullable":true,"example":"Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied."},"requiresInspection":{"type":"boolean","description":"Indicates the shipper requests for the carrier to use the Central Dispatch Mobile App to perform vehicle inspection at pickup and delivery. If true, the carrier will be asked to acknowledge the request before accepting the load.","default":false,"nullable":true,"example":true},"requiresDriverVerificationAtPickup":{"type":"boolean","description":"Indicates if the driver verification process is required. A driver must be assigned to the load before delivery. Information will be emailed to the contact physically present at the pickup location for use in verifying the driver's identification. The Central Dispatch Mobile App must be used to perform the pickup and delivery inspection. (Only currently applicable to select private Marketplaces).","default":false,"nullable":true,"example":true},"availableDate":{"type":"string","description":"The available date of the listing, in UTC/ISO 8601 format. Must not be before today or later than 30 days from today.","format":"date-time","example":"2025-02-20T00:00:00Z"},"expirationDate":{"type":"string","description":"The expiration date of the listing, in UTC/ISO 8601 format. Must not be before today or later than 30 days from today. Will default to after creation date if not supplied.","format":"date-time","nullable":true,"example":"2025-03-10T00:00:00Z"},"desiredDeliveryDate":{"type":"string","description":"The desired delivery date of the listing, in UTC/ISO 8601 format. Must be equal or greater than `availableDate` and not before today or later than 30 days from today (optional).","format":"date-time","nullable":true,"example":"2025-03-04T00:00:00Z"},"partnerReferenceId":{"maxLength":50,"type":"string","description":"A user supplied ID used for reference.","nullable":true,"example":"969175d4-a3f8-4e43-b64f-a95d77475aa0"},"price":{"$ref":"#/components/schemas/PriceRequest"},"sla":{"$ref":"#/components/schemas/SlaRequest"},"stops":{"type":"array","items":{"$ref":"#/components/schemas/StopRequest"},"description":"A collection of stops associated with the listing. A minimum of two stops is required, one for pickup and one for delivery."},"vehicles":{"type":"array","items":{"$ref":"#/components/schemas/VehicleRequest"},"description":"A collection of vehicles associated with the listing. A minimum of one vehicle is required."},"marketplaces":{"type":"array","items":{"$ref":"#/components/schemas/MarketplaceRequest"},"description":"A collection of marketplaces associated with the listing."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagRequest"},"description":"A collection of tags associated with the listing.","nullable":true},"transportationReleaseNotes":{"type":"string","description":"Displayed in Central Dispatch website/app as \"Transport Special Instructions\", these are specific guidelines or details for the safe and efficient pick up, delivery, or transportation of a load. This may contain sensitive data and is not available prior to acceptance of terms by a carrier.\r\nRules: This information is visible only to the assigned carrier after the load is dispatched and remains editable at any time.","nullable":true,"example":"You will need special clearance to get in the lot. Call Jean at 303-999-1212."},"dispatchId":{"type":"string","description":"If creating a listing from a canceled dispatch, provide the dispatch ID on Create Listing to qualify for quota exemption on matching vehicles. For each vehicle whose VIN matches a vehicle on the original dispatch, the prior quota allocation may be reused instead of incrementing. Not required and has no effect on Update Listing.","format":"uuid","nullable":true,"example":"d159acc0-e89b-12d3-a456-426614174000"}},"description":"Details of a listing."},"ListingResponse":{"type":"object","properties":{"listingId":{"type":"integer","description":"The ID of the listing.","format":"int64","example":42220470},"shipperId":{"type":"string","description":"The ID of the Central Dispatch customer who is the shipper.","format":"uuid","example":"afd2fb59-b89d-4572-8f9a-e57f82a61c68"},"loadSpecificTerms":{"type":"string","description":"These are provisions added to a contract that specify extra obligations, rights, or conditions beyond the standard terms.\r\nReal Life Example: Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.\r\nRules: This information will be visible only to the assigned carrier after the load is dispatched, and it will no longer be editable at that point.","nullable":true,"example":"Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied."},"archivedDate":{"type":"string","description":"The date and time the listing was archived, in UTC/ISO 8601 format.","format":"date-time","nullable":true,"example":"2024-08-01T00:00:00Z"},"availableDate":{"type":"string","description":"The available date of the listing, in UTC/ISO 8601 format.","format":"date-time","example":"2025-11-05T00:00:00.000Z"},"createdOn":{"type":"string","description":"The date and time the listing was created, in UTC/ISO 8601 format.","format":"date-time","example":"2024-10-15T00:00:00Z"},"deletedDate":{"type":"string","description":"The date and time the listing was deleted, in UTC/ISO 8601 format.","format":"date-time","nullable":true,"example":"2024-09-10T00:00:00Z"},"desiredDeliveryDate":{"type":"string","description":"The desired delivery date of the listing, in UTC/ISO 8601 format.","format":"date-time","nullable":true,"example":"2025-03-04T00:00:00Z"},"expirationDate":{"type":"string","description":"The expiration date of the listing, in UTC/ISO 8601 format.","format":"date-time","example":"2025-08-15T00:00:00.000Z"},"externalId":{"type":"string","description":"An identifier managed by the user. Shippers can use this field to map a record (e.g. order, shipment, dispatch) in their local TMS to a Central Dispatch record. This value is displayed as the load number on the Central Dispatch website.","nullable":true,"example":"RND10 CHEV"},"hasInOpVehicle":{"type":"boolean","description":"Indicates whether the vehicle is inoperable.","example":false},"href":{"type":"string","description":"The fully qualified URL of the listing.","example":"https://marketplace-api.centraldispatch.com/listings/id/42220470"},"listingStatus":{"$ref":"#/components/schemas/ListingStatus"},"partnerId":{"type":"string","description":"The Central Dispatch ID of the partner who created or last updated the transaction on behalf of the customer. Will be null if the customer made the API call directly.","nullable":true,"example":"b6e8c9e4-989a-4b37-8dd7-99fd34882bd0"},"clientId":{"type":"string","description":"The Central Dispatch ID of the user who created or last updated the resource.","nullable":true,"example":"6e93ff07-6ea6-4239-b502-7bf4f68d2600"},"requiresInspection":{"type":"boolean","description":"Indicates the shipper requests for the carrier to use the Central Dispatch Mobile App to perform vehicle inspection at pickup and delivery. If true, the carrier will be asked to acknowledge the request before accepting the load.","example":true},"requiresDriverVerificationAtPickup":{"type":"boolean","description":"Indicates if the driver verification process is required. A driver must be assigned to the load before delivery. Information will be emailed to the contact physically present at the pickup location for use in verifying the driver's identification. The Central Dispatch Mobile App must be used to perform the pickup and delivery inspection. (Only currently applicable to select private Marketplaces).","example":true},"marketplaces":{"type":"array","items":{"$ref":"#/components/schemas/MarketplaceResponse"},"description":"A collection of marketplaces associated with the listing."},"partnerReferenceId":{"type":"string","description":"A user supplied ID used for reference.","nullable":true,"example":"25-KL8CH6"},"price":{"$ref":"#/components/schemas/PriceResponse"},"shipperOrderId":{"type":"string","description":"The ID of the shipper order.","nullable":true,"example":"123-abc 900"},"sla":{"$ref":"#/components/schemas/SlaResponse"},"source":{"$ref":"#/components/schemas/Source"},"stops":{"type":"array","items":{"$ref":"#/components/schemas/StopResponse"},"description":"A collection of stops associated with the listing."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagResponse"},"description":"A collection of tags associated with the listing.","nullable":true},"totalDistanceInMiles":{"type":"integer","description":"The total travel distance in miles.","format":"int32","example":267},"trailerType":{"enum":["DRIVEAWAY","ENCLOSED","OPEN"],"type":"string","description":"The trailer type. This list is not exhaustive and additional values may be added at any time.","example":"OPEN"},"vehicles":{"type":"array","items":{"$ref":"#/components/schemas/VehicleResponse"},"description":"A collection of vehicles associated with the listing."},"transportationReleaseNotes":{"type":"string","description":"Displayed in Central Dispatch website/app as \"Transport Special Instructions\", these are specific guidelines or details for the safe and efficient pick up, delivery, or transportation of a load. This may contain sensitive data and is not available prior to acceptance of terms by a carrier.\r\nRules: This information is visible only to the assigned carrier after the load is dispatched and remains editable at any time.","nullable":true,"example":"You will need special clearance to get in the lot. Call Jean at 303-999-1212."}},"description":"Details of a listing."},"ListingStatus":{"enum":["ACTIVE","ARCHIVED","DELETED","NOTLISTED"],"type":"string","description":"The status of the listing.\r\n- **ACTIVE**: The load is listed and shown in searches on Central Dispatch.\r\n- **ARCHIVED**: The listing has been archived and is no longer active.\r\n- **DELETED**: The listing has been removed.\r\n- **NOTLISTED**: The load is not shown in searches on Central Dispatch. An `ACTIVE` load automatically becomes `NOTLISTED` when it passes its available-to-ship date by four days, reaches its expiration date, or has `searchable` set to `false`. Available beginning 8/10/26.\r\n\r\n This list is not exhaustive and additional values may be added at any time.","example":"ACTIVE"},"MarketplaceRequest":{"type":"object","properties":{"marketplaceId":{"type":"integer","description":"The ID of the Central Dispatch Marketplace. There are three types of Marketplaces:\r\n\r\n- **Public**: The public Marketplace ID is `10000`.\r\n- **Test**: Test Marketplace IDs will be provided to you by Central Dispatch.\r\n- **Private**: Private Marketplace IDs will be provided to you by Central Dispatch, if necessary.","format":"int32","example":10000},"digitalOffersEnabled":{"type":"boolean","description":"Indicates whether digital offers are enabled for this Marketplace on this listing. Digital offers functionality is currently only available for select private Marketplaces. When `true` the following are required: \r\n - `sla` is required. \r\n - `stops` address is required.\r\n - `vehicles` all vehicles must have VIN.","default":false,"example":true},"searchable":{"type":"boolean","description":"Controls whether the listing appears in Marketplace search results. Allows listings to be posted but not publicly searchable. When `true`: listing is visible and searchable on this Marketplace. When `false`: listing is hidden from Marketplace search.","default":false,"example":true},"offersAutoAcceptEnabled":{"type":"boolean","description":"Allows carrriers to digitially accept an offer. The button will be visible for this Marketplace on this listing. Requires `digitalOffersEnabled` to be true.","default":false,"example":false},"autoDispatchOnOfferAccepted":{"type":"boolean","description":"Automatically creates a dispatch when a carrier accepts an offer on the listing. If not specified, the value defaults to the configuration of the marketplace the listing is posted to. If explicitly provided, the supplied value takes precedence.","default":false,"nullable":true,"example":true},"predispatchNotes":{"maxLength":500,"type":"string","description":"Provides general preparation instructions for shipments. This should not contain sensitive data as it is made available prior to acceptance of terms by a carrier.\r\nRules: This information will always be visible to carriers, and it will no longer be editable once the load is dispatched.","nullable":true,"example":"In order to pick up the keys you will have to walk through a lot with a big dog that protects it, he's chained but will bark at you."},"customersExcludedFromOffers":{"type":"array","items":{"type":"string","format":"uuid"},"description":"A collection of customer IDs excluded from offers. Maximum count of 200.","nullable":true,"example":["d5c62b14-cbd1-11ee-9a0e-0242ac110002","157a16f0-503d-4256-ba60-a4876e8eb9bb"]},"makeOffersEnabled":{"type":"boolean","description":"Allows carriers to make an offer on the listing. The button will be visible for this Marketplace on this listing. Requires `digitalOffersEnabled` to be true. Defaults to the value of `digitalOffersEnabled` if null.","nullable":true,"example":true}},"description":"Details of a marketplace."},"MarketplaceResponse":{"type":"object","properties":{"autoDispatchOnOfferAccepted":{"type":"boolean","description":"Automatically creates a dispatch when a carrier accepts an offer on the listing. If not specified, the value defaults to the configuration of the marketplace the listing is posted to. If explicitly provided, the supplied value takes precedence.","example":true},"customersExcludedFromOffers":{"type":"array","items":{"type":"string","format":"uuid"},"description":"A collection of customer IDs excluded from offers.","nullable":true,"example":["d5c62b14-cbd1-11ee-9a0e-0242ac110002","157a16f0-503d-4256-ba60-a4876e8eb9bb"]},"digitalOffersEnabled":{"type":"boolean","description":"Indicates whether digital offers are enabled for this Marketplace on this listing. Digital offers functionality is currently only available for select private Marketplaces.","example":true},"marketplaceId":{"type":"integer","description":"The ID of the Central Dispatch Marketplace. There are three types of Marketplaces:\r\n\r\n- **Public**: The public Marketplace ID is `10000`.\r\n- **Test**: Test Marketplace IDs will be provided to you by Central Dispatch.\r\n- **Private**: Private Marketplace IDs will be provided to you by Central Dispatch, if necessary.","format":"int32","example":10000},"offersAutoAcceptEnabled":{"type":"boolean","description":"Allows carrriers to digitially accept an offer. The button will be visible for this Marketplace on this listing. Requires `digitalOffersEnabled` to be true.","example":true},"predispatchNotes":{"type":"string","description":"Provides general preparation instructions for shipments. This should not contain sensitive data as it is made available prior to acceptance of terms by a carrier.\r\nRules: This information will always be visible to carriers, and it will no longer be editable once the load is dispatched.","nullable":true,"example":"In order to pick up the keys you will have to walk through a lot with a big dog that protects it, he's chained but will bark at you."},"searchable":{"type":"boolean","description":"Controls whether the listing appears in Marketplace search results. Allows listings to be posted but not publicly searchable. When `true`: listing is visible and searchable on this Marketplace. When `false`: listing is hidden from Marketplace search.","example":true},"makeOffersEnabled":{"type":"boolean","description":"Allows carriers to make an offer on the listing. The button will be visible for this Marketplace on this listing. Requires `digitalOffersEnabled` to be true.","nullable":true,"example":true}},"description":"Details of the marketplace."},"PriceRequest":{"type":"object","properties":{"total":{"minimum":0.01,"type":"number","description":"The total amount to be paid for completing the dispatch.","format":"double","example":500},"totalCurrency":{"$ref":"#/components/schemas/Currency"},"cod":{"$ref":"#/components/schemas/CodRequest"},"balance":{"$ref":"#/components/schemas/BalanceRequest"}},"description":"Details of the price."},"PriceResponse":{"type":"object","properties":{"total":{"type":"number","description":"The total amount to be paid for completing the dispatch.","format":"double","example":500},"totalCurrency":{"$ref":"#/components/schemas/Currency"},"cod":{"$ref":"#/components/schemas/CodResponse"},"balance":{"$ref":"#/components/schemas/BalanceResponse"}},"description":"Details of the price."},"ShippingSpecsRequest":{"type":"object","properties":{"height":{"type":"number","description":"The height of the vehicle. If the value is not sent it will be completed based on the vehicle information if available.","format":"double","default":0,"nullable":true,"example":58},"width":{"type":"number","description":"The width of the vehicle.","format":"double","default":0,"nullable":true,"example":62},"length":{"type":"number","description":"The length of the vehicle.","format":"double","default":0,"nullable":true,"example":143},"weight":{"type":"number","description":"The weight of the vehicle.","format":"double","default":0,"nullable":true,"example":2246}},"description":"Details of the shipping specifications of a vehicle.","nullable":true},"ShippingSpecsResponse":{"type":"object","properties":{"height":{"type":"integer","description":"The height of the vehicle.","format":"int32","nullable":true,"example":58},"width":{"type":"integer","description":"The width of the vehicle.","format":"int32","nullable":true,"example":62},"length":{"type":"integer","description":"The length of the vehicle.","format":"int32","nullable":true,"example":143},"weight":{"type":"integer","description":"The weight of the vehicle.","format":"int32","nullable":true,"example":2246}},"description":"Details of the shipping specifications of a vehicle."},"SlaRequest":{"type":"object","properties":{"duration":{"type":"string","description":"How many days the customer has to pick up/deliver. The format is ISO 8601 duration format `P{duration in days}D` where the number of days comes from when the listing becomes available. For example, `P2D` means 2 days. This sets the deadline for completing the transport.","example":"P2D"},"timeZoneOffset":{"type":"string","description":"Which time zone to use for SLA calculations. For example, `-5.00` represents Eastern Time and `+0.00` represents UTC/GMT. Can be negative. Acceptable range: -12:00 to +14:00 hours.","default":"00:00:00","nullable":true,"example":"-7:00"},"rolloverTime":{"pattern":"^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$","type":"string","description":"The time of day the \"business day\" ends. For example, 17:30 means 5:30 PM. If the load is accepted after this time and available for immediate pickup, the ability for it to be picked up on the same day is determined by `includeCurrentDayAfterRollOver`.","default":"00:00:00","example":"19:00:00"},"includeCurrentDayAfterRollOver":{"type":"boolean","description":"Indicates whether the load can be picked up after the rollover time if it is available on the same day the load is accepted. This could be do to the pickup location not being open or reachable after the rollover time. Does not apply to listings with availableDate in the future.\r\nExample with 5:30 PM rollover:\r\nWhen true: When accepting the load, the carrier can choose to pick it up after 5:30 PM. Sla duration starts tomorrow and ends on day 3.\r\nWhen false: When accepting the load, the carrier cannot choose to pick it up after 5:30 PM today. It can only be picked up tomorrow as the pickup location has closed at the rollover time. Sla duration starts tomorrow and ends on day 3.","example":true}},"description":"Details of the service level agreement (SLA) for a listing. Only required for listings in marketplaces allowing digital offers. Currently only applicable to private marketplaces."},"SlaResponse":{"type":"object","properties":{"duration":{"type":"string","description":"How many days the customer has to pick up/deliver. The format is ISO 8601 duration format `P{duration in days}D` where the number of days comes from when the listing becomes available. For example, `P2D` means 2 days. This sets the deadline for completing the transport.","example":"P2D"},"timeZoneOffset":{"type":"string","description":"Which time zone to use for SLA calculations. For example, `-5.00` represents Eastern Time and `+0.00` represents UTC/GMT. Can be negative. Acceptable range: -12:00 to +14:00 hours.","example":"-7:00"},"rolloverTime":{"pattern":"^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$","type":"string","description":"The time of day the \"business day\" ends. For example, 17:30 means 5:30 PM. If the load is accepted after this time and available for immediate pickup, the ability for it to be picked up on the same day is determined by `includeCurrentDayAfterRollOver`.","example":"19:00:00"},"includeCurrentDayAfterRollOver":{"type":"boolean","description":"Indicates whether the load can be picked up after the rollover time if it is available on the same day the load is accepted. This could be do to the pickup location not being open or reachable after the rollover time. Does not apply to listings with availableDate in the future.\r\nExample with 5:30 PM rollover:\r\nWhen true: When accepting the load, the carrier can choose to pick it up after 5:30 PM. Sla duration starts tomorrow and ends on day 3.\r\nWhen false: When accepting the load, the carrier cannot choose to pick it up after 5:30 PM today. It can only be picked up tomorrow as the pickup location has closed at the rollover time. Sla duration starts tomorrow and ends on day 3.","example":true}},"description":"Details of the service level agreement (SLA) for a listing."},"Source":{"enum":["API","UI","CSV"],"type":"string","description":"The source of the listing. This list is not exhaustive and additional values may be added at any time.","example":"API"},"StopRequest":{"type":"object","properties":{"stopId":{"type":"string","description":"The system assigned UUID of the stop. Read-only on create (POST). Required on update (PUT).","format":"uuid"},"stopNumber":{"type":"integer","description":"The sequential number of the stop along the route e.g. 1 is the pick up stop and 2 is the delivery stop.","format":"int32","example":1},"locationName":{"maxLength":200,"type":"string","description":"The name of the stop.","nullable":true,"example":"ABC Cars lot"},"address":{"maxLength":100,"type":"string","description":"The street address.","nullable":true,"example":"345 W Elm St."},"address2":{"maxLength":100,"type":"string","description":"Additional street address line.","nullable":true,"example":"2nd Floor"},"city":{"maxLength":50,"type":"string","description":"The city.","example":"Anaheim"},"state":{"type":"string","description":"The state.","example":"CA"},"postalCode":{"maxLength":20,"type":"string","description":"The ZIP code. Must be a valid United States ZIP code or Canadian postal code.","example":"92802"},"country":{"maxLength":2,"type":"string","description":"The country code. US or CA.","nullable":true,"example":"US"},"phone":{"maxLength":50,"type":"string","description":"The primary phone number of the contact.","nullable":true,"example":"949-555-1323"},"phone2":{"maxLength":50,"type":"string","description":"An additional phone number of the contact.","nullable":true,"example":"949-555-2434"},"phone3":{"maxLength":50,"type":"string","description":"An additional phone number of the contact.","nullable":true,"example":"949-555-3545"},"siteId":{"type":"string","description":"The ID of the site.","nullable":true,"example":"ABC"},"contactName":{"maxLength":100,"type":"string","description":"The name of the contact.","nullable":true,"example":"Mickey Smith"},"contactPhone":{"maxLength":50,"type":"string","description":"The primary phone number of the contact.","nullable":true,"example":"949-555-1323"},"contactCellPhone":{"maxLength":50,"type":"string","description":"The cell phone number of the contact.","nullable":true,"example":"949-555-1212"},"buyerNumber":{"maxLength":70,"type":"string","description":"The buyer reference number.","nullable":true,"example":"12345"},"metroArea":{"maxLength":150,"type":"string","description":"The metro area of the stop.","nullable":true,"example":"Orange County"},"twic":{"type":"boolean","description":"Indicates whether the stop requires driver to have a Transportation Worker Identification Credential (TWIC). A TWIC is a credential required by the Maritime Transportation Security Act for carriers to access some locations. If you are not sure if a TWIC is needed, please contact the location.","default":false,"example":true},"geoCode":{"$ref":"#/components/schemas/GeoCodeRequest"},"locationType":{"enum":["Unspecified","AirportRentalCenter","Auction","AuctionSatelliteLot","CommercialBusiness","CorporateOfficePlant","CrossDockSatelliteStagingLot","Dealership","Impound","MarshallingYard","MilitaryBase","MobileAuction","Port","RailYard","ReconFacility","RentalCarRetailSite","Repo","Residence","ServiceCenter","ConsumerMoves","Terminal","Other","MechanicShop","Warehouse","ParkingLot"],"type":"string","description":"The facility type of the stop. This list is not exhaustive and additional values may be added at any time.","default":"Unspecified","nullable":true,"example":"Dealership"},"contactEmailAddress":{"type":"string","description":"The email address of the contact. Must be a valid email address format.","nullable":true,"example":"mickey@snoogle.com"}},"description":"Details of a stop."},"StopResponse":{"type":"object","properties":{"stopId":{"type":"string","description":"The system assigned UUID of the stop.","format":"uuid","example":"4e2efc84-6add-435c-9f12-8b19e3e5ba21"},"stopNumber":{"type":"integer","description":"The sequential number of the stop along the route e.g. 1 is the pick up stop and 2 is the delivery stop.","format":"int32","example":1},"locationName":{"type":"string","description":"The name of the stop.","nullable":true,"example":"ABC Cars lot"},"address":{"type":"string","description":"The street address.","nullable":true,"example":"345 W Elm St."},"address2":{"type":"string","description":"Additional street address line.","nullable":true,"example":"2nd Floor"},"city":{"type":"string","description":"The city.","nullable":true,"example":"Anaheim"},"state":{"type":"string","description":"The state.","nullable":true,"example":"CA"},"postalCode":{"type":"string","description":"The ZIP code. Must be a valid United States ZIP code or Canadian postal code.","nullable":true,"example":"92802"},"country":{"type":"string","description":"The country code. US or CA.","nullable":true,"example":"US"},"distanceToNextStopInMiles":{"type":"integer","description":"The distance to the next stop in miles.","format":"int32","example":267},"phone":{"type":"string","description":"The primary phone number of the contact.","nullable":true,"example":"949-555-1323"},"phone2":{"type":"string","description":"An additional phone number of the contact.","nullable":true,"example":"949-555-2434"},"phone3":{"type":"string","description":"An additional phone number of the contact.","nullable":true,"example":"949-555-3545"},"siteId":{"type":"string","description":"The ID of the site.","nullable":true,"example":"ABC"},"contactName":{"type":"string","description":"The name of the contact.","nullable":true,"example":"Mickey Smith"},"contactPhone":{"type":"string","description":"The primary phone number of the contact.","nullable":true,"example":"949-555-1323"},"contactCellPhone":{"type":"string","description":"The cell phone number of the contact.","nullable":true,"example":"949-555-1212"},"metroArea":{"type":"string","description":"The metro area of the stop.","nullable":true,"example":"Orange County"},"locationType":{"enum":["Unspecified","AirportRentalCenter","Auction","AuctionSatelliteLot","CommercialBusiness","CorporateOfficePlant","CrossDockSatelliteStagingLot","Dealership","Impound","MarshallingYard","MilitaryBase","MobileAuction","Port","RailYard","ReconFacility","RentalCarRetailSite","Repo","Residence","ServiceCenter","ConsumerMoves","Terminal","Other","MechanicShop","Warehouse","ParkingLot"],"type":"string","description":"The facility type of the stop. This list is not exhaustive and additional values may be added at any time.","example":"Dealership"},"geoCode":{"$ref":"#/components/schemas/GeoCodeResponse"},"twic":{"type":"boolean","description":"Indicates whether the stop requires driver to have a Transportation Worker Identification Credential (TWIC). A TWIC is a credential required by the Maritime Transportation Security Act for carriers to access some locations. If you are not sure if a TWIC is needed, please contact the location.","example":true},"contactEmailAddress":{"type":"string","description":"The email address of the contact. Must be a valid email address format.","nullable":true,"example":"mickey@snoogle.com"}},"description":"Details of a stop."},"TagRequest":{"type":"object","properties":{"name":{"maxLength":100,"type":"string","description":"The name of the tag.","nullable":true,"example":"contractedCarrier"},"value":{"maxLength":500,"type":"string","description":"The value of the tag.","nullable":true,"example":"true"}},"description":"Details of a tag."},"TagResponse":{"type":"object","properties":{"name":{"type":"string","description":"The name of the tag.","nullable":true,"example":"contractedCarrier"},"value":{"type":"string","description":"The value of the tag.","nullable":true,"example":"true"}},"description":"Details of a listing tag."},"VehicleAttributeRequest":{"type":"object","properties":{"vehicleAttributeType":{"enum":["DAMAGE","FEATURE"],"type":"string","description":"The value of the vehicle attribute. This list is not exhaustive and additional values may be added at any time.","default":"FEATURE","nullable":true,"example":"DAMAGE"},"vehicleAttributeName":{"enum":["CAB_AND_CHASSIS","CONVERTIBLE","CREW_CAB","DOES_NOT_ROLL","DOES_NOT_RUN","DOES_NOT_STEER","DUAL_REAR_WHEEL","EXTENDED_CAB","EXTENDED_LENGTH","FLAT_BED","FLAT_TIRE","FRAME_DAMAGE","IS_4X2","IS_4X4","LADDER_RACK","LEFT_KIT","LONG_BED","NO_KEYS","NO_TIRES","OTHER_INOP","OTHER_INOP_NOTES","OVERSIZE_TIRES","OVERSIZED_UNIT","RAISED_ROOF","REGULAR_CAB","SHORT_BED","SINGLE_REAR_WHEEL","STANDARD_LENGTH","TOOLBOX","UTILITY_BODY"],"type":"string","description":"The name of the vehicle attribute. This list is not exhaustive and additional values may be added at any time.","default":"OVERSIZED_UNIT","nullable":true,"example":"FLAT_BED"},"value":{"maxLength":200,"type":"string","description":"The value of the vehicle attribute.","nullable":true,"example":"true"}},"description":"Details of a vehicle attribute."},"VehicleAttributeResponse":{"type":"object","properties":{"vehicleAttributeType":{"enum":["DAMAGE","FEATURE"],"type":"string","description":"The value of the vehicle attribute. This list is not exhaustive and additional values may be added at any time.","nullable":true,"example":"DAMAGE"},"vehicleAttributeName":{"enum":["CAB_AND_CHASSIS","CONVERTIBLE","CREW_CAB","DOES_NOT_ROLL","DOES_NOT_RUN","DOES_NOT_STEER","DUAL_REAR_WHEEL","EXTENDED_CAB","EXTENDED_LENGTH","FLAT_BED","FLAT_TIRE","FRAME_DAMAGE","IS_4X2","IS_4X4","LADDER_RACK","LEFT_KIT","LONG_BED","NO_KEYS","NO_TIRES","OTHER_INOP","OTHER_INOP_NOTES","OVERSIZE_TIRES","OVERSIZED_UNIT","RAISED_ROOF","REGULAR_CAB","SHORT_BED","SINGLE_REAR_WHEEL","STANDARD_LENGTH","TOOLBOX","UTILITY_BODY"],"type":"string","description":"The name of the vehicle attribute. This list is not exhaustive and additional values may be added at any time.","nullable":true,"example":"FLAT_BED"},"value":{"type":"string","description":"The value of the vehicle attribute.","nullable":true,"example":"true"}},"description":"Details of a vehicle attribute."},"VehicleCollection":{"type":"object","properties":{"href":{"type":"string","description":"The URL used to query the current collection of the resource.","example":"https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1)"},"items":{"type":"array","items":{"$ref":"#/components/schemas/VehicleResponse"},"description":"A collection of records."},"limit":{"type":"integer","description":"The maximum number of items to be returned in the response.","format":"int32","example":1},"next":{"type":"string","description":"The URL to the next page of the collection, if available.","nullable":true,"example":"https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1)"},"previous":{"type":"string","description":"The URL to the previous page of the collection, if available.","nullable":true,"example":"https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(6,1)"},"first":{"type":"string","description":"The URL to the first page of the collection.","nullable":true,"example":"https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(1,1)"},"count":{"type":"integer","description":"The total count of resources in the collection.","format":"int32","example":23}},"description":"A paginated collection of vehicles."},"VehicleRequest":{"type":"object","properties":{"vehicleId":{"type":"string","description":"The system assigned UUID of the vehicle.\r\n\r\n- **POST (Create)**: Read-only. Do not include a client-supplied value ā€” the system generates this on creation.\r\n- **PUT (Update)**: Required only if you are updating an existing vehicle ā€” supply the `vehicleId` of the vehicle you intend to update. Omit it to add a new vehicle to the listing.\r\n\r\nāš ļø Important: If `vehicleId` is omitted on a PUT request for a vehicle you intended to update, the system cannot match the request to an existing vehicle and will treat it as a new vehicle creation. This will count against your vehicle quota.","format":"uuid"},"externalVehicleId":{"maxLength":50,"type":"string","description":"A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record.","nullable":true,"example":"EXT123456"},"pickupStopNumber":{"type":"integer","description":"The stop number where the vehicle will be picked up.","format":"int32","example":1},"dropoffStopNumber":{"type":"integer","description":"The sequential stop number where the vehicle will be delivered. Must be greater than `pickupStopNumber`.","format":"int32","example":2},"vin":{"maxLength":50,"type":"string","description":"The vehicle identification number (VIN). Required if `year`, `make` and `model` are null.","nullable":true,"example":"KL8CH6SA6NC001234"},"year":{"type":"integer","description":"The 4 digit year of the vehicle. Required if `vin` is null.","format":"int32","example":2022},"make":{"maxLength":50,"type":"string","description":"The manufacturer's make of the vehicle. Required if `vin` is null.","nullable":true,"example":"Chevrolet"},"model":{"maxLength":50,"type":"string","description":"The manufacturer's model of the vehicle. Required if `vin` is null.","nullable":true,"example":"Spark"},"trim":{"maxLength":100,"type":"string","description":"The manufacturer's trim of the vehicle.","nullable":true,"example":"LS"},"vehicleType":{"enum":["ATV","BOAT","CAR","HEAVY_EQUIPMENT","LARGE_YACHT","MOTORCYCLE","OTHER","PICKUP","RV","SUV","TRAVEL_TRAILER","VAN"],"type":"string","description":"The type of vehicle e.g. CAR, PICKUP, SUV. This list is not exhaustive and additional values may be added at any time.","default":"OTHER","nullable":true,"example":"CAR"},"vehicleTypeOther":{"maxLength":100,"type":"string","description":"The description of the vehicle type. Will default to `Other` when null and `vehicleType` is `OTHER`.","nullable":true,"example":"Golf Cart"},"color":{"maxLength":100,"type":"string","description":"The color of the vehicle.","nullable":true,"example":"Red"},"licensePlate":{"maxLength":20,"type":"string","description":"The license plate of the vehicle.","nullable":true,"example":"B314PIE"},"licensePlateState":{"maxLength":2,"type":"string","description":"The two-letter state abbreviation of the vehicle's license plate.","nullable":true,"example":"CA"},"lotNumber":{"maxLength":50,"type":"string","description":"The lot number of the vehicle.","nullable":true,"example":"LOT789"},"isInoperable":{"type":"boolean","description":"Indicates whether the vehicle is inoperable.","default":false,"example":false},"tariff":{"type":"number","description":"The tariff on the vehicle.","format":"double","example":1030.5},"tariffCurrency":{"$ref":"#/components/schemas/Currency"},"additionalInfo":{"maxLength":500,"type":"string","description":"Additional information.","nullable":true,"example":"The vehicle is in the back of the lot behind the big tree."},"oversized":{"type":"boolean","description":"Indicates whether the load is oversized.","default":false,"example":false},"shippingSpecs":{"$ref":"#/components/schemas/ShippingSpecsRequest"},"vehicleAttributes":{"type":"array","items":{"$ref":"#/components/schemas/VehicleAttributeRequest"},"description":"A collection of vehicle attributes.","nullable":true},"noKeys":{"type":"boolean","description":"Indicates whether the vehicle has no keys.","default":false,"example":true},"noTires":{"type":"boolean","description":"Indicates whether the vehicle has no tires.","default":false,"example":false},"flatTire":{"type":"boolean","description":"Indicates whether the vehicle has a flat tire.","default":false,"example":true},"frameDamage":{"type":"boolean","description":"Indicates whether the vehicle has frame damage.","default":false,"example":false},"doesNotRun":{"type":"boolean","description":"Indicates whether the vehicle does not run.","default":false,"example":true},"doesNotSteer":{"type":"boolean","description":"Indicates whether the vehicle does not steer.","default":false,"example":false},"doesNotRoll":{"type":"boolean","description":"Indicates whether the vehicle does not roll.","default":false,"example":false},"inOpNotes":{"maxLength":200,"type":"string","description":"Notes about the inoperable condition of the vehicle.","nullable":true,"example":"Vehicle does not start."}},"description":"Details of a vehicle."},"VehicleResponse":{"type":"object","properties":{"vehicleId":{"type":"string","description":"The ID of the vehicle.","format":"uuid","example":"b331c130-e89b-12d3-a456-426614174000"},"listing":{"type":"string","description":"The fully qualified URL of the listing.","nullable":true,"example":"https://marketplace-api.centraldispatch.com/listings/id/42220470"},"externalVehicleId":{"type":"string","description":"A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record.","nullable":true,"example":"EXT123456"},"pickupStopNumber":{"type":"integer","description":"The stop number where the vehicle will be picked up.","format":"int32","example":1},"dropOffStopNumber":{"type":"integer","description":"The sequential stop number where the vehicle will be delivered.","format":"int32","example":2},"vin":{"type":"string","description":"The vehicle identification number (VIN).","nullable":true,"example":"KL8CH6SA6NC001234"},"year":{"type":"integer","description":"The 4 digit year of the vehicle.","format":"int32","example":2022},"make":{"type":"string","description":"The manufacturer's make of the vehicle.","nullable":true,"example":"Chevrolet"},"model":{"type":"string","description":"The manufacturer's model of the vehicle.","nullable":true,"example":"Spark"},"trim":{"type":"string","description":"The manufacturer's trim of the vehicle.","nullable":true,"example":"LS"},"vehicleType":{"enum":["ATV","BOAT","CAR","HEAVY_EQUIPMENT","LARGE_YACHT","MOTORCYCLE","OTHER","PICKUP","RV","SUV","TRAVEL_TRAILER","VAN"],"type":"string","description":"The type of vehicle e.g. CAR, PICKUP, SUV. This list is not exhaustive and additional values may be added at any time."},"vehicleTypeOther":{"type":"string","description":"The description of the vehicle type.","nullable":true,"example":"CAR"},"color":{"type":"string","description":"The color of the vehicle.","nullable":true,"example":"Red"},"licensePlate":{"type":"string","description":"The license plate of the vehicle.","nullable":true,"example":"B314PIE"},"licensePlateState":{"type":"string","description":"The two-letter state abbreviation of the vehicle's license plate.","nullable":true,"example":"CA"},"lotNumber":{"type":"string","description":"The lot number of the vehicle.","nullable":true,"example":"LOT789"},"isInoperable":{"type":"boolean","description":"Indicates whether the vehicle is inoperable.","example":false},"tariff":{"type":"number","description":"The tariff on the vehicle.","format":"double","example":1030.5},"tariffCurrency":{"$ref":"#/components/schemas/Currency"},"additionalInfo":{"type":"string","description":"Additional information.","nullable":true,"example":"The vehicle is in the back of the lot behind the big tree."},"oversized":{"type":"boolean","description":"Indicates whether the load is oversized.","example":false},"shippingSpecs":{"$ref":"#/components/schemas/ShippingSpecsResponse"},"vehicleAttributes":{"type":"array","items":{"$ref":"#/components/schemas/VehicleAttributeResponse"},"description":"A collection of vehicle attributes.","nullable":true},"noKeys":{"type":"boolean","description":"Indicates whether the vehicle has no keys.","example":true},"noTires":{"type":"boolean","description":"Indicates whether the vehicle has no tires.","example":false},"flatTire":{"type":"boolean","description":"Indicates whether the vehicle has a flat tire.","example":true},"frameDamage":{"type":"boolean","description":"Indicates whether the vehicle has frame damage.","example":false},"doesNotRun":{"type":"boolean","description":"Indicates whether the vehicle does not run.","example":true},"doesNotSteer":{"type":"boolean","description":"Indicates whether the vehicle does not steer.","example":false},"doesNotRoll":{"type":"boolean","description":"Indicates whether the vehicle does not roll.","example":false},"inOpNotes":{"type":"string","description":"Notes about the inoperable condition of the vehicle.","nullable":true,"example":"Vehicle does not start."}},"description":"Details of a vehicle."}},"securitySchemes":{"Bearer":{"type":"http","scheme":"Bearer"}}},"tags":[{"name":"Listings"},{"name":"Draft-Listings"},{"name":"Listing-Vehicles"}]} ````