Fulfillment API

ErrorAltProperty

object

Details of an error’s property.

propertystring

The name of the property.

Example:person

valuestring

The value of the property.

Example:J0hn D03

Example
{
  "property": "person",
  "value": "J0hn D03"
}

ErrorsAlt

object

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

errorsarray[object]

Details of an error or issue.

Show Child Parameters
Example
{
  "errors": [
    {
      "errorID": "157a16f0-503d-4256-ba60-a4876e8eb9bb",
      "code": "resource.issue_type",
      "description": "The issue happened because something is wrong.",
      "properties": [
        {
          "property": "person",
          "value": "J0hn D03"
        }
      ]
    }
  ]
}

EventType

The event type.

Allowed values:PICKED_UPIN_TRANSITDELIVERED

Example
"IN_TRANSIT"

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
{
  "op": "EQ",
  "values": [
    "42220470",
    "157a16f0-503d-4256-ba60-a4876e8eb9bb"
  ]
}

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
{
  "totalPrice": 500,
  "priceUnits": "USD"
}