Skip to main content

Shipment

The details of a shipment

iduuid

the unique id for the shipment

Example: 59558b3b-d478-4893-a9c1-2bae97440b70
numberstring

the unique identifier for the shipment

Example: CL999999
statusstring

the status of the shipment

Possible values: [new, posted, assigned, picked_up, delivered, hold, canceled]

Example: new
priceinteger

the cost of the shipment

Example: 100
customer object

information associated with the customer of the shipment

customer_nameCustomerName (string)required

Name of the customer, can be a dealership name, business name or a person's name"

Example: Basic Enterprise, LLC
customer_typeLocationType (string)

The type of business associated with the address

Possible values: [AUCTION, BUSINESS, DEALER, PRIVATE, REPO_YARD, PORT]

Example: DEALER
addressCustomerAddress (string)

The street address of the customer

Example: 123 Test Dr
cityCustomerCity (string)

The city for the customer address

Example: Dallas
stateCustomerState (string)

the state for the customer address

Example: TX
zipcodeCustomerZipcode (integer)

The zipcode for the customer address

Example: 75234
emailContactEmail (string)

Email address of the person to contact

Example: jsmith@domain.com
phoneContactPhone (string)

Phone number of the person to contact

Example: 2145550000
contact_nameContactName (string)

Name of the person to contact

Example: John Smith
contact_emailContactEmail (string)

Email address of the person to contact

Example: jsmith@domain.com
contact_phoneContactPhone (string)

Phone number of the person to contact

Example: 2145550000
pickup object

details of the delivery location

location_nameLocationName (string)

name of the location for the order pickup

Example: Pickup Here, LLC
location_typeLocationType (string)

The type of business associated with the address

Possible values: [AUCTION, BUSINESS, DEALER, PRIVATE, REPO_YARD, PORT]

Example: DEALER
addressPickupAddress (string)

The street address of the pickup location

Example: 123 Test Dr
cityPickupCity (string)

The city of the pickup location

Example: Dallas
statePickupState (string)

the state of the pickup location

Example: TX
zipcodePickupZipcode (integer)

The zipcode of the pickup location

Example: 75234
contact_nameContactName (string)

Name of the person to contact

Example: John Smith
contact_emailContactEmail (string)

Email address of the person to contact

Example: jsmith@domain.com
contact_phoneContactPhone (string)

Phone number of the person to contact

Example: 2145550000
notesPickupNotes (string)

Any notes or instructions related to the pickup

Example: Add any notes or instructions here
available_pickup_dttmDate

The date the shipment is available for pickup

Example: 2024-08-10T08:00:00-0500
scheduled_pickup_dttmdate

The scheduled pickup date

Example: 2024-08-10T08:00:00.000+0000
scheduled_pickup_dttm_enddatenullable

The end of the scheduled pickup date range

Example: 2024-08-10T08:00:00.000+0000
pickup_dttmDate

The date the shipment is available for pickup

Example: 2024-08-10T08:00:00-0500
delivery object

details of the delivery location

location_nameLocationName (string)

name of the location for the order pickup

Example: Pickup Here, LLC
location_typeLocationType (string)

The type of business associated with the address

Possible values: [AUCTION, BUSINESS, DEALER, PRIVATE, REPO_YARD, PORT]

Example: DEALER
addressDeliveryAddress (string)required

The street address of the delivery location

Example: 123 Test Dr
cityDeliveryCity (string)required

The city of the delivery location

Example: Dallas
stateDeliveryState (string)required

the state of the delivery location

Example: TX
zipcodeDeliveryZipcode (integer)required

The zipcode of the delivery location

Example: 75234
contact_nameContactName (string)required

Name of the person to contact

Example: John Smith
contact_emailContactEmail (string)required

Email address of the person to contact

Example: jsmith@domain.com
contact_phoneContactPhone (string)required

Phone number of the person to contact

Example: 2145550000
notesDeliveryNotes (string)

Any notes or instructions related to the delivery

Example: Add any notes or instructions here
preferred_delivery_dttmDate

The date you would like the shipment to be delivered

Example: 2024-08-18T08:00:00-0500
scheduled_delivery_dttmDate

The date you would like the shipment to be delivered

Example: 2024-08-18T08:00:00-0500
scheduled_delivery_dttm_endDate

The date you would like the shipment to be delivered

Example: 2024-08-18T08:00:00-0500
delivery_dttmDate

The date you would like the shipment to be delivered

Example: 2024-08-18T08:00:00-0500
vehicles object[]

