Get Job by External Identifier

createdAt

string

required

Created at

id

string

required

Job ID

isActive

boolean

required

Is the job active

isBatch

boolean

required

Is the job a batch

jobConfigurations

object[]

required

Job configurations

jobConfigurations.id

string

required

Job Configuration ID

jobConfigurations.package

object

required

Package

jobConfigurations.package.dropoffLocation

object

required

Generic serializer for location used in many endpoints.

jobConfigurations.package.id

string

required

Package ID

jobConfigurations.package.itemsCount

required

Items count

jobConfigurations.package.pickupLocation

object

required

Generic serializer for location used in many endpoints.

jobConfigurations.package.requirements

string[]

required

Requirements

jobConfigurations.package.valueCents

integer

required

jobConfigurations.package.description

string | null

Description

jobConfigurations.package.dimensions

object | null

Dimensions

jobConfigurations.package.drivingMetrics

object | null

Driving metrics (distance in meters, duration in seconds)

jobConfigurations.package.dropoffBarcodes

string[] | null

jobConfigurations.package.dropoffEndTime

string | null

Dropoff end time

jobConfigurations.package.dropoffStartTime

string | null

Dropoff start time

jobConfigurations.package.dropoffStoreLocationId

string | null

Dropoff store location ID

jobConfigurations.package.externalIdentifier

string | null

External identifier

jobConfigurations.package.items

object[] | null

Items

jobConfigurations.package.minimumVehicleSize

string | null

Minimum vehicle size

jobConfigurations.package.packageDeliveryMode

string | null

Package delivery mode

jobConfigurations.package.packageMetadata

object | null

Package metadata

jobConfigurations.package.pickupBarcodes

string[] | null

jobConfigurations.package.pickupEndTime

string | null

Pickup end time

jobConfigurations.package.pickupStartTime

string | null

Pickup start time

jobConfigurations.package.pickupStoreLocationId

string | null

Pickup store location ID

jobConfigurations.package.referenceId

string | null

Reference ID

jobConfigurations.package.serviceFee

Service fee

jobConfigurations.package.serviceFeeCents

integer | null

Service fee in cents

jobConfigurations.package.tags

string[] | null

Tags

jobConfigurations.package.tax

Tax

jobConfigurations.package.taxCents

integer | null

Tax in cents

jobConfigurations.package.tipAmountCents

integer | null

jobConfigurations.package.value

number | null

Value

jobConfigurations.package.weight

Weight

jobConfigurations.tasks

object[]

required

Tasks

jobConfigurations.tasks.createdAt

string

required

Created at

jobConfigurations.tasks.id

string

required

Task ID

jobConfigurations.tasks.status

string

required

Status

jobConfigurations.tasks.delivery

object | null

Delivery object

jobConfigurations.tasks.delivery.currency

string

required

Currency

jobConfigurations.tasks.delivery.id

string

required

Delivery ID

jobConfigurations.tasks.delivery.isActive

boolean

required

Is the delivery active

jobConfigurations.tasks.delivery.priceCents

integer

required

Price in cents

jobConfigurations.tasks.delivery.status

string

required

Delivery status

jobConfigurations.tasks.delivery.cancellationFeeCents

integer | null

Cancellation fee in cents

jobConfigurations.tasks.delivery.courierDropoffPhoneNumber

string | null

Courier dropoff phone number

jobConfigurations.tasks.delivery.courierLocation

object | null

Courier location

jobConfigurations.tasks.delivery.courierName

string | null

Courier name

jobConfigurations.tasks.delivery.courierPhoneNumber

string | null

Courier phone number

jobConfigurations.tasks.delivery.courierPickupPhoneNumber

string | null

Courier pickup phone number

jobConfigurations.tasks.delivery.courierProfileImage

string | null

Courier profile image

jobConfigurations.tasks.delivery.courierVehicle

object | null

Courier vehicle

jobConfigurations.tasks.delivery.documents

object[] | null

Documents

jobConfigurations.tasks.delivery.dropoffDeadline

string | null

Dropoff deadline

