Fulfillment API

CancelReasonCollection

object

Details of dispatch cancel reasons.

itemsarray[object]

Details of cancel reasons.

Show Child Parameters
Example

CancelReasonResponse

object

Details of cancel reasons.

responsibleParty

The party responsible for the cancellation. This list is not exhaustive and additional values may be added at any time.

Allowed values:CARRIERSHIPPERALL

Example:SHIPPER

idstring(uuid)

The ID of the cancellation reason.

Example:cac10000-e89b-12d3-a456-426614174000

namestring

The name of the cancellation reason.

Example:Carrier Unresponsive/Late

Example

CarrierRequest

object

Details of a carrier.

carrierIdstring(uuid)

The ID of the Central Dispatch customer chosen by the shipper to move cars in the dispatch. The carrier must belong to the Marketplace identified by the marketplaceId and have a tier group of BROKER or CARRIER.

Example:0ca91a43-fbee-4c05-9a6c-aa5c63888f5c

Example

CodRequest

object

Details of cash of delivery or cash on payment (COD/COP).

amountnumber(double)

The cash on delivery (COD) or cash on pick up (COP) amount due.

>= 0

Example:200

paymentMethodstring

The method for the COD/COP payment. Required if amount is greater than 0. This list is not exhaustive and additional values may be added at any time.

Allowed values:CHECKCASH_CERTIFIED_FUNDS

Example:CASH_CERTIFIED_FUNDS

paymentLocationstring

The location that COD/COP payment is due. Required if amount is greater than 0. This list is not exhaustive and additional values may be added at any time.

Allowed values:PICKUPDELIVERY

Example:PICKUP

Example

ContactRequest

object

Details of a contact.

namestring

The name of the contact.

Example:Mickey Smith

phonestring

The primary phone number of the contact.

Example:949-555-0101

phone1string

An additional phone number of the contact.

Example:949-555-1323

phone2string

An additional phone number of the contact.

Example:949-555-2434

phone3string

An additional phone number of the contact.

Example:949-555-3545

cellPhonestring

The cell phone number of the contact.

Example:949-555-1212

emailstring

The email address of the contact. Must be a valid email address format.

Example:mickey@snoogle.com

Example