An array of vehicle objects included in this shipment

  • Array [
    • iduuid

    the unique identifier for the vehicle

    Example: ee6a7af7-650d-499b-8e32-58a52ffdb7bc
    vinstring

    Vehicle Identification Number

    Example: 1G8AL52F03Z157046
    yearinteger

    Production year of the vehicle

    Example: 2020
    makestring

    Manufacturer of the vehicle

    Example: Dodge
    modelstring

    The model of the vehicle produced bt the manufacturer

    Example: RAM ProMaster
    trimstring

    The specific trim level of this vehicle model

    Example: Cargo Van
    typeVehicleType (string)

    The type of vehicle for this shipment

    Possible values: [car, suv, van, truck, truck_ext, work_van, service_body]

    Example: van
    is_modifiedboolean

    A flag determining if the vehicle has modifications

    Example: false
    is_inoperableboolean

    A flag determining if the vehicle is in operable

    Example: false
    notesstring

    Notes about any modifications, issues or warnings about the vehicle

    Example: Vehicle is rusting underneath
    weightnumber

    The curb weight of the vehicle in lbs

    Example: 6600
    heightnumber

    the height of the vehicle

    Example: 72.3
    widthnumber

    the width of the vehicle

    Example: 64.5
    lengthnumber

    the length of the vehicle

    Example: 90.8
    photos object[]

    An arroy of vehicle photos

  • Array [
    • iduuid

    A unique identifier for the photo

    Example: 74c1f768-b78a-497e-916b-8fb62be13ef2
    typestring

    defines the type of photo based on how it was added

    Possible values: [sample, pickup, delivery]

    Example: pickup
    urlurl

    the download url for the photo

    Example: https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae.png
    latitudenumber

    the latitude of the photo when it was taken (only if taken by the carrier)

    Example: 32.9248531
    longitudenumber

    the longitude of the photo when it was taken (only if taken by tge carrier)

    Example: -96.8881391
    created_dttmdate

    the date time the photo was created

    Example: 2024-08-10T08:00:00.000+0000
  • ]
  • ]
    • distancenumber
    Example: 993.09
    distance_metersnumber
    Example: 1598223
    transport_typeTransportType (string)

    The type of transportation needed for this shipment

    Possible values: [open, enclosed]

    Example: enclosed
    instructionsShipmentInstructions (string)

    Instructions for this shipment

    Example: Specify any instructions specific to this shipment
    documents object[]

    array of documents linked to the shipment

  • Array [
    • iduuid

    The unique identifier of the document

    Example: ee6a7af7-650d-499b-8e32-58a52ffdb7bc
    typestring

    The type of the document for this shipment

    Possible values: [dispatch_sheet, bol, delivry_reciept]

    Example: bol
    urlstring

    The URL of the document

    Example: "https://storage.googleapis.com/.../dispatch-sheet.pdf"
  • ]
    • external_idstring

    An external identifier for your own records

    Example: 123e4567-e89b-12d3-a456-426614174000
    Shipment
    {
      "id": "59558b3b-d478-4893-a9c1-2bae97440b70",
      "number": "CL999999",
      "status": "new",
      "price": 100,
      "customer": {
        "customer_name": "Basic Enterprise, LLC",
        "customer_type": "DEALER",
        "address": "123 Test Dr",
        "city": "Dallas",
        "state": "TX",
        "zipcode": 75234,
        "email": "jsmith@domain.com",
        "phone": "2145550000",
        "contact_name": "John Smith",
        "contact_email": "jsmith@domain.com",
        "contact_phone": "2145550000"
      },
      "pickup": {
        "location_name": "Pickup Here, LLC",
        "location_type": "DEALER",
        "address": "123 Test Dr",
        "city": "Dallas",
        "state": "TX",
        "zipcode": 75234,
        "contact_name": "John Smith",
        "contact_email": "jsmith@domain.com",
        "contact_phone": "2145550000",
        "notes": "Add any notes or instructions here",
        "available_pickup_dttm": "2024-08-10T08:00:00-0500",
        "scheduled_pickup_dttm": "2024-08-10T08:00:00.000+0000",
        "scheduled_pickup_dttm_end": "2024-08-10T08:00:00.000+0000",
        "pickup_dttm": "2024-08-10T08:00:00-0500"
      },
      "delivery": {
        "location_name": "Pickup Here, LLC",
        "location_type": "DEALER",
        "address": "123 Test Dr",
        "city": "Dallas",
        "state": "TX",
        "zipcode": 75234,
        "contact_name": "John Smith",
        "contact_email": "jsmith@domain.com",
        "contact_phone": "2145550000",
        "notes": "Add any notes or instructions here",
        "preferred_delivery_dttm": "2024-08-18T08:00:00-0500",
        "scheduled_delivery_dttm": "2024-08-18T08:00:00-0500",
        "scheduled_delivery_dttm_end": "2024-08-18T08:00:00-0500",
        "delivery_dttm": "2024-08-18T08:00:00-0500"
      },
      "vehicles": [
        {
          "id": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
          "vin": "1G8AL52F03Z157046",
          "year": 2020,
          "make": "Dodge",
          "model": "RAM ProMaster",
          "trim": "Cargo Van",
          "type": "van",
          "is_modified": false,
          "is_inoperable": false,
          "notes": "Vehicle is rusting underneath",
          "weight": 6600,
          "height": 72.3,
          "width": 64.5,
          "length": 90.8,
          "photos": [
            {
              "id": "74c1f768-b78a-497e-916b-8fb62be13ef2",
              "type": "pickup",
              "url": "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae.png",
              "latitude": 32.9248531,
              "longitude": -96.8881391,
              "created_dttm": "2024-08-10T08:00:00.000+0000"
            }
          ]
        }
      ],
      "distance": 993.09,
      "distance_meters": 1598223,
      "transport_type": "enclosed",
      "instructions": "Specify any instructions specific to this shipment",
      "documents": [
        {
          "id": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
          "type": "bol",
          "url": "\"https://storage.googleapis.com/.../dispatch-sheet.pdf\""
        }
      ],
      "external_id": "123e4567-e89b-12d3-a456-426614174000"
    }