jobConfigurations.tasks.delivery.dropoffEta

string | null

Dropoff ETA

jobConfigurations.tasks.delivery.insuranceFeeCents

integer | null

Insurance fee in cents

jobConfigurations.tasks.delivery.nashFeeCents

integer | null

Nash fee in cents

jobConfigurations.tasks.delivery.otherProviderFees

object | null

Other provider fees

jobConfigurations.tasks.delivery.pickupEta

string | null

Pickup ETA

jobConfigurations.tasks.delivery.price

number | null

Price

jobConfigurations.tasks.delivery.proofOfDelivery

object[] | null

Proof of delivery

jobConfigurations.tasks.delivery.providerBatchId

string | null

Provider batch id

jobConfigurations.tasks.delivery.providerDeliveryId

string | null

Provider delivery id

jobConfigurations.tasks.delivery.returnFeeCents

integer | null

Return fee in cents

jobConfigurations.tasks.delivery.statusHistory

object[] | null

Delivery status history

jobConfigurations.tasks.delivery.taxAmountCents

integer | null

Tax amount in cents

jobConfigurations.tasks.delivery.tollFeeCents

integer | null

Toll fee in cents

jobConfigurations.tasks.delivery.totalPriceBreakdown

object | null

Total price breakdown

jobConfigurations.tasks.delivery.totalPriceCents

integer | null

Total price in cents

jobConfigurations.tasks.delivery.type

string | null

jobConfigurations.tasks.delivery.waitFeeCents

integer | null

Wait fee in cents

jobConfigurations.tasks.delivery.waitTimeMinutes

integer | null

Wait time in minutes

jobConfigurations.tasks.dropoffEndTime

string | null

Dropoff end time

jobConfigurations.tasks.dropoffStartTime

string | null

Dropoff start time

jobConfigurations.tasks.failedQuotes

object[] | null

Failed quotes

jobConfigurations.tasks.failureReason

string | null

Failure reason

jobConfigurations.tasks.pickupEndTime

string | null

Pickup end time

jobConfigurations.tasks.pickupStartTime

string | null

Pickup start time

jobConfigurations.tasks.providerId

string | null

Provider ID

jobConfigurations.tasks.providerIsInternal

boolean | null

Provider is internal

jobConfigurations.tasks.quotes

object[] | null

Quotes

jobConfigurations.tasks.taskNotes

object[] | null

Task notes

jobConfigurations.tasks.tipAmountCents

integer | null

Tip amount in cents

jobConfigurations.tasks.tipAmountUsd

number | null

Tip amount in USD

jobConfigurations.tasks.winnerQuote

object | null

Winner quote

jobConfigurations.advancedTask

object | null

Advanced task

jobConfigurations.advancedTask.createdAt

string

required

Created at

jobConfigurations.advancedTask.id

string

required

Task ID

jobConfigurations.advancedTask.status

string

required

Status

jobConfigurations.advancedTask.delivery

object | null

Delivery object

jobConfigurations.advancedTask.delivery.currency

string

required

Currency

jobConfigurations.advancedTask.delivery.id

string

required

Delivery ID

jobConfigurations.advancedTask.delivery.isActive

boolean

required

Is the delivery active

jobConfigurations.advancedTask.delivery.priceCents

integer

required

Price in cents

jobConfigurations.advancedTask.delivery.status

string

required

Delivery status

jobConfigurations.advancedTask.delivery.cancellationFeeCents

integer | null

Cancellation fee in cents

jobConfigurations.advancedTask.delivery.courierDropoffPhoneNumber

string | null

Courier dropoff phone number

jobConfigurations.advancedTask.delivery.courierLocation

object | null

Courier location

jobConfigurations.advancedTask.delivery.courierName

string | null

Courier name

jobConfigurations.advancedTask.delivery.courierPhoneNumber

string | null

Courier phone number

jobConfigurations.advancedTask.delivery.courierPickupPhoneNumber

string | null

Courier pickup phone number

jobConfigurations.advancedTask.delivery.courierProfileImage

string | null

Courier profile image

