Skip to main content

This type is used to specify the address details used to create a consign address.

Type that uses CreateConsignPreferenceRequestData

CreateConsignPreferenceRequest

Call that uses CreateConsignPreferenceRequestData

POST
/consign_preference

Fields

Field
Type
Description
consignPreferenceName
string
The name of the consign address.
dropoffSiteId
string
The unique identifier of a drop-off site location. This value can be retrieved using the getDropoffSites method.

This field is required if the DROPOFF address type is specified.
pickupAddress
PickupAddressRequestData
This container is used to specify the address details used to create a pickup-from address.

This container is required if the PICK_UP address type is specified.
pickupTime
PickUpTimeTypeEnum
The pickup time that the pickup location supports.

This field is required if the PICK_UP address type is specified.
type
ConsignTypeEnum
The address type of the consign address.

Valid values:
  • PICK_UP
  • DROP_OFF
  • FORWARD_DEPLOYMENT