/postings/{id}/

put

https://ship.cars/api/postings/{id}/

Updates an identified loadboard posting.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Unique ID of the posting (same as the uniqie ID of the load).

Body Params

vehicles

array of objects

List of vehicles in the load.

vehicles

posting

object

Details of the loadboard posting. Available only when the load is posted on the loadboard.

terms_and_conditions

string

pickup_requested_times

string

length ≤ 256

Requested time window during the day for the pickup.

pickup_name

string

length ≤ 256

Name of the pickup contact company.

pickup_contact

string

length ≤ 256

Name of the pickup contact person.

pickup_address

string

length ≤ 1024

Street name and number from the pickup location address.

pickup_city

string

length ≤ 256

City name from the pickup location address.

pickup_state

string

enum

Abbreviation of the state from the pickup location address.

pickup_zip

string

length ≤ 10

Zip code from the pickup location address.

pickup_phone_1

string

length ≤ 20

First contact number of the pickup contact.

pickup_phone_1_notes

string

length ≤ 256

Additional notes about the first contact number of the pickup contact.

pickup_phone_1_type

string

enum

Type of the first contact number of the pickup contact.

Allowed:

pickup_phone_2

string

length ≤ 20

Second contact number of the pickup contact.

pickup_phone_2_notes

string

length ≤ 256

Additional notes about the second contact number of the pickup contact.

pickup_phone_2_type

string

enum

Type of the second contact number of the pickup contact.

Allowed:

pickup_phone_3

string

length ≤ 20

Third contact number of the pickup contact.

pickup_phone_3_notes

string

length ≤ 256

Additional notes about the third contact number of the pickup contact.

pickup_phone_3_type

string

enum

Type of the third contact number of the pickup contact.

Allowed:

pickup_date

date-time

Date of the actual pickup of the load at the origin location.

pickup_no_damages

boolean

Indicates whether the load is picked up without noting any damages to the vehicles.

pickup_notes

string

Driver's additional notes at the time of pickup.

pickup_customer_not_present

boolean

Indicates whether a contact person is not expected at the time of pickup.

pickup_estimate_type

string

enum

Type of the estimated pickup date specified by the carrier in a booking offer.

Allowed:

pickup_estimate_date

date

Estimated pickup date specified by the carrier in a booking offer.

pickup_estimate_end_type

string

enum

Type of the last date of the estimated pickup window specified by the carrier in a booking offer.

Allowed:

pickup_estimate_end_date

date

Last date of the estimated pickup window specified by the carrier in a booking offer.

pickup_requested_date_start

date

First date of the requested pickup window for a load posted on the loadboard.

pickup_requested_date_start_type

string

enum

Type of the first date of the requested pickup window for a load posted on the loadboard.

Allowed:

pickup_requested_date_end

date

Last date of the requested pickup window for a load posted on the loadboard.

pickup_requested_date_end_type

string

enum

Type of the last date of the requested pickup window for a load posted on the loadboard.

Allowed:

pickup_contract_date_start

date

First date of the contract pickup window.

pickup_contract_date_start_type

string

enum

Type of the first date of the contract pickup window.

Allowed:

pickup_contract_date_end

date

Last date of the contract pickup window.

pickup_contract_date_end_type

string

enum

Type of the last date of the contract pickup window.

Allowed:

delivery_requested_times

string

length ≤ 256

Requested time window during the day for the delivery.

delivery_name

string

length ≤ 256

Name of the delivery contact company.

delivery_contact

string

length ≤ 256

Name of the delivery contact person.

delivery_address

string

length ≤ 1024

Street name and number from the delivery location address.

delivery_city

string

length ≤ 256

City name from the delivery location address.

delivery_state

string

enum

Abbreviation of the state from the delivery location address.

delivery_zip

string

length ≤ 10

Zip code from the delivery location address.

delivery_phone_1

string

length ≤ 20

First contact number of the delivery contact.

delivery_phone_1_notes

string

length ≤ 256

Additional notes about the first contact number of the delivery contact.

delivery_phone_1_type

string

enum

Type of the first contact number of the delivery contact.

Allowed:

delivery_phone_2

string

length ≤ 20

Second contact number of the delivery contact.

delivery_phone_2_notes

string

length ≤ 256

Additional notes about the second contact number of the delivery contact.

delivery_phone_2_type

string

enum

Type of the second contact number of the delivery contact.

Allowed:

delivery_phone_3

string

length ≤ 20

Third contact number of the delivery contact.

delivery_phone_3_notes

string

length ≤ 256

Additional notes about the third contact number of the delivery contact.

delivery_phone_3_type

string

enum

Type of the third contact number of the delivery contact.

Allowed:

delivery_date

date-time

Date of the actual delivery of the load at the destination location.

delivery_notes

string

Driver's additional notes at the time of delivery.

delivery_customer_not_present

