Components

ShipmentRates

Contains all rates for a particular shipment. Also contains rates that could not be matched or retrieved.

PropertyTypeDescription
rates
required
required
carrier_code
string
Unique code for a carrier used within Wuunder.
required
\A[A-Z_0-9]+\z
length 2...64
carrier_name
string
The name of the carrier that was used for this rate
required
carrier_product_code
string
Unique code for a carrier product used within Wuunder.
required
\A[A-Z_0-9]+\z
length 2...128
carrier_product_description
string
The name of the product that was used for this rate
price
integer
The price of a rate in cents.
required
value 1...
receiver_type
string
The type for a rate.
required
one of:
consumer
business
parcelshop
sender_type
string
The type for a rate.
required
one of:
consumer
business
parcelshop
tags
array
required
object
required
delivery_info
Contains delivery info about a shipment.
required
date
string
Date in ISO 8601 field (YYYY-MM-DD) in UTC.
required
date
time_window
string
Time window in format HH:MM-HH:MM
\A[0-2][0-9]:[0-5][0-9](-[0-2][0-9]:[0-5][0-9])?\z
length 5...11
type
string
required
one of:
address
parcelshop
expires_at
string
Indicates till when the rate can be used to book. After this time the rate cannot be used anymore.
required
date-time
id
string
Unique identifier for rate.
required
uuid
pickup_info
Contains pickup information for a shipment.
required
date
string
Date in ISO 8601 field (YYYY-MM-DD) in UTC.
required
date
time_window
string
Time window in format HH:MM-HH:MM
\A[0-2][0-9]:[0-5][0-9](-[0-2][0-9]:[0-5][0-9])?\z
length 5...11
type
string
required
one of:
regular_pickup
requested_by_wuunder
shipment_id
string
Unique identifier for shipment.
required
uuid
unqualified_rates
required
carrier_code
string
Unique code for a carrier used within Wuunder.
required
\A[A-Z_0-9]+\z
length 2...64
carrier_name
string
The name of the carrier that was used for this rate
carrier_product_code
string
Unique code for a carrier product used within Wuunder.
required
\A[A-Z_0-9]+\z
length 2...128
carrier_product_description
string
The name of the product that was used for this rate
code
string
one of:
no_match
carrier_timeout
carrier_excluded
carrier_error
no_data
carrier_excluded
message
string
The reason why this rate is not qualified