This is a list of all fields in the schema. Select a method to learn more about how a call uses a field.
Field
Parent field
Applicable resources and methods
A
additionalCost
additionalOptions
rate.additionalOptions
rates.additionalOptions
additionalOptions
(method-level)
rate
rates
addressLine1
returnTo.contactAddress
shipFrom.contactAddress
shipTo.contactAddress
addressLine2
returnTo.contactAddress
shipFrom.contactAddress
shipTo.contactAddress
B
baseShippingCost
rate
rates
C
cancellation
(method-level)
cancellationRequestedDate
cancellation
cancellationStatus
cancellation
category
warnings
channel
orders
city
returnTo.contactAddress
shipFrom.contactAddress
shipTo.contactAddress
companyName
returnTo
shipFrom
shipTo
contactAddress
returnTo
shipFrom
shipTo
countryCode
returnTo.contactAddress
shipFrom.contactAddress
shipTo.contactAddress
county
returnTo.contactAddress
shipFrom.contactAddress
shipTo.contactAddress
creationDate
(method-level)
currency
additionalOptions.additionalCost
rate.additionalOptions.additionalCost
rate.baseShippingCost
rate.totalShippingCost
rates.additionalOptions.additionalCost
rates.baseShippingCost
D
destinationTimeZone
rate
rates
dimensions
packageSpecification
domain
warnings
E
errorId
warnings
expirationDate
(method-level)
F
fullName
returnTo
shipFrom
shipTo
H
height
packageSpecification.dimensions
I
inputRefIds
warnings
L
labelCustomMessage
(method-level)
labelDownloadUrl
(method-level)
labelSize
(method-level)
length
packageSpecification.dimensions
longMessage
warnings
M
maxEstimatedDeliveryDate
rate
rates
message
warnings
minEstimatedDeliveryDate
rate
rates
N
name
warnings.parameters
O
optionType
additionalOptions
rate.additionalOptions
rates.additionalOptions
orderId
orders
orders
(method-level)
outputRefIds
warnings
P
packageSpecification
(method-level)
parameters
warnings
phoneNumber
returnTo.primaryPhone
shipFrom.primaryPhone
shipTo.primaryPhone
pickupNetworks
rate
rates
pickupSlotEndTime
rates.pickupSlots
pickupSlotId
rate
rates.pickupSlots
pickupSlotStartTime
rates.pickupSlots
pickupSlotTimeZone
rates.pickupSlots
pickupSlots
rates
pickupType
rate
rates
postalCode
returnTo.contactAddress
shipFrom.contactAddress
shipTo.contactAddress
primaryPhone
returnTo
shipFrom
shipTo
R
rate
(method-level)
rateId
(method-level)
rate
rateRecommendation
rates
rates
returnTo
(method-level)
S
shipFrom
(method-level)
shipTo
(method-level)
shipmentId
(method-level)
shipmentTrackingNumber
(method-level)
shippingCarrierCode
rate
rates
shippingCarrierName
rate
rates
shippingQuoteId
(method-level)
rate
shippingServiceCode
rate
rates
shippingServiceName
rate
rates
stateOrProvince
returnTo.contactAddress
shipFrom.contactAddress
shipTo.contactAddress
subdomain
warnings
T
totalShippingCost
rate
U
unit
packageSpecification.dimensions
packageSpecification.weight
V
value
additionalOptions.additionalCost
packageSpecification.weight
rate.additionalOptions.additionalCost
rate.baseShippingCost
rate.totalShippingCost
rates.additionalOptions.additionalCost
rates.baseShippingCost
warnings.parameters
W
warnings
weight
packageSpecification
width
packageSpecification.dimensions