jobConfigurations.advancedTask.delivery.courierVehicle

object | null

Courier vehicle

jobConfigurations.advancedTask.delivery.documents

object[] | null

Documents

jobConfigurations.advancedTask.delivery.dropoffDeadline

string | null

Dropoff deadline

jobConfigurations.advancedTask.delivery.dropoffEta

string | null

Dropoff ETA

jobConfigurations.advancedTask.delivery.insuranceFeeCents

integer | null

Insurance fee in cents

jobConfigurations.advancedTask.delivery.nashFeeCents

integer | null

Nash fee in cents

jobConfigurations.advancedTask.delivery.otherProviderFees

object | null

Other provider fees

jobConfigurations.advancedTask.delivery.pickupEta

string | null

Pickup ETA

jobConfigurations.advancedTask.delivery.price

number | null

Price

jobConfigurations.advancedTask.delivery.proofOfDelivery

object[] | null

Proof of delivery

jobConfigurations.advancedTask.delivery.providerBatchId

string | null

Provider batch id

jobConfigurations.advancedTask.delivery.providerDeliveryId

string | null

Provider delivery id

jobConfigurations.advancedTask.delivery.returnFeeCents

integer | null

Return fee in cents

jobConfigurations.advancedTask.delivery.statusHistory

object[] | null

Delivery status history

jobConfigurations.advancedTask.delivery.taxAmountCents

integer | null

Tax amount in cents

jobConfigurations.advancedTask.delivery.tollFeeCents

integer | null

Toll fee in cents

jobConfigurations.advancedTask.delivery.totalPriceBreakdown

object | null

Total price breakdown

jobConfigurations.advancedTask.delivery.totalPriceCents

integer | null

Total price in cents

jobConfigurations.advancedTask.delivery.type

string | null

jobConfigurations.advancedTask.delivery.waitFeeCents

integer | null

Wait fee in cents

jobConfigurations.advancedTask.delivery.waitTimeMinutes

integer | null

Wait time in minutes

jobConfigurations.advancedTask.dropoffEndTime

string | null

Dropoff end time

jobConfigurations.advancedTask.dropoffStartTime

string | null

Dropoff start time

jobConfigurations.advancedTask.failedQuotes

object[] | null

Failed quotes

jobConfigurations.advancedTask.failureReason

string | null

Failure reason

jobConfigurations.advancedTask.pickupEndTime

string | null

Pickup end time

jobConfigurations.advancedTask.pickupStartTime

string | null

Pickup start time

jobConfigurations.advancedTask.providerId

string | null

Provider ID

jobConfigurations.advancedTask.providerIsInternal

boolean | null

Provider is internal

jobConfigurations.advancedTask.quotes

object[] | null

Quotes

jobConfigurations.advancedTask.taskNotes

object[] | null

Task notes

jobConfigurations.advancedTask.tipAmountCents

integer | null

Tip amount in cents

jobConfigurations.advancedTask.tipAmountUsd

number | null

Tip amount in USD

jobConfigurations.advancedTask.winnerQuote

object | null

Winner quote

jobConfigurations.delivery

object | null

Delivery

jobConfigurations.delivery.currency

string

required

Currency

jobConfigurations.delivery.id

string

required

Delivery ID

jobConfigurations.delivery.isActive

boolean

required

Is the delivery active

jobConfigurations.delivery.priceCents

integer

required

Price in cents

jobConfigurations.delivery.status

string

required

Delivery status

jobConfigurations.delivery.cancellationFeeCents

integer | null

Cancellation fee in cents

jobConfigurations.delivery.courierDropoffPhoneNumber

string | null

Courier dropoff phone number

jobConfigurations.delivery.courierLocation

object | null

Courier location

jobConfigurations.delivery.courierName

string | null

Courier name

jobConfigurations.delivery.courierPhoneNumber

string | null

Courier phone number

jobConfigurations.delivery.courierPickupPhoneNumber

string | null

Courier pickup phone number

jobConfigurations.delivery.courierProfileImage

string | null

Courier profile image

jobConfigurations.delivery.courierVehicle