boolean

Indicates whether a contact person is not expected at the time of delivery.

delivery_no_damages

boolean

Indicates whether the load is delivered without noting any damages to the vehicles.

delivery_estimate_type

string

enum

Type of the estimated delivery date specified by the carrier in a booking offer.

Allowed:

delivery_estimate_date

date

Estimated delivery date specified by the carrier in a booking offer.

delivery_estimate_end_type

string

enum

Type of the last date of the estimated delivery window specified by the carrier in a booking offer.

Allowed:

delivery_estimate_end_date

date

Last date of the estimated delivery window specified by the carrier in a booking offer.

delivery_requested_date_start

date

First date of the requested delivery window for a load posted on the loadboard.

delivery_requested_date_start_type

string

enum

Type of the first date of the requested delivery window for a load posted on the loadboard.

Allowed:

delivery_requested_date_end

date

Last date of the requested delivery window for a load posted on the loadboard.

delivery_requested_date_end_type

string

enum

Type of the last date of the requested delivery window for a load posted on the loadboard.

Allowed:

delivery_contract_date_start

date

First date of the contract delivery window.

delivery_contract_date_start_type

string

enum

Type of the first date of the contract delivery window.

Allowed:

delivery_contract_date_end

date

Last date of the contract delivery window.

delivery_contract_date_end_type

string

enum

Type of the last date of the contract delivery window.

Allowed:

transit_time_estimated_min

integer

0 to 32767

Minimum number of transit days for the load calculated as the difference between the last date of the estimated pickup window and the first date of the estimated delivery window.

transit_time_estimated_max

integer

0 to 32767

Maximum number of transit days for the load calculated as the difference between the first date of the estimated pickup window and the last date of the estimated delivery window.

payment_on_pickup

string

Payment amount due to the carrier on pickup.

payment_on_pickup_method

string

enum

Payment method for the amount due to the carrier on pickup.

Allowed:

payment_on_delivery

string

Payment amount due to the carrier on delivery.

payment_on_delivery_method

string

enum

Payment method for the amount due to the carrier on delivery.

Allowed:

total_payment_to_carrier

string

Total payment amount due to the carrier for the load.

payment_term_business_days

integer

0 to 32767

Duration of the payment term period (in business days).

payment_term_begins

string

enum

Event in the load processing flow when the payment term period begins.

Allowed:

payment_method

string

enum

Billing payment method for the load.

Allowed:

payment_notes

string

Additional notes about the payment.

customer_name

string

length ≤ 256

Name of the shipper company that created the load.

customer_contact

string

length ≤ 256

Full name of the primary contact for the load at the shipper company.

customer_address

string

length ≤ 1024

Street name and number from the registered address of the shipper company.

customer_city

string

length ≤ 256

City name from the registered address of the shipper company.

customer_state

string

enum

Abbreviation of the state from the registered address of the shipper company.

customer_zip

string

length ≤ 10

Zip code from the registered address of the shipper company.

customer_email

string

length ≤ 64

Contact email address of the shipper company.

customer_phone_1

string

length ≤ 20

First contact number of the shipper company.

customer_phone_1_notes

string

length ≤ 256

Additional notes about the first contact number of the shipper company.

customer_phone_1_type

string

enum

Type of the first contact number of the shipper company.

Allowed:

customer_phone_2

string

length ≤ 20

Second contact number of the shipper company.

customer_phone_2_notes

string

length ≤ 256

Additional notes about the second contact number of the shipper company.

customer_phone_2_type

string

enum

Type of the second contact number of the shipper company.

Allowed:

customer_phone_3

string

length ≤ 20

Third contact number of the shipper company.

customer_phone_3_notes

string

length ≤ 256

Additional notes about the third contact number of the shipper company.

customer_phone_3_type

string

enum

Type of the third contact number of the shipper company.

Allowed:

labels

array of strings

List of labels set to the load.

labels

can_be_booked

boolean

Defaults to false

Indicates whether the Instant booking option is enabled for the load.

uship_code

string

length ≤ 32

uShip code used for the load.

shipper_load_id

string

length ≤ 256

Shipper's unique ID of the load.

instructions

string

length ≤ 16000

Shipper's dispatch instructions for the load. These are visible to carriers on the loadboard or before they accept the dispatched load.

specific_load_requirements

string

length ≤ 4096

Shipper's instructions and requirements for the load. These are visible to carriers only after they accept the dispatched load.

driver_instructions

string

length ≤ 4096

Carrier's instructions to the driver.

first_available_date

date

First date on which the load is available for picking up.

enclosed_trailer

boolean

Defaults to false

Indicates whether the shipper requires the load to be transported with an enclosed car carrier trailer.

damages_type

string

enum

Defaults to standard

Type of damage standard used for vehicles in the load.

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

401Unauthorized

403Forbidden

404Not Found