Sign in

v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Batch Job

Create Batch Job

Create a batch job containing multiple packages for multi-stop delivery. Each package has its own pickup and dropoff locations within a single job.

post/v1/batch_job

Request body

jobMetadataobject nullable
optionsGroupIdstring nullable
externalIdentifierstring nullable
inputDatetimesLocalizedToPickupTzboolean

Example request

{
  "packages": [
    {
      "pickupAddressComponents": {
        "number": "1600",
        "street": "Pennsylvania Avenue NW",
        "county": "Washington",
        "city": "Washington",
        "state": "DC",
        "postalCode": "20500",
        "country": "US",
        "latitude": 38.8948949,
        "longitude": -77.0371581
      },
      "dropoffAddressComponents": {
        "number": "1600",
        "street": "Pennsylvania Avenue NW",
        "county": "Washington",
        "city": "Washington",
        "state": "DC",
        "postalCode": "20500",
        "country": "US",
        "latitude": 38.8948949,
        "longitude": -77.0371581
      },
      "packageMinimumVehicleSize": "car",
      "packageRequirements": [
        "photo_proof_of_delivery",
        "age_verification_on_delivery"
      ]
    }
  ]
}

Response

OK

idstring required

Job ID

createdAtstring required

Created at

portalUrlstring required

Portal URL

externalIdentifierstring nullable

External identifier

jobMetadataobject nullable

Job metadata

isActiveboolean required

Is the job active

isBatchboolean required

Is the job a batch

shortReferenceCodestring nullable

Short, non-unique human-readable reference code for the job.