object | null

Courier vehicle

jobConfigurations.delivery.documents

object[] | null

Documents

jobConfigurations.delivery.dropoffDeadline

string | null

Dropoff deadline

jobConfigurations.delivery.dropoffEta

string | null

Dropoff ETA

jobConfigurations.delivery.insuranceFeeCents

integer | null

Insurance fee in cents

jobConfigurations.delivery.nashFeeCents

integer | null

Nash fee in cents

jobConfigurations.delivery.otherProviderFees

object | null

Other provider fees

jobConfigurations.delivery.pickupEta

string | null

Pickup ETA

jobConfigurations.delivery.price

number | null

Price

jobConfigurations.delivery.proofOfDelivery

object[] | null

Proof of delivery

jobConfigurations.delivery.providerBatchId

string | null

Provider batch id

jobConfigurations.delivery.providerDeliveryId

string | null

Provider delivery id

jobConfigurations.delivery.returnFeeCents

integer | null

Return fee in cents

jobConfigurations.delivery.statusHistory

object[] | null

Delivery status history

jobConfigurations.delivery.taxAmountCents

integer | null

Tax amount in cents

jobConfigurations.delivery.tollFeeCents

integer | null

Toll fee in cents

jobConfigurations.delivery.totalPriceBreakdown

object | null

Total price breakdown

jobConfigurations.delivery.totalPriceCents

integer | null

Total price in cents

jobConfigurations.delivery.type

string | null

jobConfigurations.delivery.waitFeeCents

integer | null

Wait fee in cents

jobConfigurations.delivery.waitTimeMinutes

integer | null

Wait time in minutes

jobConfigurations.publicTrackingUrl

string | null

Public tracking URL

portalUrl

string

required

Portal URL

externalIdentifier

string | null

External identifier

jobMetadata

object | null

Job metadata

jobSpecification

object | null

deprecated

Job specification

jobSpecification.{key}

object[]

jobSpecification.{key}.dropoffLocation

object

required

Generic serializer for location used in many endpoints.

jobSpecification.{key}.id

string

required

Package ID

jobSpecification.{key}.itemsCount

required

Items count

jobSpecification.{key}.pickupLocation

object

required

Generic serializer for location used in many endpoints.

jobSpecification.{key}.requirements

string[]

required

Requirements

jobSpecification.{key}.valueCents

integer

required

jobSpecification.{key}.description

string | null

Description

jobSpecification.{key}.dimensions

object | null

Dimensions

jobSpecification.{key}.drivingMetrics

object | null

Driving metrics (distance in meters, duration in seconds)

jobSpecification.{key}.dropoffBarcodes

string[] | null

jobSpecification.{key}.dropoffEndTime

string | null

Dropoff end time

jobSpecification.{key}.dropoffStartTime

string | null

Dropoff start time

jobSpecification.{key}.dropoffStoreLocationId

string | null

Dropoff store location ID

jobSpecification.{key}.externalIdentifier

string | null

External identifier

jobSpecification.{key}.items

object[] | null

Items

jobSpecification.{key}.minimumVehicleSize

string | null

Minimum vehicle size

jobSpecification.{key}.packageDeliveryMode

string | null

Package delivery mode

jobSpecification.{key}.packageMetadata

object | null

Package metadata

jobSpecification.{key}.pickupBarcodes

string[] | null

jobSpecification.{key}.pickupEndTime

string | null

Pickup end time

jobSpecification.{key}.pickupStartTime

string | null

Pickup start time

jobSpecification.{key}.pickupStoreLocationId

string | null

Pickup store location ID

jobSpecification.{key}.referenceId

string | null

Reference ID

jobSpecification.{key}.serviceFee

Service fee

jobSpecification.{key}.serviceFeeCents

integer | null

Service fee in cents

jobSpecification.{key}.tags

string[] | null

API Documentation

Order

Dispatch Strategies

Notifications

Store Locations

Delivery Windows & Capacity

Jobs

Batch Jobs

Providers

Miscellaneous

Get Job by External Identifier

Path Parameters

Response