Search
K
Fulfillment API

ErrorsAlt

object

An error occurred, and the request could not be completed.

errorsarray[object]

Details of an error or issue.

Show Child Parameters
Example

EventType

The event type.

Allowed values:PICKED_UPIN_TRANSITDELIVERED

Example

ListingIdSearchRequest

object

Search listing IDs information.

opstring

The operation type for the listing IDs. Values: EQ, NEQ, RANGE.

Example:EQ

valuesarray[string]

A collection of listing ID values.

Example:42220470, 157a16f0-503d-4256-ba60-a4876e8eb9bb

Example

PriceRequest

object

Details of the dispatch price.

totalPricenumber(double)

The total amount to be paid for completing the dispatch.

>= 0.01

Example:500

priceUnitsstring

The currency of totalPrice.

Default:USD

Example:USD

Example

RespondToDispatchRequest

object

Details of the respond request.

acceptboolean

Indicates whether the dispatch should be accepted or declined.

Example:true

inspectionAcknowledgedboolean

Indicates whether the require inspection requirement was acknoowledged.

Default:false

Example:true

carrierEstimatedPickupDatestring(date-time)

The date the carrier estimates the vehicle will be picked up, in UTC/ISO 8601 format. Only the date portion of the value passed will be saved.

Example:2025-07-15T00:00:00.000Z

carrierEstimatedDeliveryDatestring(date-time)

The type of delivery date. Only the date portion of the value passed will be saved.

Example:2025-08-15T00:00:00.000Z

Example