Sign in

v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Batch Job

Update Job by JobID/ExternalIdentifier and Job Configuration ID

Update a specific package within a batch job. Use the job configuration ID to target a particular package's details.

patch/v1/jobs/{id}/{jobConfigurationId}

Path parameters

idstring nullable required

Job ID or External Identifier

Job ID or External Identifier

jobConfigurationIdstring nullable required

Job Configuration ID (for updating a package in a batch job)

Job Configuration ID (for updating a package in a batch job)

Request body

pickupAddressstring nullable

Pickup address

pickupPhoneNumberstring nullable

Pickup phone number

pickupBusinessNamestring nullable

Pickup business name

pickupFirstNamestring nullable

Pickup first name

pickupLastNamestring nullable

Pickup last name

pickupEmailstring nullable

Pickup email

pickupInstructionsstring nullable

Pickup instructions

pickupStoreLocationIdstring nullable

Pickup store location ID

pickupBarcodesstring[] nullable
dropoffAddressstring nullable

Dropoff address

dropoffPhoneNumberstring nullable

Dropoff phone number

dropoffBusinessNamestring nullable

Dropoff business name

dropoffFirstNamestring nullable

Dropoff first name

dropoffLastNamestring nullable

Dropoff last name

dropoffEmailstring nullable

Dropoff email

dropoffStoreLocationIdstring nullable

Dropoff store location ID

dropoffInstructionsstring nullable

Dropoff instructions

dropoffBarcodesstring[] nullable
packageDeliveryModestring nullable

Package delivery mode

packagePickupStartTimestring nullable

Package pickup start time

packagePickupEndTimestring nullable

Package pickup end time

packageDropoffStartTimestring nullable

Package dropoff start time

packageDropoffEndTimestring nullable

Package dropoff end time

packageDescriptionstring nullable

Package description

packageMinimumVehicleSize'any' | 'bike' | 'motorbike' | 'cargobike' | 'sedan' | 'car' | 'suv' | 'pickup_truck' | 'pickup' | 'van' | 'large_van' | 'extra_large_van' | 'truck' nullable

Minimum vehicle size required for the package. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']

packageValuenumber nullable

Package value

packageTaxnumber nullable

Package tax

tipAmountnumber nullable

Tip amount

currencystring nullable

Currency

packageItemsobject[] nullable

List of items in the package

referenceIdstring nullable

Reference ID

itemsCountinteger nullable

Items count

externalIdentifierstring nullable

External identifier for the job

jobMetadataobject nullable

Job metadata

packageMetadataobject nullable

Package metadata

Example request

{
  "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
  },
  "packageRequirements": [
    "photo_proof_of_delivery",
    "age_verification_on_delivery"
  ],
  "packageMinimumVehicleSize": "car"
}

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.