Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.
servers:
- url: https://wwwcie.ups.com/api
description: Customer Integration Environment
- url: https://onlinetools.ups.com/api
description: Production
paths:
"/rating/{version}/{requestoption}":
post:
summary: Rating
tags:
- Rating
security:
- OAuth2: []
description: The Rating API is used when rating or shopping a shipment. For more information on the Rating API, please visit the Product Overview page.
operationId: Rate
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
- in: header
name: transactionSrc
schema:
type: string
default: testing
description: An identifier of the client/source application that is making
the request.Length 512
- in: query
name: additionalinfo
schema:
type: string
minimum: 1
description: 'Valid Values: timeintransit = The server rates with transit
time information combined with requestoption in URL.Rate is the only valid
request option for Ground Freight Pricing requests. Length 15'
- in: path
name: version
schema:
type: string
minimum: 1
default: v2409
description: |
Indicates Rate API to display the new release features in Rate API response based on Rate release. See the New section for the latest Rate release.
Valid values:
- v2409
required: true
- in: path
name: requestoption
schema:
type: string
minimum: 1
maxLength: 10
description: |
Valid Values:
- Rate = The server rates (The default Request option is Rate if a Request Option is not provided).
- Shop = The server validates the shipment, and returns rates for all UPS products from the ShipFrom to the ShipTo addresses.
- Ratetimeintransit = The server rates with transit time information
- Shoptimeintransit = The server validates the shipment, and returns rates and transit times for all UPS products from the ShipFrom to the ShipTo addresses.
Rate is the only valid request option for UPS Ground Freight Pricing requests.
required: true
requestBody:
description: Generate sample code for popular API requests by selecting an
example below. To view a full sample request and response, first click "Authorize"
and enter your application credentials, then populate the required parameters
above and click "Try it out".
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/RATERequestWrapper"
examples:
'1':
summary: Simple Rate Example (Standard Example)
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: CustomerContext
Shipment:
Shipper:
Name: ShipperName
ShipperNumber: ShipperNumber
Address:
AddressLine:
- ShipperAddressLine
- ShipperAddressLine
- ShipperAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: ShipToName
Address:
AddressLine:
- ShipToAddressLine
- ShipToAddressLine
- ShipToAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '03'
Description: Ground
NumOfPieces: '1'
Package:
SimpleRate:
Description: SimpleRateDescription
Code: XS
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '1'
'2':
summary: Negotiated Rate
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: Verify Success response
Shipment:
Shipper:
Name: Shipper_Name
ShipperNumber: ''
Address:
AddressLine:
- Morris Road
- Morris Road
- Morris Road
City: Alpharetta
StateProvinceCode: GA
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: France Company
Address:
AddressLine:
- 103 avenue des Champs-Elysees
- 103 avenue des Champs-Elysees
- 103 avenue des Champs-Elysees
City: STARZACH
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ResidentialAddressIndicator: Y
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillThirdParty:
AttentionName: Name
Name: TR
AccountNumber: ''
Address:
AddressLine: AdressLine
City: NEW YORK
StateProvinceCode: NY
PostalCode: '21093'
CountryCode: US
ShipmentRatingOptions:
TPFCNegotiatedRatesIndicator: Y
NegotiatedRatesIndicator: Y
Service:
Code: '03'
Description: UPS Worldwide Economy DDU
NumOfPieces: '10'
Package:
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Ounces
Weight: '0.1'
OversizeIndicator: X
MinimumBillableWeightIndicator: X
'3':
summary: International Rate Example
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: Verify Success response
Shipment:
Shipper:
Name: Shipper_Name
ShipperNumber: ''
Address:
AddressLine:
- Morris Road
- Morris Road
- Morris Road
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipTo:
Name: France Company
Address:
AddressLine:
- 103 avenue des Champs-Elysees
- 103 avenue des Champs-Elysees
- 103 avenue des Champs-Elysees
City: STARZACH
StateProvinceCode: GA
PostalCode: '72181'
CountryCode: DE
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '072'
Description: UPS Worldwide Economy DDP
NumOfPieces: '10'
Package:
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: LBS
Weight: '0.1'
OversizeIndicator: X
MinimumBillableWeightIndicator: X
ShipmentRatingOptions:
NegotiatedRatesIndicator: Y
'4':
summary: Multi-Piece Rate Example
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: CustomerContext
Shipment:
Shipper:
Name: ShipperName
ShipperNumber: ShipperNumber
Address:
AddressLine:
- ShipperAddressLine
- ShipperAddressLine
- ShipperAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: ShipToName
Address:
AddressLine:
- ShipToAddressLine
- ShipToAddressLine
- ShipToAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '03'
Description: Ground
ShipmentTotalWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '3'
NumOfPieces: '2'
Package:
- PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '1'
- PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '4'
Width: '4'
Height: '4'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '2'
'5':
summary: TPFC Negotiated Rate Example
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: CustomerContext
Shipment:
Shipper:
Name: ShipperName
ShipperNumber: ShipperNumber
Address:
AddressLine:
- ShipperAddressLine
- ShipperAddressLine
- ShipperAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: ShipToName
Address:
AddressLine:
- ShipToAddressLine
- ShipToAddressLine
- ShipToAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillThirdParty:
AttentionName: AttentionName
Name: Name
AccountNumber: ThirdPartyAccount
Address:
AddressLine: AdressLine
City: NEW YORK
StateProvinceCode: NY
PostalCode: '21093'
CountryCode: US
- Type: '02'
BillThirdParty:
AttentionName: AttentionName
Name: Name
AccountNumber: ThirdPartyAccount
Address:
AddressLine: AdressLine
City: NEW YORK
StateProvinceCode: NY
PostalCode: '21093'
CountryCode: US
Service:
Code: '03'
Description: Ground
NumOfPieces: '1'
Package:
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '1'
ShipmentRatingOptions:
TPFCNegotiatedRatesIndicator: Y
'6':
summary: Time In Transit Example
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: CustomerContext
Shipment:
Shipper:
Shipper:
Name: ShipperName
ShipperNumber: ShipperNumber
Address:
AddressLine:
- ShipperAddressLine
- ShipperAddressLine
- ShipperAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: ShipToName
Address:
AddressLine:
- ShipToAddressLine
- ShipToAddressLine
- ShipToAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '03'
Description: Ground
NumOfPieces: '1'
Package:
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '1'
DeliveryTimeInformation:
PackageBillType: '03'
Pickup:
Date: '20230101'
Time: '1000'
'7':
summary: Standard Account Rate Example
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: CustomerContext
Shipment:
Shipper:
Name: ShipperName
ShipperNumber: ShipperNumber
Address:
AddressLine:
- ShipperAddressLine
- ShipperAddressLine
- ShipperAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: ShipToName
Address:
AddressLine:
- ShipToAddressLine
- ShipToAddressLine
- ShipToAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '03'
Description: Ground
NumOfPieces: '1'
Package:
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '1'
'8':
summary: Published Rate Example
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: CustomerContext
Shipment:
Shipper:
Name: ShipperName
Address:
AddressLine:
- ShipperAddressLine
- ShipperAddressLine
- ShipperAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: ShipToName
Address:
AddressLine:
- ShipToAddressLine
- ShipToAddressLine
- ShipToAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
Service:
Code: '03'
Description: Ground
NumOfPieces: '1'
Package:
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '1'
'9':
summary: Rate with Dry Ice
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: " "
CustomerClassification:
Code: '01'
Description: Daily Rates
Shipment:
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillShipper:
AccountNumber: ''
DeliveryTimeInformation:
PackageBillType: '07'
Shipper:
Name: Shipper_Name19
ShipperNumber: ''
Address:
AddressLine: Shipper_AddressLine
City: New York
StateProvinceCode: NY
PostalCode: '10013'
CountryCode: US
ShipTo:
Name: Shiptoname
Address:
ResidentialAddressIndicator: x
AddressLine: 12380 Morris Road
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: Shipfromname
Address:
AddressLine: Shipfromaddress
City: Texas
StateProvinceCode: TX
PostalCode: '77040'
CountryCode: US
Service:
Code: '01'
Description: Next Day Air
ShipmentRatingOptions:
NegotiatedRatesIndicator: Y
Package:
LargePackageIndicator: X
PackagingType:
Code: '02'
Description: Package
Dimensions:
UnitOfMeasurement:
Code: IN
Description: INCHES
Length: '6'
Width: '7'
Height: '8'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Weight: '10'
PackageServiceOptions:
DryIce:
RegulationSet: CFR
DryIceWeight:
UnitOfMeasurement:
Code: '01'
Description: LBS
Weight: '5'
AuditRequired: ''
'10':
summary: shopTime In Transit (CIE) Example
value:
RateRequest:
Request:
RequestOption: shopTimeInTransit
SubVersion: ''
TransactionReference:
CustomerContext: Verify success returned rate request is submitted with ShopTimeInTransit
TransactionIdentifier: ''
Shipment:
OriginRecordTransactionTimestamp: ''
Shipper:
Name: Shipper_Name
ShipperNumber: ''
Address:
AddressLine:
- Morris Road
- Morris Road
- Morris Road
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipTo:
Name: ShipToName
Address:
AddressLine:
- ShipToAddress
- ShipToAddress
- ShipToAddress
City: Aurora
StateProvinceCode: ON
PostalCode: L4G 3V2
CountryCode: CA
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
Package:
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: LBS
Weight: '10'
InvoiceLineTotal:
CurrencyCode: USD
MonetaryValue: '100'
ShipmentTotalWeight:
UnitOfMeasurement:
Code: LBS
Description: LBS
Weight: '9'
DeliveryTimeInformation:
PackageBillType: '03'
Pickup:
Date: '20250624'
Time: '1616'
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/RATEResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"/rating/{deprecatedVersion}/{requestoption}":
post:
deprecated: true
summary: Rating
tags:
- Rating
security:
- OAuth2: []
description: The Rating API is used when rating or shopping a shipment.
operationId: Deprecated Rate
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
- in: header
name: transactionSrc
schema:
type: string
default: testing
description: An identifier of the client/source application that is making
the request.Length 512
- in: query
name: additionalinfo
schema:
type: string
minimum: 1
description: 'Valid Values: timeintransit = The server rates with transit
time information combined with requestoption in URL.Rate is the only valid
request option for Ground Freight Pricing requests. Length 15'
- in: path
name: deprecatedVersion
schema:
type: string
minimum: 1
default: v1
description: |
Indicates Rate API to display the new release features in Rate API response based on Rate release. See the New section for the latest Rate release.
Valid values:
- v1
- v1601
- v1607
- 1701
- 1707
- v2108
- v2205
required: true
- in: path
name: requestoption
schema:
type: string
minimum: 1
maxLength: 10
description: |
Valid Values:
- Rate = The server rates (The default Request option is Rate if a Request Option is not provided).
- Shop = The server validates the shipment, and returns rates for all UPS products from the ShipFrom to the ShipTo addresses.
- Ratetimeintransit = The server rates with transit time information
- Shoptimeintransit = The server validates the shipment, and returns rates and transit times for all UPS products from the ShipFrom to the ShipTo addresses.
Rate is the only valid request option for UPS Ground Freight Pricing requests.
required: true
requestBody:
description: Generate sample code for popular API requests by selecting an
example below. To view a full sample request and response, first click "Authorize"
and enter your application credentials, then populate the required parameters
above and click "Try it out".
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/RATERequestWrapper"
examples:
'1':
summary: Simple Rate Example (Standard Example)
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: CustomerContext
Shipment:
Shipper:
Name: ShipperName
ShipperNumber: ShipperNumber
Address:
AddressLine:
- ShipperAddressLine
- ShipperAddressLine
- ShipperAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: ShipToName
Address:
AddressLine:
- ShipToAddressLine
- ShipToAddressLine
- ShipToAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '03'
Description: Ground
NumOfPieces: '1'
Package:
SimpleRate:
Description: SimpleRateDescription
Code: XS
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '1'
'2':
summary: Negotiated Rate
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: Verify Success response
Shipment:
Shipper:
Name: Shipper_Name
ShipperNumber: ''
Address:
AddressLine:
- Morris Road
- Morris Road
- Morris Road
City: Alpharetta
StateProvinceCode: GA
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: France Company
Address:
AddressLine:
- 103 avenue des Champs-Elysees
- 103 avenue des Champs-Elysees
- 103 avenue des Champs-Elysees
City: STARZACH
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillThirdParty:
AttentionName: Name
Name: TR
AccountNumber: ''
Address:
ResidentialAddressIndicator: Y
AddressLine: AdressLine
City: NEW YORK
StateProvinceCode: NY
PostalCode: '21093'
CountryCode: US
ShipmentRatingOptions:
TPFCNegotiatedRatesIndicator: Y
NegotiatedRatesIndicator: Y
Service:
Code: '03'
Description: UPS Worldwide Economy DDU
NumOfPieces: '10'
Package:
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Ounces
Weight: '0.1'
OversizeIndicator: X
MinimumBillableWeightIndicator: X
'3':
summary: International Rate Example
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: Verify Success response
Shipment:
Shipper:
Name: Shipper_Name
ShipperNumber: ''
Address:
AddressLine:
- Morris Road
- Morris Road
- Morris Road
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipTo:
Name: France Company
Address:
AddressLine:
- 103 avenue des Champs-Elysees
- 103 avenue des Champs-Elysees
- 103 avenue des Champs-Elysees
City: STARZACH
StateProvinceCode: GA
PostalCode: '72181'
CountryCode: DE
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '072'
Description: UPS Worldwide Economy DDP
NumOfPieces: '10'
Package:
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: LBS
Weight: '0.1'
OversizeIndicator: X
MinimumBillableWeightIndicator: X
ShipmentRatingOptions:
NegotiatedRatesIndicator: Y
'4':
summary: Multi-Piece Rate Example
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: CustomerContext
Shipment:
Shipper:
Name: ShipperName
ShipperNumber: ShipperNumber
Address:
AddressLine:
- ShipperAddressLine
- ShipperAddressLine
- ShipperAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: ShipToName
Address:
AddressLine:
- ShipToAddressLine
- ShipToAddressLine
- ShipToAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '03'
Description: Ground
ShipmentTotalWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '3'
NumOfPieces: '2'
Package:
- PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '1'
- PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '4'
Width: '4'
Height: '4'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '2'
'5':
summary: TPFC Negotiated Rate Example
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: CustomerContext
Shipment:
Shipper:
Name: ShipperName
ShipperNumber: ShipperNumber
Address:
AddressLine:
- ShipperAddressLine
- ShipperAddressLine
- ShipperAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: ShipToName
Address:
AddressLine:
- ShipToAddressLine
- ShipToAddressLine
- ShipToAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillThirdParty:
AttentionName: AttentionName
Name: Name
AccountNumber: ThirdPartyAccount
Address:
AddressLine: AdressLine
City: NEW YORK
StateProvinceCode: NY
PostalCode: '21093'
CountryCode: US
- Type: '02'
BillThirdParty:
AttentionName: AttentionName
Name: Name
AccountNumber: ThirdPartyAccount
Address:
AddressLine: AdressLine
City: NEW YORK
StateProvinceCode: NY
PostalCode: '21093'
CountryCode: US
Service:
Code: '03'
Description: Ground
NumOfPieces: '1'
Package:
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '1'
ShipmentRatingOptions:
TPFCNegotiatedRatesIndicator: Y
'6':
summary: Time In Transit Example
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: CustomerContext
Shipment:
Shipper:
Shipper:
Name: ShipperName
ShipperNumber: ShipperNumber
Address:
AddressLine:
- ShipperAddressLine
- ShipperAddressLine
- ShipperAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: ShipToName
Address:
AddressLine:
- ShipToAddressLine
- ShipToAddressLine
- ShipToAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '03'
Description: Ground
NumOfPieces: '1'
Package:
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '1'
DeliveryTimeInformation:
PackageBillType: '03'
Pickup:
Date: '20230101'
Time: '1000'
'7':
summary: Standard Account Rate Example
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: CustomerContext
Shipment:
Shipper:
Name: ShipperName
ShipperNumber: ShipperNumber
Address:
AddressLine:
- ShipperAddressLine
- ShipperAddressLine
- ShipperAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: ShipToName
Address:
AddressLine:
- ShipToAddressLine
- ShipToAddressLine
- ShipToAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '03'
Description: Ground
NumOfPieces: '1'
Package:
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '1'
'8':
summary: Published Rate Example
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: CustomerContext
Shipment:
Shipper:
Name: ShipperName
Address:
AddressLine:
- ShipperAddressLine
- ShipperAddressLine
- ShipperAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: ShipToName
Address:
AddressLine:
- ShipToAddressLine
- ShipToAddressLine
- ShipToAddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFromName
Address:
AddressLine:
- ShipFromAddressLine
- ShipFromAddressLine
- ShipFromAddressLine
City: TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
Service:
Code: '03'
Description: Ground
NumOfPieces: '1'
Package:
PackagingType:
Code: '02'
Description: Packaging
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '5'
Width: '5'
Height: '5'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '1'
'9':
summary: Rate with Dry Ice
value:
RateRequest:
Request:
TransactionReference:
CustomerContext: " "
CustomerClassification:
Code: '01'
Description: Daily Rates
Shipment:
PaymentDetails:
ShipmentCharge:
- Type: '01'
BillShipper:
AccountNumber: ''
DeliveryTimeInformation:
PackageBillType: '07'
Shipper:
Name: Shipper_Name19
ShipperNumber: ''
Address:
AddressLine: Shipper_AddressLine
City: New York
StateProvinceCode: NY
PostalCode: '10013'
CountryCode: US
ShipTo:
Name: Shiptoname
Address:
ResidentialAddressIndicator: x
AddressLine: 12380 Morris Road
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: Shipfromname
Address:
AddressLine: Shipfromaddress
City: Texas
StateProvinceCode: TX
PostalCode: '77040'
CountryCode: US
Service:
Code: '01'
Description: Next Day Air
ShipmentRatingOptions:
NegotiatedRatesIndicator: Y
Package:
LargePackageIndicator: X
PackagingType:
Code: '02'
Description: Package
Dimensions:
UnitOfMeasurement:
Code: IN
Description: INCHES
Length: '6'
Width: '7'
Height: '8'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Weight: '10'
PackageServiceOptions:
DryIce:
RegulationSet: CFR
DryIceWeight:
UnitOfMeasurement:
Code: '01'
Description: LBS
Weight: '5'
AuditRequired: ''
'10':
summary: shopTime In Transit (CIE) Example
value:
{
"RateRequest": {
"Request": {
"RequestOption": "shopTimeInTransit",
"SubVersion": "",
"TransactionReference": {
"CustomerContext": "Verify success returned rate request is submitted with ShopTimeInTransit",
"TransactionIdentifier": ""
}
},
"Shipment": {
"OriginRecordTransactionTimestamp": "",
"Shipper": {
"Name": "Shipper_Name",
"ShipperNumber": "",
"Address": {
"AddressLine": [
"Morris Road",
"Morris Road",
"Morris Road"
],
"City": "Alpharetta",
"StateProvinceCode": "GA",
"PostalCode": "30005",
"CountryCode": "US"
}
},
"ShipTo": {
"Name": "ShipToName",
"Address": {
"AddressLine": [
"ShipToAddress",
"ShipToAddress",
"ShipToAddress"
],
"City": "Aurora",
"StateProvinceCode": "ON",
"PostalCode": "L4G 3V2",
"CountryCode": "CA"
}
},
"ShipFrom": {
"Name": "ShipFromName",
"Address": {
"AddressLine": [
"ShipFromAddressLine",
"ShipFromAddressLine",
"ShipFromAddressLine"
],
"City": "Alpharetta",
"StateProvinceCode": "GA",
"PostalCode": "30005",
"CountryCode": "US"
}
},
"Package": {
"PackagingType": {
"Code": "02",
"Description": "Packaging"
},
"Dimensions": {
"UnitOfMeasurement": {
"Code": "IN",
"Description": "Inches"
},
"Length": "5",
"Width": "5",
"Height": "5"
},
"PackageWeight": {
"UnitOfMeasurement": {
"Code": "LBS",
"Description": "LBS"
},
"Weight": "10"
}
},
"InvoiceLineTotal": {
"CurrencyCode": "USD",
"MonetaryValue": "100"
},
"ShipmentTotalWeight": {
"UnitOfMeasurement": {
"Code": "LBS",
"Description": "LBS"
},
"Weight": "9"
},
"DeliveryTimeInformation": {
"PackageBillType": "03",
"Pickup": {
"Date": "20250624",
"Time": "161682"
}
},
}
}
}
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/RATEResponseWrapper"
'400':
description: Invalid Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
'429':
description: Rate Limit Exceeded
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
components:
securitySchemes:
OAuth2:
type: oauth2
description: |
Find your Client ID and Secret on your app info page.
1. Select \"Try It\"
2. In the Security section enter your Client ID and Secret.
3. Select \"Request Token\"
4. Enter any additional information in the Body and Parameters sections.
5. Select \"Send\" to execute your API request
flows:
clientCredentials:
x-tokenEndpointAuthMethod: client_secret_basic
tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token
scopes: {}
schemas:
RATERequestWrapper:
xml:
name: RateRequest
description: 'N/A '
maximum: 1
type: object
required:
- RateRequest
properties:
RateRequest:
"$ref": "#/components/schemas/RateRequest"
RATEResponseWrapper:
xml:
name: RateResponse
description: 'N/A '
maximum: 1
type: object
required:
- RateResponse
properties:
RateResponse:
"$ref": "#/components/schemas/RateResponse"
RateRequest:
type: object
required:
- Request
- Shipment
properties:
Request:
"$ref": "#/components/schemas/RateRequest_Request"
PickupType:
"$ref": "#/components/schemas/RateRequest_PickupType"
CustomerClassification:
"$ref": "#/components/schemas/RateRequest_CustomerClassification"
Shipment:
"$ref": "#/components/schemas/RateRequest_Shipment"
xml:
name: RateRequest
description: Rate Request container.
maximum: 1
RateRequest_Request:
type: object
required:
- RequestOption
properties:
SubVersion:
description: 'Indicates Rate API to display the new release features in
Rate API response based on Rate release. See the What''s New section for
the latest Rate release. Supported values: 1601, 1607, 1701, 1707, 2108,
2205,2407,2409'
maximum: 1
type: string
minLength: 4
maxLength: 4
TransactionReference:
"$ref": "#/components/schemas/Request_TransactionReference"
xml:
name: Request
maximum: 1
description: Request container. N/A
Request_TransactionReference:
type: object
maximum: 1
properties:
CustomerContext:
description: May be used to synchronize request/response pairs. Information in the request element is echoed back in the response.
type: string
minLength: 1
maxLength: 512
maximum: 1
xml:
name: TransactionReference
description: TransactionReference identifies transactions between client and
server.
RateRequest_PickupType:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: 'Pickup Type Code. Valid values: 01 - Daily Pickup (Default
- used when an invalid pickup type code is provided)03 - Customer Counter06
- One Time Pickup19 - Letter Center20 - Air Service CenterLength is not
validated. When negotiated rates are requested, 07 (onCallAir) will be
ignored.Refer to the Rate Types Table in the Appendix for rate type based
on Pickup Type and Customer Classification Code.'
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: Pickup Type Description. Ignored if provided in the Request.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: PickupType
description: Pickup Type container tag.
RateRequest_CustomerClassification:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: Customer classification code. Valid values:00 - Rates Associated
with Shipper Number01 - Daily Rates04 - Retail Rates05 - Regional Rates06
- General List Rates53 - Standard List RatesLength is not validated.If
customer classification code is not a valid value please refer to Rate
Types Table on page 11.
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: Customer classification description of the code above. Ignored
if provided in the Request. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: CustomerClassification
description: Customer classification container. Valid if ShipFrom country or territory is "US"
RateRequest_Shipment:
type: object
maximum: 1
properties:
OriginRecordTransactionTimestamp:
description: The time that the request was made from the originating system.
UTC time down to milliseconds. Example - 2016-07-14T12:01:33.999 Applicable
only for HazMat request and with subversion greater than or equal to 1701.
maximum: 1
type: string
Shipper:
"$ref": "#/components/schemas/Shipment_Shipper"
ShipTo:
"$ref": "#/components/schemas/Shipment_ShipTo"
ShipFrom:
"$ref": "#/components/schemas/Shipment_ShipFrom"
AlternateDeliveryAddress:
"$ref": "#/components/schemas/Shipment_AlternateDeliveryAddress"
ShipmentIndicationType:
type: array
items:
"$ref": "#/components/schemas/Shipment_ShipmentIndicationType"
PaymentDetails:
"$ref": "#/components/schemas/Shipment_PaymentDetails"
FRSPaymentInformation:
"$ref": "#/components/schemas/Shipment_FRSPaymentInformation"
FreightShipmentInformation:
"$ref": "#/components/schemas/Shipment_FreightShipmentInformation"
GoodsNotInFreeCirculationIndicator:
description: Goods Not In Free Circulation indicator. This is an empty
tag, any value inside is ignored. This indicator is invalid for a package
type of UPS Letter and DocumentsOnly.
maximum: 1
type: string
Service:
"$ref": "#/components/schemas/Shipment_Service"
NumOfPieces:
description: Total number of pieces in all pallets. Required for UPS Worldwide
Express Freight and UPS Worldwide Express Freight Midday shipments.
type: string
ShipmentTotalWeight:
"$ref": "#/components/schemas/Shipment_ShipmentTotalWeight"
DocumentsOnlyIndicator:
description: 'Valid values are Document and Non-document. If the indicator
is present then the value is Document else Non-Document. Note: Not applicable
for FRS rating requests. Empty Tag.'
type: string
Package:
type: array
maximum: 200
items:
"$ref": "#/components/schemas/Shipment_Package"
ShipmentServiceOptions:
"$ref": "#/components/schemas/Shipment_ShipmentServiceOptions"
ShipmentRatingOptions:
"$ref": "#/components/schemas/Shipment_ShipmentRatingOptions"
InvoiceLineTotal:
"$ref": "#/components/schemas/Shipment_InvoiceLineTotal"
RatingMethodRequestedIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. RatingMethodRequestedIndicator
is an indicator. If present, Billable Weight Calculation method and Rating
Method information would be returned in response.
maximum: 1
type: string
TaxInformationIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. TaxInformationIndicator
is an indicator. The Tax related information includes any type of Taxes,
corresponding Monetary Values, Total Charges with Taxes and disclaimers
(if applicable) would be returned in response. If present, any taxes
that may be applicable to a shipment would be returned in response. If
this indicator is requested with NegotiatedRatesIndicator, Tax related
information, if applicable, would be returned only for Negotiated Rates
and not for Published Rates.
maximum: 1
type: string
PromotionalDiscountInformation:
"$ref": "#/components/schemas/Shipment_PromotionalDiscountInformation"
DeliveryTimeInformation:
"$ref": "#/components/schemas/Shipment_DeliveryTimeInformation"
MasterCartonIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. MasterCartonIndicator
is an indicator and presence implies that shipment is Master Carton type. If
present, the shipment will be rated as a Master Carton Type. If this indicator
is requested with NegotiatedRatesIndicator, rates would be returned only
for Negotiated Rates and not for Published Rates.
maximum: 1
type: string
WWEShipmentIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. WWEShipmentIndicator
is an indicator and presence implies that WWE service details requested
for RequestOption=Shop or RequestOption=Shoptimeintransit RequestOption=Shop
or RequestOption=Shoptimeintransit
maximum: 1
type: string
xml:
name: Shipment
required:
- Shipper
- ShipTo
- Package
description: Container for Shipment Information.
Shipment_Shipper:
type: object
maximum: 1
properties:
Name:
description: Shipper's name or company name. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
AttentionName:
description: Shipper's attention name. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
ShipperNumber:
description: Shipper's UPS account number. A valid account number is required
to receive negotiated rates. Optional otherwise. Cannot be present when
requesting UserLevelDiscount.
maximum: 1
type: string
minLength: 6
maxLength: 6
Address:
"$ref": "#/components/schemas/Shipper_Address"
xml:
name: Shipper
required:
- Address
description: Shipper container. Information associated with the UPS account
number.
Shipper_Address:
type: object
maximum: 1
required:
- CountryCode
- AddressLine
properties:
AddressLine:
description: Shipper's street address including name and number (when applicable). Maximum Occurrence should be three. Length is not validated.
Note:Required if requesting Roadie Service
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: Shipper's city. Required if country or territory does not utilize postal codes. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: Shipper's state code. Length is not validated.
maximum: 1
type: string
minLength: 2
maxLength: 2
PostalCode:
description: Shipper's postal code. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: Country or Territory code. Refer to the Supported Country or Territory Tables located in Appendix.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
description: Address Container. If the ShipFrom container is not present then
this address will be used as the ShipFrom. If this address is used as the
ShipFrom, the shipment will be rated from this origin address.
Shipment_ShipTo:
type: object
maximum: 1
properties:
Name:
description: Destination attention name or company name. Length is not
validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
AttentionName:
description: Destination attention name. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
Address:
"$ref": "#/components/schemas/ShipTo_Address"
xml:
name: ShipTo
required:
- Address
description: Ship To Container
ShipTo_Address:
type: object
maximum: 1
required:
- CountryCode
- AddressLine
properties:
AddressLine:
description: Destination street address including name and number (when applicable). Max Occurrence can be 3. Length is not validated.
Note:Required if requesting Roadie Service
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: Destination city. Required if country or territory does not utilize postal codes. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: Destination state code.
maximum: 1
type: string
minLength: 2
maxLength: 2
PostalCode:
description: Destination postal code. Required if country or territory utilizes postal codes (i.e. US and PR).
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: Destination country or territory code. Refer to the Supported Country or Territory Tables located in the Appendix.
maximum: 1
type: string
minLength: 2
maxLength: 2
ResidentialAddressIndicator:
description: |
Residential Address flag. This field is a flag to indicate if the destination is a residential location. True if ResidentialAddressIndicator tag exists; false otherwise. This element does not require a value and if one is entered it will be ignored.
Note: When requesting TimeInTransit information, this indicator must be passed to determine if Three Day Select or Ground shipment is eligible for Saturday Delivery at no charge. If this indicator is not present, address will be considered as commercial. Empty Tag.
maximum: 1
type: string
xml:
name: Address
description: Address Container.
Shipment_ShipFrom:
type: object
maximum: 1
properties:
Name:
description: Origin attention name or company name. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
AttentionName:
description: Origin attention name. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
Address:
"$ref": "#/components/schemas/ShipFrom_Address"
xml:
name: ShipFrom
required:
- Address
description: Ship From Container.
ShipFrom_Address:
type: object
maximum: 1
required:
- CountryCode
properties:
AddressLine:
description: The origin street address including name and number (when applicable). Length is not validated.
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: Origin city. Required if country or territory does not utilize postal codes. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: |
Origin state code. A StateProvinceCode and valid account number are required when requesting negotiated rates. Otherwise the StateProvinceCode is optional.
If the TaxInformationIndicator flag is present in the request, a StateProvinceCode must be entered for tax charges to be accurately calculated in the response.
maximum: 1
type: string
minLength: 2
maxLength: 2
PostalCode:
description: Origin postal code. Required if country or territory utilizes postal codes (e.g. US and PR).
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: Origin country or territory code. Refer to the Supported Country or Territory Tables located in the Appendix. Required, but defaults to US.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
description: Address container for Ship From. Address Container
Shipment_AlternateDeliveryAddress:
type: object
maximum: 1
properties:
Name:
description: UPS Access Point location name.
type: string
Address:
"$ref": "#/components/schemas/AlternateDeliveryAddress_Address"
xml:
name: AlternateDeliveryAddress
required:
- Address
description: |
Alternate Delivery Address container. Applies for deliveries to UPS Access Point™ locations.
Required for the following ShipmentIndicationType values:
- 01 - Hold for Pickup at UPS Access Point™
- 02 - UPS Access Point™ Delivery
AlternateDeliveryAddress_Address:
type: object
maximum: 1
required:
- CountryCode
properties:
AddressLine:
description: The UPS Access Point's street address, including name and number
(when applicable). Length is not validated.
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: UPS Access Point city.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: UPS Access Point State or Province code.
maximum: 1
type: string
minLength: 2
maxLength: 2
PostalCode:
description: UPS Access Point Postal code.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: UPS Access Point country or territory code.
maximum: 1
type: string
minLength: 2
maxLength: 2
ResidentialAddressIndicator:
description: Presence/Absence Indicator. Any value inside is ignored.This
field is a flag to indicate if the Alternate Delivery location is a residential
location. True if ResidentialAddressIndicator tag exists. For future
use.
maximum: 1
type: string
POBoxIndicator:
description: |
Presence/Absence Indicator. Any value inside is ignored.
This field is a flag to indicate if the Alternate Delivery location is a PO box location.
True if POBoxIndicator tag exists; false otherwise. Not valid with Shipment Indication Types:
- 01 - Hold for Pickup at UPS Access Point
- 02 - UPS Access Point™ Delivery
maximum: 1
type: string
xml:
name: Address
description: Address container for Alternate Delivery Address.
Shipment_ShipmentIndicationType:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Code for Shipment Indication Type.
Valid values:
- 01 - Hold for Pickup at UPS Access Point
- 02 - UPS Access Point™ Delivery
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: Description for Shipment Indication Type. Length is not Validated.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: ShipmentIndicationType
description: Container to hold shipment indication type.
Shipment_PaymentDetails:
type: object
required:
- ShipmentCharge
properties:
ShipmentCharge:
type: array
maximum: 2
items:
"$ref": "#/components/schemas/PaymentDetails_ShipmentCharge"
SplitDutyVATIndicator:
description: Split Duty VAT Indicator. The presence indicates the payer
specified for Transportation Charges will pay transportation charges and
any duties that apply to the shipment. The payer specified for Duties
and Taxes will pay the VAT (Value-Added Tax) only. Empty Tag. The payment
method for Transportation charges must be UPS account. The UPS account
must be a daily pickup account or an occasional account.
maximum: 1
type: string
xml:
name: PaymentDetails
maximum: 1
description: Payment details container for detailed shipment charges. The two
shipment charges that are available for specification are Transportation charges
and Duties and Taxes. This container is used for Who Pays What functionality.
PaymentDetails_ShipmentCharge:
type: object
maximum: 1
required:
- Type
properties:
Type:
description: Values are 01 = Transportation, 02 = Duties and Taxes
maximum: 1
type: string
minLength: 2
maxLength: 2
BillShipper:
"$ref": "#/components/schemas/ShipmentCharge_BillShipper"
BillReceiver:
"$ref": "#/components/schemas/ShipmentCharge_BillReceiver"
BillThirdParty:
"$ref": "#/components/schemas/ShipmentCharge_BillThirdParty"
ConsigneeBilledIndicator:
description: Consignee Billing payment option indicator. The presence indicates
consignee billing option is selected. The absence indicates one of the
other payment options is selected. Empty Tag. This element or its sibling
element, BillShipper, BillReceiver or BillThirdParty, must be present
but no more than one can be present. This billing option is valid for
a shipment charge type of Transportation only. Only applies to US/PR and
PR/US shipment origins and destination.
maximum: 1
type: string
xml:
name: ShipmentCharge
description: Shipment charge container. If Duty and Tax charges are applicable
to a shipment and a payer is not specified, the default payer of Duty and
Tax charges is Bill to Receiver. There will be no default payer of Duty and
Tax charges for DDU and DDP service.
ShipmentCharge_BillShipper:
type: object
maximum: 1
required:
- AccountNumber
properties:
AccountNumber:
description: UPS account number Must be the same UPS account number as
the one provided in Shipper/ShipperNumber.
maximum: 1
type: string
minLength: 6
maxLength: 6
xml:
name: BillShipper
description: Container for the BillShipper billing option. This element or
its sibling element, BillReceiver, BillThirdParty or ConsigneeBilledIndicator,
must be present but no more than one can be present.
ShipmentCharge_BillReceiver:
type: object
maximum: 1
required:
- AccountNumber
properties:
AccountNumber:
description: The UPS account number. The account must be a valid UPS account
number that is active. For US, PR and CA accounts, the account must be
a daily pickup account, an occasional account, a customer B.I.N account,
or a dropper shipper account. All other accounts must be either a daily
pickup account, an occasional account, a drop shipper account, or a non-shipping
account.
maximum: 1
type: string
minLength: 6
maxLength: 6
Address:
"$ref": "#/components/schemas/BillReceiver_Address"
xml:
name: BillReceiver
description: Container for the BillReceiver billing option. This element or
its sibling element, BillShipper, BillThirdParty or Consignee Billed, must
be present but no more than one can be present. For a return shipment, Bill
Receiver is invalid for Transportation charges.
BillReceiver_Address:
type: object
maximum: 1
properties:
PostalCode:
description: The postal code for the UPS account's pickup address. The pickup
postal code was entered in the UPS system when the account was set-up.
maximum: 1
type: string
minLength: 1
maxLength: 9
xml:
name: Address
description: Container for additional information for the bill receiver's UPS
accounts address.
ShipmentCharge_BillThirdParty:
type: object
maximum: 1
required:
- Address
- AccountNumber
properties:
AccountNumber:
description: The UPS account number of the third party shipper. The account
must be a valid UPS account number that is active. For US, PR and CA accounts,
the account must be either a daily pickup account, an occasional account,
or a customer B.I.N account, or a drop shipper account. All other accounts
must be either a daily pickup account, an occasional account, a drop shipper
account, or a non-shipping account.
maximum: 1
type: string
minLength: 6
maxLength: 6
Address:
"$ref": "#/components/schemas/BillThirdParty_Address"
xml:
name: BillThirdParty
description: Container for the third party billing option. This element or
its sibling element, BillShipper, BillReceiver or Consignee Billed, must be
present but no more than one can be present.
BillThirdParty_Address:
type: object
maximum: 1
properties:
AddressLine:
description: The origin street address including name and number (when applicable).
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: Origin city.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: Origin state code.
maximum: 1
type: string
minLength: 2
maxLength: 2
PostalCode:
description: 'Origin postal code. The postal code must be the same as the
UPS account pickup address postal code. Required for United States and
Canadian UPS accounts and/or if the UPS account pickup address has a postal
code. If the UPS account''s pickup country or territory is US or Puerto
Rico, the postal code is 5 or 9 digits. The character ''-'' may be used
to separate the first five digits and the last four digits. If the UPS
account''s pickup country or territory is CA, the postal code is 6 alphanumeric
characters whose format is A#A#A# where A is an uppercase letter and #
is a digit.'
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: Origin country or territory code. Refer to the Supported Country
or Territory Tables located in the Appendix.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
required:
- CountryCode
description: Container for additional information for the third party UPS accounts
address.
Shipment_FRSPaymentInformation:
type: object
required:
- Type
properties:
Type:
"$ref": "#/components/schemas/FRSPaymentInformation_Type"
AccountNumber:
description: UPS Account Number.
maximum: 1
type: string
minLength: 6
maxLength: 6
Address:
"$ref": "#/components/schemas/FRSPaymentInformation_Address"
xml:
name: FRSPaymentInformation
maximum: 1
description: UPS Ground Freight Pricing (GFP) Payment Information container. Required
only for GFP and when the FRSIndicator is present.
FRSPaymentInformation_Type:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: 'Payer Type code for FRS Rate request. Valid Values are: 01
= Prepaid 02 = FreightCollect 03 = BillThirdParty'
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Text description of the code representing the GFP payment type.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: Type
description: GFP Payment Information Type container. GFP only.
FRSPaymentInformation_Address:
type: object
maximum: 1
properties:
PostalCode:
description: Postal Code for UPS accounts billing address. Postal Code may
be present when the FRS Payment Information type = 02 and type = 03.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: Country or Territory code for the UPS accounts & billing address. Country
or Territory Code is required when the FRS Payment Information type =
02 and type= 03.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
required:
- CountryCode
description: Payer Address Container. Address container may be present for
FRS Payment Information type = 02 and required when the FRS Payment Information
type = 03.
Shipment_FreightShipmentInformation:
type: object
properties:
FreightDensityInfo:
"$ref": "#/components/schemas/FreightShipmentInformation_FreightDensityInfo"
DensityEligibleIndicator:
description: The presence of the tag indicates that the rate request is
density based.For Density Based Rating (DBR), the customer must have DBR
Contract Service.
maximum: 1
type: string
xml:
name: FreightShipmentInformation
maximum: 1
description: Container to hold Freight Shipment information.
FreightShipmentInformation_FreightDensityInfo:
type: object
maximum: 1
properties:
AdjustedHeightIndicator:
description: The presence of the AdjustedHeightIndicator allows UPS to do
height reduction adjustment for density based rate request.
maximum: 1
type: string
AdjustedHeight:
"$ref": "#/components/schemas/FreightDensityInfo_AdjustedHeight"
HandlingUnits:
type: array
items:
"$ref": "#/components/schemas/FreightDensityInfo_HandlingUnits"
xml:
name: FreightDensityInfo
required:
- HandlingUnits
description: Freight Density Info container. Required if DensityEligibleIndicator
is present.
FreightDensityInfo_AdjustedHeight:
type: object
maximum: 1
required:
- UnitOfMeasurement
- Value
properties:
Value:
description: Adjusted Height value for the handling unit.
maximum: 1
type: string
minLength: 1
maxLength: 19
UnitOfMeasurement:
"$ref": "#/components/schemas/AdjustedHeight_UnitOfMeasurement"
xml:
name: AdjustedHeight
description: Container to hold Adjusted Height information. Required if AdjustedHeightIndicator
is present.
AdjustedHeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: Code associated with Unit of Measurement for the Adjusted height. Valid value is IN Unit of measurement code for Adjusted height is validated only when Handling unit type is SKD = Skid or PLT = Pallet.
maximum: 1
type: string
minLength: 1
maxLength: 2
Description:
description: Description for Code associated with Unit of Measurement for the Adjusted height.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: UnitOfMeasurement
description: Unit of Measurement container for the Adjusted height.
FreightDensityInfo_HandlingUnits:
type: object
required:
- Type
- Quantity
- Dimensions
properties:
Quantity:
description: Handling Unit Quantity for Density based rating.
maximum: 1
type: string
minLength: 8
maxLength: 8
Type:
"$ref": "#/components/schemas/HandlingUnits_Type"
Dimensions:
"$ref": "#/components/schemas/HandlingUnits_Dimensions"
xml:
name: HandlingUnits
description: Handling Unit for Density based rating container.
HandlingUnits_Type:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: 'The code associated with Handling Unit Type. Valid values:
SKD = Skid CBY = CarboyPLT = PalletTOT = TotesLOO = LooseOTH = Other'
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: A description of the code for the Handling Unit type.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: Type
description: Handling Unit Type for Density based rating.
HandlingUnits_Dimensions:
type: object
required:
- UnitOfMeasurement
- Length
- Height
- Width
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/HandlingUnits_UnitOfMeasurement"
Length:
description: The length of the line item used to determine dimensional weight.
maximum: 1
type: string
minLength: 1
maxLength: 19
Width:
description: The width of the line item used to determine dimensional weight.
maximum: 1
type: string
minLength: 1
maxLength: 19
Height:
description: The height of the line item used to determine dimensional weight.
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: Dimensions
maximum: 1
description: Dimension of the HandlingUnit container for density based pricing.
HandlingUnits_UnitOfMeasurement:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: Code for UnitOfMeasurement for the line item dimension. Valid value - IN = Inches
maximum: 1
type: string
minLength: 1
maxLength: 2
Description:
description: Description for UnitOfMeasurement for the line item dimension.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: UnitOfMeasurement
description: UnitOfMeasurement container.
Dimensions_UnitOfMeasurement:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: |
Package dimensions unit of measurement code.
Valid values:
- IN
- CM
maximum: 1
type: string
minLength: 1
maxLength: 2
Description:
description: Text description of the code representing the UnitOfMeasurement associated with the package. This element is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: UnitOfMeasurement
description: UnitOfMeasurement container.
Shipment_Service:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
The code for the UPS Service associated with the shipment.
NOTE: For a complete listing of values, refer to Service Codes in the Appendix
Valid domestic values:
- 01 = Next Day Air
- 02 = 2nd Day Air
- 03 = Ground
- 12 = 3 Day Select
- 13 = Next Day Air Saver
- 14 = UPS Next Day Air Early
- 59 = 2nd Day Air A.M.
- 75 = UPS Heavy Goods
Valid international values:
- 07 = Worldwide Express
- 08 = Worldwide Expedited
- 11= Standard
- 54 = Worldwide Express Plus
- 65 = Saver
- 96 = UPS Worldwide Express Freight
- 71 = UPS Worldwide Express Freight Midday
Required for Rating and ignored for Shopping.
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: A text description of the UPS Service associated with the shipment. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: Service
description: Service Container. Only valid with RequestOption = Rate for both
Small package and GFP Rating requests.
Shipment_NumOfPieces:
description: Total number of pieces in all pallets. Required for UPS Worldwide
Express Freight and UPS Worldwide Express Freight Midday shipments.
maximum: 1
type: string
minLength: 1
maxLength: 5
Shipment_ShipmentTotalWeight:
type: object
required:
- UnitOfMeasurement
- Weight
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/ShipmentTotalWeight_UnitOfMeasurement"
Weight:
description: Non-zero total weight of all packages in the shipment.
type: string
xml:
name: ShipmentTotalWeight
description: Shipment Total Weight Container. This container is only applicable
for "ratetimeintransit" and "shoptimeintransit" request options. Required
for all international shipments when retreiving time in transit information,
including letters and documents shipments.
maximum: 1
ShipmentTotalWeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: |
Code representing the unit of measure associated with the package weight.
Valid values:
- LBS = Pounds
- KGS = Kilograms.
type: string
minLength: 1
maxLength: 3
maximum: 1
Description:
description: Text description of the code representing the unit of measure associated with the shipment weight.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: UnitOfMeasurement
description: UnitOfMeasurement Container.
Shipment_DocumentsOnlyIndicator:
description: 'Valid values are Document and Non-document. If the indicator is
present then the value is Document else Non-Document. Note: Not applicable
for FRS rating requests. Empty Tag.'
maximum: 1
type: string
Shipment_Package:
type: object
properties:
PackagingType:
"$ref": "#/components/schemas/Package_PackagingType"
Dimensions:
"$ref": "#/components/schemas/Package_Dimensions"
DimWeight:
"$ref": "#/components/schemas/Package_DimWeight"
PackageWeight:
"$ref": "#/components/schemas/Package_PackageWeight"
Commodity:
"$ref": "#/components/schemas/Package_Commodity"
LargePackageIndicator:
description: This element does not require a value and if one is entered
it will be ignored. If present, it indicates the shipment will be categorized
as a Large Package.
maximum: 1
type: string
PackageServiceOptions:
"$ref": "#/components/schemas/Package_PackageServiceOptions"
AdditionalHandlingIndicator:
description: A flag indicating if the packages require additional handling. True if AdditionalHandlingIndicator tag exists; false otherwise. Additional Handling indicator indicates it's a non-corrugated package. Empty Tag.
maximum: 1
type: string
SimpleRate:
"$ref": "#/components/schemas/Package_SimpleRate"
UPSPremier:
"$ref": "#/components/schemas/Package_UPSPremier"
OversizeIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. It
indicates if packge is oversized. Applicable for UPS Worldwide Economy
DDU service
maximum: 1
type: string
MinimumBillableWeightIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. It
indicates if packge is qualified for minimum billable weight. Applicable
for UPS Worldwide Economy DDU service
maximum: 1
type: string
xml:
name: Package
maximum: 1
description: Package Container. Only one Package allowed for Simple Rate
Package_PackagingType:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
The code for the UPS packaging type associated with the package. Valid values:
- 00 - UNKNOWN
- 01 - UPS Letter
- 02 - Package
- 03 - Tube
- 04 - Pak
- 21 - Express Box
- 24 - 25KG Box
- 25 - 10KG Box
- 30 - Pallet
- 2a - Small Express Box
- 2b - Medium Express Box
- 2c - Large Express Box.
For FRS rating requests the only valid value is customer supplied packaging “02”.
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: A text description of the code for the UPS packaging type associated
with the shipment. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: PackagingType
description: Packaging Type Container.
Package_Dimensions:
type: object
required:
- UnitOfMeasurement
- Length
- Height
- Width
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/Dimensions_UnitOfMeasurement"
Length:
description: |
Length of the package used to determine dimensional weight. Required for GB to GB and Poland to Poland shipments.
6 digits in length with 2 digits of significance after the decimal point.
maximum: 1
type: string
minLength: 1
maxLength: 9
Width:
description: |
Width of the package used to determine dimensional weight. Required for GB to GB and Poland to Poland shipments.
6 digits in length with 2 digits of significance after the decimal point.
maximum: 1
type: string
minLength: 1
maxLength: 9
Height:
description: |
Height of the package used to determine dimensional weight. Required for GB to GB and Poland to Poland shipments.
6 digits in length with 2 digits of significance after the decimal point.
maximum: 1
type: string
minLength: 1
maxLength: 9
xml:
name: Dimensions
maximum: 1
description: Dimensions Container. This container is not applicable for GFP
Rating request. Required for Heavy Goods service. Package Dimension will
be ignored for Simple Rate
Package_DimWeight:
type: object
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/DimWeight_UnitOfMeasurement"
Weight:
description: Dimensional weight of the package. Decimal values are not accepted,
however there is one implied decimal place for values in this field (i.e.
115 = 11.5).
maximum: 1
type: string
minLength: 1
maxLength: 6
xml:
name: DimWeight
maximum: 1
description: Package Dimensional Weight container. Values in this container
are ignored when package dimensions are provided. Please visit ups.com for
instructions on calculating this value. Only used for non-US/CA/PR shipments.
DimWeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: |
Code representing the unit of measure associated with the package weight.
Valid values:
- LBS - Pounds
- KGS - Kilograms.
type: string
minLength: 1
maxLength: 3
maximum: 1
Description:
description: Text description of the code representing the unit of measure associated with the package weight. Length and value are not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: UnitOfMeasurement
description: UnitOfMeasurement Container.
Package_PackageWeight:
type: object
required:
- UnitOfMeasurement
- Weight
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/PackageWeight_UnitOfMeasurement"
Weight:
description: Actual package weight. Weight accepted for letters/envelopes.
maximum: 1
type: string
minLength: 1
maxLength: 6
xml:
name: PackageWeight
maximum: 1
description: Package Weight Container. Required for an GFP Rating request.
Otherwise optional. Required for Heavy Goods service. Package Weight will
be ignored for Simple Rate
PackageWeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: |
Code representing the unit of measure associated with the package weight.
Unit of Measurement "OZS" is the only valid UOM for Worldwide Economy DDU Shipments.
Valid values:
- LBS - Pounds (default)
- KGS - Kilograms
- OZS - Ounces
type: string
minLength: 1
maxLength: 3
maximum: 1
Description:
description: Text description of the code representing the unit of measure associated with the package weight. Length and value are not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: UnitOfMeasurement
description: UnitOfMeasurement Container.
Package_Commodity:
type: object
maximum: 1
required:
- FreightClass
properties:
FreightClass:
description: Freight Classification. Freight class partially determines
the freight rate for the article. See Appendix of the Rating Ground Freight
Web Services Developers Guide for list of Freight classes. For GFP Only.
maximum: 1
type: string
minLength: 10
maxLength: 10
NMFC:
"$ref": "#/components/schemas/Commodity_NMFC"
xml:
name: Commodity
description: Commodity Container. Required only for GFP rating when FRSShipmentIndicator
is requested.
Commodity_NMFC:
type: object
maximum: 1
required:
- PrimeCode
properties:
PrimeCode:
description: Value of NMFC Prime. Contact your service representative if
you need information concerning NMFC Codes. Required if NMFC Container
is present. For GFP Only.
maximum: 1
type: string
minLength: 4
maxLength: 6
SubCode:
description: Value of NMFC Sub. Contact your service representative if you
need information concerning NMFC Codes. Needs to be provided when the
SubCode associated with the PrimeCode is other than 00. API defaults the
sub value to 00 if not provided. If provided the Sub Code should be associated
with the PrimeCode of the NMFC.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: NMFC
description: NMFC Commodity container. For GFP Only.
Package_PackageServiceOptions:
type: object
properties:
DeliveryConfirmation:
"$ref": "#/components/schemas/PackageServiceOptions_DeliveryConfirmation"
AccessPointCOD:
"$ref": "#/components/schemas/PackageServiceOptions_AccessPointCOD"
COD:
"$ref": "#/components/schemas/PackageServiceOptions_COD"
DeclaredValue:
"$ref": "#/components/schemas/PackageServiceOptions_DeclaredValue"
ShipperDeclaredValue:
"$ref": "#/components/schemas/PackageServiceOptions_ShipperDeclaredValue"
ShipperReleaseIndicator:
description: The presence indicates that the package may be released by
driver without a signature from the consignee. Empty Tag. Only available
for US50/PR to US50/PR packages without return service.
maximum: 1
type: string
ProactiveIndicator:
description: Any value associated with this element will be ignored. If
present, the package is rated for UPS Proactive Response and proactive
package tracking.Contractual accessorial for health care companies to
allow package monitoring throughout the UPS system. Shippers account
needs to have valid contract for UPS Proactive Response.
maximum: 1
type: string
RefrigerationIndicator:
description: Presence/Absence Indicator. Any value is ignored. If present,
indicates that the package contains an item that needs refrigeration. Shippers
account needs to have a valid contract for Refrigeration.
maximum: 1
type: string
Insurance:
"$ref": "#/components/schemas/PackageServiceOptions_Insurance"
UPSPremiumCareIndicator:
description: |
The UPSPremiumCareIndicator indicates special handling is required for shipment having controlled substances. Empty Tag means indicator is present.
Valid only for Canada to Canada movements.
Available for the following Return Services:
- Returns Exchange (available with a contract)
- Print Return Label
- Print and Mail
- Electronic Return Label
- Return Service Three Attempt
May be requested with following UPS services:
- UPS Express® Early
- UPS Express
- UPS Express Saver
- UPS Standard.
Not available for packages with the following:
- Delivery Confirmation - Signature Required
- Delivery Confirmation - Adult Signature Required.
maximum: 1
type: string
HazMat:
"$ref": "#/components/schemas/PackageServiceOptions_HazMat"
DryIce:
"$ref": "#/components/schemas/PackageServiceOptions_DryIce"
xml:
name: PackageServiceOptions
maximum: 1
description: PackageServiceOptions container.
PackageServiceOptions_DeliveryConfirmation:
type: object
maximum: 1
required:
- DCISType
properties:
DCISType:
description: 'Type of delivery confirmation. Valid values: 1 - Unsupported
2 - Delivery Confirmation Signature Required 3 - Delivery Confirmation
Adult Signature Required'
maximum: 1
type: string
minLength: 1
maxLength: 1
xml:
name: DeliveryConfirmation
description: Delivery Confirmation Container. For a list of valid origin/destination
countries or territories please refer to appendix. DeliveryConfirmation and
COD are mutually exclusive.
PackageServiceOptions_AccessPointCOD:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Access Point COD Currency Code. Required if Access Point COD
container is present. UPS does not support all international currency
codes. Refer to the appendix for a list of valid codes.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: |
Access Point COD Monetary Value. Required if Access Point COD container is present.
8 digits prior to the decimal place and 2 after.
maximum: 1
type: string
minLength: 2
maxLength: 11
xml:
name: AccessPointCOD
description: 'Access Point COD indicates Package COD is requested for a shipment. Valid
only for : 01 - Hold For Pickup At UPS Access Point, Shipment Indication type.
Package Access Point COD is valid only for shipment without return service
from US/PR to US/PR and CA to CA. Not valid with (Package) COD.'
PackageServiceOptions_COD:
type: object
maximum: 1
required:
- CODFundsCode
- CODAmount
properties:
CODFundsCode:
description: Indicates the type of funds that will be used for the C.O.D. payment. For valid values, refer to Rating and Shipping COD Supported Countries or Territories in the Appendix.
maximum: 1
type: string
minLength: 1
maxLength: 1
CODAmount:
"$ref": "#/components/schemas/COD_CODAmount"
xml:
name: COD
description: 'COD Container. Indicates COD is requested. Valid for the following
country or territory combinations: US/PR to US/PRCA to CACA to USNot allowed
for CA to US for packages that are designated as Letters or Envelopes.'
COD_CODAmount:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Currency Code. Required if a value for the COD amount exists in the MonetaryValue tag. Must match one of the IATA currency codes. UPS does not support all international currency codes. Refer to Currency Codes in the Appendix for a list of valid codes.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: The COD value for the package. Required if COD option is present. The maximum amount allowed is 50,000 USD.
maximum: 1
type: string
minLength: 8
maxLength: 8
xml:
name: CODAmount
description: CODAmount Container.
PackageServiceOptions_DeclaredValue:
type: object
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the declared value amount
for the package. Required if a value for the package declared value amount
exists in the MonetaryValue tag. Must match one of the IATA currency codes.
Length is not validated. UPS does not support all international currency
codes. Refer to Currency Codes in the Appendix for a list of valid codes.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: The monetary value for the declared value amount associated
with the package. Max value of 5,000 USD for Local and 50,000 USD for
Remote. Absolute maximum value is 21474836.47
maximum: 1
type: string
minLength: 8
maxLength: 8
xml:
name: DeclaredValue
description: Declared Value Container.
PackageServiceOptions_ShipperDeclaredValue:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the amount for the package. UPS
does not support all international currency codes. Refer to the appendix
for a list of valid codes.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: The monetary value for the amount associated with the package.
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: ShipperDeclaredValue
description: Shipper Paid Declared Value Charge at Package level. Valid for
UPS World Wide Express Freight shipments.
PackageServiceOptions_Insurance:
type: object
maximum: 1
properties:
BasicFlexibleParcelIndicator:
"$ref": "#/components/schemas/Insurance_BasicFlexibleParcelIndicator"
ExtendedFlexibleParcelIndicator:
"$ref": "#/components/schemas/Insurance_ExtendedFlexibleParcelIndicator"
TimeInTransitFlexibleParcelIndicator:
"$ref": "#/components/schemas/Insurance_TimeInTransitFlexibleParcelIndicator"
PackageProtection:
"$ref": "#/components/schemas/Insurance_PackageProtection"
description: Insurance Accesorial. Only one type of insurance can exist at a time on the shipment. Valid for UPS World Wide Express Freight shipments.
Insurance_BasicFlexibleParcelIndicator:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the amount for the package. UPS
does not support all international currency codes. Refer to the appendix
for a list of valid codes. Valid for UPS World Wide Express Freight shipments.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: The monetary value associated with the package. Valid for
UPS World Wide Express Freight shipments.
maximum: 1
type: string
minLength: 8
maxLength: 8
xml:
name: BasicFlexibleParcelIndicator
description: Container to hold Basic Flexible Parcel Indicator information. Valid
for UPS World Wide Express Freight shipments.
Insurance_ExtendedFlexibleParcelIndicator:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the amount for the package. UPS
does not support all international currency codes. Refer to the appendix
for a list of valid codes. Valid for UPS World Wide Express Freight shipments.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: The monetary value associated with the package. Valid for
UPS World Wide Express Freight shipments.
maximum: 1
type: string
minLength: 8
maxLength: 8
xml:
name: ExtendedFlexibleParcelIndicator
description: Container for Extended Flexible Parcel Indicator Valid for UPS
World Wide Express Freight shipments.
Insurance_TimeInTransitFlexibleParcelIndicator:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the amount for the package. UPS
does not support all international currency codes. Refer to the appendix
for a list of valid codes. Valid for UPS World Wide Express Freight shipments.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: The monetary value associated with the package. Valid for
UPS World Wide Express Freight shipments.
maximum: 1
type: string
minLength: 8
maxLength: 8
xml:
name: TimeInTransitFlexibleParcelIndicator
description: Container to hold Time In Transit Flexible Parcel Indicator information. Valid
for UPS World Wide Express Freight shipments.
Insurance_PackageProtection:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Required if a value for the package declared value amount exists in the MonetaryValue tag.
Must match one of the IATA currency codes. Length is not validated. UPS does not support all international currency codes.
Refer to Currency Codes in the Appendix for a list of valid codes.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: The monetary value for the PackageProtection amount associated with the package.
maximum: 1
type: string
minLength: 8
maxLength: 8
PackageServiceOptions_HazMat:
type: object
maximum: 1
properties:
PackageIdentifier:
description: Identifies the package containing Dangerous Goods. Required
if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 5
QValue:
description: 'QValue is required when a HazMat shipment specifies AllPackedInOneIndicator
and the regulation set for that shipment is IATA. Applies only if SubVersion
is greater than or equal to 1701. Valid values are : 0.1; 0.2; 0.3; 0.4;
0.5; 0.6; 0.7; 0.8; 0.9; 1.0'
maximum: 1
type: string
minLength: 3
maxLength: 3
OverPackedIndicator:
description: Presence/Absence Indicator. Any value is ignored. Presence
indicates that shipment is overpack. Applies only if SubVersion is greater
than or equal to 1701.
maximum: 1
type: string
AllPackedInOneIndicator:
description: Presence/Absence Indicator. Any value is ignored. Indicates
the hazmat shipment/package is all packed in one. Applies only if SubVersion
is greater than or equal to 1701.
maximum: 1
type: string
HazMatChemicalRecord:
maximum: 3
type: array
items:
"$ref": "#/components/schemas/HazMat_HazMatChemicalRecord"
xml:
name: HazMat
required:
- HazMatChemicalRecord
description: Container to hold HazMat information. Applies only if SubVersion
is greater than or equal to 1701.
HazMat_HazMatChemicalRecord:
type: object
properties:
ChemicalRecordIdentifier:
description: Identifies the Chemcial Record. Required if SubVersion is
greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 3
ClassDivisionNumber:
description: "This is the hazard class associated to the specified commodity. Required if CommodityRegulatedLevelCode is 'LQ' or 'FR' Applies only if SubVersion is greater than or equal to 1701."
maximum: 1
type: string
minLength: 1
maxLength: 7
IDNumber:
description: This is the ID number (UN/NA/ID) for the specified commodity.
Required if CommodityRegulatedLevelCode = LR, LQ or FR and if the field
applies to the material by regulation. UN/NA/ID Identification Number
assigned to the specified regulated good. (Include the UN/NA/ID as part
of the entry). Applies only if SubVersion is greater than or equal to
1701.
maximum: 1
type: string
minLength: 1
maxLength: 6
TransportationMode:
description: 'The method of transport by which a shipment is approved to
move and the regulations associated with that method. Only required when
the CommodityRegulatedLevelCode is FR or LQ.Valid values: 01 - Highway02
- Ground03 - Passenger Aircraft04 - Cargo Aircraft Only Applies only
if SubVersion is greater than or equal to 1701. For multiple ChemicalRecords
per package having different TransportationMode, TransportationMode of
first ChemicalRecord would be considered for validating and rating the
package. All TransportationMode except for ''04'' are general service
offering. If any chemical record contains ''04'' as TransportationMode,
ShipperNumber needs to be authorized to use ''04'' as TransportationMode.'
maximum: 1
type: string
minLength: 2
maxLength: 2
RegulationSet:
description: 'The Regulatory set associated with every regulated shipment.
It must be the same across the shipment. Valid values: ADR - For Europe
to Europe Ground Movement CFR - For HazMat regulated by US Dept. of Transportation
within the U.S. or ground shipments to Canada, IATA - For Worldwide Air
movement TDG - For Canada to Canada ground movement or Canada to U.S.
standard movement Applies only if SubVersion is greater than or equal
to 1701. For multiple ChemicalRecords per package or multiple packages
containing different RegulationSet, RegulationSet of first ChemicalRecord
would be considered for validating and rating the entire shipment.'
maximum: 1
type: string
minLength: 3
maxLength: 4
EmergencyPhone:
description: 24 Hour Emergency Phone Number of the shipper. Valid values
for this field are (0) through (9) with trailing blanks. For numbers within
the U.S., the layout is '1', area code, 7-digit number. For all other
countries or territories the layout is country or territory code, area
code, number. Applies only if SubVersion is greater than or equal to
1701.
maximum: 1
type: string
minLength: 1
maxLength: 25
EmergencyContact:
description: The emergency information, contact name and/or contact number,
required to be communicated when a call is placed to the EmergencyPhoneNumber.
The information is required if there is a value in the EmergencyPhoneNumber
field above and the shipment is with a US50 or PR origin and/or destination
and the RegulationSet is IATA. Applies only if SubVersion is greater
than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 35
ReportableQuantity:
description: Required if CommodityRegulatedLevelCode = LQ or FR and if the
field applies to the material by regulation. If reportable quantity is
met, 'RQ' should be entered. Applies only if SubVersion is greater than
or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 2
SubRiskClass:
description: Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma). Applies only if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 100
PackagingGroupType:
description: This is the packing group category associated to the specified
commodity. Required if CommodityRegulatedLevelCode = LQ or FR and if the
field applies to the material by regulation. Must be shown in Roman Numerals.Valid
values are:I, II,III,blank. Applies only if SubVersion is greater than
or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 10
Quantity:
description: Required if CommodityRegulatedLevelCode = LQ or FR. The numerical
value of the mass capacity of the regulated good. Applies only if SubVersion
is greater than or equal to 1701.
maximum: 1
type: string
minLength: 15
maxLength: 15
UOM:
description: 'Required if CommodityRegulatedLevelCode = LQ or FR. The unit
of measure used for the mass capacity of the regulated good. For Example:
ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc. Applies
only if SubVersion is greater than or equal to 1701.'
maximum: 1
type: string
minLength: 1
maxLength: 10
PackagingInstructionCode:
description: The packing instructions related to the chemical record. Required
if CommodityRegulatedLevelCode = LQ or FR and if the field applies to
the material by regulation. Applies only if SubVersion is greater than
or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 353
ProperShippingName:
description: The Proper Shipping Name assigned by ADR, CFR or IATA. Required
if CommodityRegulatedLevelCode = LR, LQ or FR. Applies only if SubVersion
is greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 250
TechnicalName:
description: The technical name (when required) for the specified commodity.
Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies
to the material by regulation. Applies only if SubVersion is greater
than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 300
AdditionalDescription:
description: |
Additional remarks or special provision information. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.
Additional information that may be required by regulation about a hazardous material, such as, "Limited Quantity", DOT-SP numbers, EX numbers. Applies only if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 75
PackagingType:
description: 'The package type code identifying the type of packaging used
for the commodity. (Ex: Fiberboard Box). Required if CommodityRegulatedLevelCode
= LQ or FR. Applies only if SubVersion is greater than or equal to 1701.'
maximum: 1
type: string
minLength: 1
maxLength: 255
HazardLabelRequired:
description: Defines the type of label that is required on the package for
the commodity. Not applicable if CommodityRegulatedLevelCode = LR or EQ. Applies
only if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 50
PackagingTypeQuantity:
description: The number of pieces of the specific commodity. Required if
CommodityRegulatedLevelCode = LQ or FR.Valid values are 1 to 999. Applies
only if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 3
CommodityRegulatedLevelCode:
description: Indicates the type of commodity - Fully Regulated (FR), Limited
Quantity (LQ), Excepted Quantity (EQ), Lightly Regulated (LR). Default
value is FR.Valid values are LR, FR, LQ, EQ. Applies only if SubVersion
is greater than or equal to 1701.
maximum: 1
type: string
minLength: 2
maxLength: 2
TransportCategory:
description: Transport Category.Valid values are 0 to 4. Applies only if
SubVersion is greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 1
TunnelRestrictionCode:
description: Defines what is restricted to pass through a tunnel. Applies
only if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 10
xml:
name: HazMatChemicalRecord
required:
- TransportationMode
- RegulationSet
description: Container to hold HazMat Chemical Records.
PackageServiceOptions_DryIce:
type: object
maximum: 1
required:
- DryIceWeight
- RegulationSet
properties:
RegulationSet:
description: 'Regulation set for DryIce Shipment. Valid values: CFR = For
HazMat regulated by US Dept of Transportation within the U.S. or ground
shipments to Canada, IATA = For Worldwide Air movement, ADR = For EMEA
Ground movement on Standard service. The following values are valid:
CFR, IATA and ADR.'
maximum: 1
type: string
minLength: 3
maxLength: 4
DryIceWeight:
"$ref": "#/components/schemas/DryIce_DryIceWeight"
MedicalUseIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. Relevant
only in CFR regulation set. If present it is used to designate the Dry
Ice is for any medical use and rates are adjusted for DryIce weight more
than 2.5 KGS or 5.5 LBS.
maximum: 1
type: string
AuditRequired:
description: Presence/Absence Indicator. Any value inside is ignored. Indicates
a Dry Ice audit will be performed per the Regulation Set requirements.
Empty tag means indicator is present.
maximum: 1
type: string
xml:
name: DryIce
description: Container to hold Dry Ice information. Lane check will happen
based on postal code/ city.
DryIce_DryIceWeight:
type: object
required:
- UnitOfMeasurement
- Weight
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/DryIceWeight_UnitOfMeasurement"
Weight:
description: Weight for Dry Ice. Cannot be more than package weight. Should
be more than 0.0. Valid characters are 0-9 and "." (Decimal point). Limit
to 1 digit after the decimal. The maximum length of the field is 5 including
"." and can hold up to 1 decimal place.
maximum: 1
type: string
minLength: 1
maxLength: 5
xml:
name: DryIceWeight
maximum: 1
description: Container for Weight information for Dry Ice.
DryIceWeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: |
DryIce weight unit of measurement code. Valid values:
- 00 - KG (Metric Unit of Measurements) or KGS
- 01 - LB (English Unit of Measurements) or LBS
maximum: 1
type: string
minLength: 1
maxLength: 2
Description:
description: Text description of the code representing the unit of measure associated with the package.
maximum: 1
type: string
minLength: 1
maxLength: 20
xml:
name: UnitOfMeasurement
description: Container for Unit Of Measurement for Dry Ice.
Package_SimpleRate:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: 'Simple Rate Package Size Valid values: XS - Extra Small S
- Small M - Medium L - Large XL - Extra Large'
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: Simple Rate Package Size Description
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: SimpleRate
description: SimpleRate Container
Package_UPSPremier:
type: object
maximum: 1
required:
- Category
properties:
Category:
description: UPS Premier Category Valid values are 01,02,03 UPS Premier
Silver - 01 UPS Premier Gold - 02 UPS Premier Platinum - 03
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: UPSPremier
description: UPS Premier
Shipment_ShipmentServiceOptions:
type: object
maximum: 1
properties:
GlobalCheckoutIndicator:
description: A flag indicating if the shipment requires a GlobalCheckoutIndicator.
True if GlobalCheckoutIndicator tag exists; false otherwise Empty Tag.
maximum: 1
type: string
SaturdayPickupIndicator:
description: A flag indicating if the shipment requires a Saturday pickup.
True if SaturdayPickupIndicator tag exists; false otherwise. Not available
for GFP rating requests. Empty Tag.
maximum: 1
type: string
SaturdayDeliveryIndicator:
description: A flag indicating if a shipment must be delivered on a Saturday.
True if SaturdayDeliveryIndicator tag exists; false otherwise Empty Tag.
maximum: 1
type: string
SundayDeliveryIndicator:
description: A flag indicating if a shipment must be delivered on a Sunday.
True if SundayDeliveryIndicator tag exists; false otherwise Empty Tag.
maximum: 1
type: string
AvailableServicesOption:
description: If we need diferent available services in response, this option
is used for shop request option. SaturdayDeliveryIndicator/ SundayDeliveryIndicator
will be ignored in that case. Valid Values:1- Weekday+Saturday services2-
Weekday+Sunday services3- Weekday+Sat services+Sun services
maximum: 1
type: string
minLength: 1
maxLength: 1
AccessPointCOD:
"$ref": "#/components/schemas/ShipmentServiceOptions_AccessPointCOD"
DeliverToAddresseeOnlyIndicator:
description: |
Presence/Absence Indicator. Any value inside is ignored.
DeliverToAddresseeOnlyIndicator is shipper specified restriction that requires the addressee to be the one who takes final delivery of the "Hold For PickUp at UPS Access Point" package.
Presence of indicator means shipper restriction will apply to the shipment. Only valid for Shipment Indication type "01 - Hold For PickUp at UPS Access Point".
maximum: 1
type: string
DirectDeliveryOnlyIndicator:
description: |
Presence/Absence Indicator. Any value inside is ignored. Direct Delivery Only (DDO) accessorial in a request would ensure that delivery is made only to the Ship To address on the shipping label. This accessorial is not valid with Shipment Indication Types:
- 01 - Hold For Pickup At UPS Access Point
- 02 - UPS Access Point™ Delivery
maximum: 1
type: string
COD:
"$ref": "#/components/schemas/ShipmentServiceOptions_COD"
DeliveryConfirmation:
"$ref": "#/components/schemas/ShipmentServiceOptions_DeliveryConfirmation"
ReturnOfDocumentIndicator:
description: Return of Documents Indicator - If the flag is present, the
shipper has requested the ReturnOfDocument accessorial be added to the
shipment Valid for Poland to Poland shipment.
maximum: 1
type: string
UPScarbonneutralIndicator:
description: UPS carbon neutral indicator. Indicates the shipment will be
rated as carbon neutral.
maximum: 1
type: string
CertificateOfOriginIndicator:
description: The empty tag in request indicates that customer would be using
UPS prepared SED form. Valid for UPS World Wide Express Freight shipments.
maximum: 1
type: string
PickupOptions:
"$ref": "#/components/schemas/ShipmentServiceOptions_PickupOptions"
DeliveryOptions:
"$ref": "#/components/schemas/ShipmentServiceOptions_DeliveryOptions"
RestrictedArticles:
"$ref": "#/components/schemas/ShipmentServiceOptions_RestrictedArticles"
ShipperExportDeclarationIndicator:
description: The empty tag in request indicates that customer would be using
UPS prepared SED form. Valid for UPS World Wide Express Freight shipments.
maximum: 1
type: string
CommercialInvoiceRemovalIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. CommercialInvoiceRemovalIndicator
- empty tag means indicator is present. CommercialInvoiceRemovalIndicator
allows a shipper to dictate that UPS remove the Commercial Invoice from
the user's shipment before the shipment is delivered to the ultimate consignee.
maximum: 1
type: string
ImportControl:
"$ref": "#/components/schemas/ShipmentServiceOptions_ImportControl"
ReturnService:
"$ref": "#/components/schemas/ShipmentServiceOptions_ReturnService"
SDLShipmentIndicator:
description: Empty Tag means the indicator is present. This field is a flag
to indicate if the receiver needs SDL rates in response. True if SDLShipmentIndicator
tag exists; false otherwise. If present, the State Department License
(SDL) rates will be returned in the response.This service requires that
the account number is enabled for SDL.
maximum: 1
type: string
EPRAIndicator:
description: |
For valid values, refer to Rating and Shipping COD Supported Countries or Territories in the Appendix.Presence/Absence Indicator. Any value inside is ignored. This field is a flag to indicate Package Release Code is requested for shipment.
This accessorial is only valid with ShipmentIndicationType '01' - Hold for Pickup at UPS Access Point™.
maximum: 1
type: string
InsideDelivery:
description: |
Inside Delivery accessory. Valid values:
- 01 - White Glove
- 02 - Room of Choice
- 03 - Installation Shippers account needs to have a valid contract for Heavy Goods Service.
maximum: 1
type: string
minLength: 2
maxLength: 2
ItemDisposalIndicator:
description: Presence/Absence Indicator. Any value inside is ignored. If
present, indicates that the customer would like items disposed. Shippers
account needs to have a valid contract for Heavy Goods Service.
maximum: 1
type: string
xml:
name: ShipmentServiceOptions
description: Shipment level Accessorials are included in this container.
ShipmentServiceOptions_AccessPointCOD:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Access Point COD Currency Code. Required if Access Point COD
container is present. UPS does not support all international currency
codes. Refer to the appendix for a list of valid codes.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: |
Access Point COD Monetary Value. Required if Access Point COD container is present.
8 digits prior to the decimal place and 2 after.
maximum: 1
type: string
minLength: 2
maxLength: 11
xml:
name: AccessPointCOD
description: |
Access Point COD indicates Shipment level Access Point COD is requested for a shipment. Valid only for "01 - Hold For Pickup At UPS Access Point" Shipment Indication type.
Shipment Access Point COD is valid only for countries or territories within E.U.
Not valid with (Shipment) COD.
Not available to shipment with return service.
ShipmentServiceOptions_COD:
type: object
maximum: 1
required:
- CODFundsCode
- CODAmount
properties:
CODFundsCode:
description: For valid values, refer to Rating and Shipping COD Supported Countries or Territories in the Appendix.
maximum: 1
type: string
minLength: 1
maxLength: 1
CODAmount:
"$ref": "#/components/schemas/ShipmentServiceOptions_COD_CODAmount"
xml:
name: COD
description: If present, indicates C.O.D. is requested for the shipment. Shipment
level C.O.D. is only available for EU origin countries or territories.C.O.D.
shipments are only available for Shippers with Daily Pickup and Drop Shipping
accounts.
ShipmentServiceOptions_COD_CODAmount:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: COD amount currency code type.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: COD Amount.
maximum: 1
type: string
minLength: 8
maxLength: 8
xml:
name: CODAmount
description: CODAmount Container. UPS does not support all international currency codes. Refer to the appendix for a list of valid codes.
ShipmentServiceOptions_DeliveryConfirmation:
type: object
maximum: 1
required:
- DCISType
properties:
DCISType:
description: 'Type of delivery confirmation. Valid values: 1 - Delivery
Confirmation Signature Required 2 - Delivery Confirmation Adult Signature
Required'
type: string
xml:
name: DeliveryConfirmation
description: Delivery Confirmation Container. DeliveryConfirmation and C.O.D.
are mutually exclusive. Refer to the Appendix for a list of valid origin-destination
country or territory pairs associated with each confirmation type.
ShipmentServiceOptions_PickupOptions:
type: object
maximum: 1
properties:
LiftGateAtPickupIndicator:
description: The presence of the tag LiftGatePickupRequiredIndicator indicates
that the shipment requires a lift gate for pickup.
maximum: 1
type: string
HoldForPickupIndicator:
description: The presence of the tag HoldForPickupIndicator indicates that
the user opted to hold the shipment at UPS location for pickup.
maximum: 1
type: string
xml:
name: PickupOptions
description: Shipment Service Pickup Options Container. Valid for UPS Worldwide
Express Freight and UPS Worldwide Express Freight Midday shipments.
ShipmentServiceOptions_DeliveryOptions:
type: object
maximum: 1
properties:
LiftGateAtDeliveryIndicator:
description: The presence of the tag LiftGateAtDeliveryIndicator indicates
that the shipment requires a lift gate for delivery.
maximum: 1
type: string
DropOffAtUPSFacilityIndicator:
description: The presence of the tag DropOffAtUPSFacilityIndicator indicates
the package will be dropped at a UPS facility for shipment.
maximum: 1
type: string
xml:
name: DeliveryOptions
description: Shipment Service Delivery Options Container. Valid for UPS Worldwide
Express Freight and UPS Worldwide Express Freight Midday shipments.
ShipmentServiceOptions_RestrictedArticles:
type: object
maximum: 1
properties:
AlcoholicBeveragesIndicator:
description: This field is a flag to indicate if the package has Alcohol.
True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
DiagnosticSpecimensIndicator:
description: This field is a flag to indicate if the package has Biological
substances. True if present; false otherwise. Valid for UPS World Wide
Express Freight shipments. Lane check will happen based on postal code/
city.
maximum: 1
type: string
PerishablesIndicator:
description: This field is a flag to indicate if the package has Perishables.
True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
PlantsIndicator:
description: This field is a flag to indicate if the package has Plants.
True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
SeedsIndicator:
description: This field is a flag to indicate if the package has Seeds.
True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
SpecialExceptionsIndicator:
description: This field is a flag to indicate if the package has Special
Exceptions Restricted Materials. True if present; false otherwise. Valid
for UPS World Wide Express Freight shipments.
maximum: 1
type: string
TobaccoIndicator:
description: This field is a flag to indicate if the package has Tobacco.
True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
ECigarettesIndicator:
description: This field is a flag to indicate if the package has E-Cigarettes.
True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
HempCBDIndicator:
description: This field is a flag to indicate if the package has Hemp/CBD.
True if present; false otherwise. Valid for UPS World Wide Express Freight
shipments.
maximum: 1
type: string
xml:
name: RestrictedArticles
description: Restricted Articles container. Valid for UPS World Wide Express
Freight shipments.
ShipmentServiceOptions_ImportControl:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: 'Code for type of Import Control shipment. Valid values are:
ImportControl One-Attempt ''03'' = ImportControl Three-Attempt''04'' = ImportControl Electronic Label ''05''
= ImportControl Print Label.'
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: Text description of the code representing the Import Control
associated with the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: ImportControl
description: Container for type of Import Control shipments.
ShipmentServiceOptions_ReturnService:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: Code for type of Return shipment. Valid values are:'3' =UPS One-Attempt Return Label'5' = UPS
Three Attempt Return Label'8' = UPS Electronic Return Label'9' = UPS Print
Return Label'10' = UPS Exchange Print Return Label '11'
= UPS Pack & Collect Service 1-Attempt Box 1 '12' = UPS Pack & Collect
Service 1-Attempt Box 2 '13' = UPS Pack & Collect Service 1-Attempt Box
3 '14' = UPS Pack & Collect Service 1-Attempt Box 4 '15' = UPS Pack &
Collect Service 1-Attempt Box 5 '16' = UPS Pack & Collect Service 3-Attempt
Box 1 '17' = UPS Pack & Collect Service 3-Attempt Box 2 '18' = UPS Pack
& Collect Service 3-Attempt Box 3 '19' = UPS Pack & Collect Service 3-Attempt
Box 4 '20' = UPS Pack & Collect Service 3-Attempt Box 5 10 = UPS Exchange
Print Return Label and 5 = UPS Three Attempt Return Label are not valid
for UPS WorldWide Express Freight and UPS Worldwide Express Freight Midday
Services. 3 = UPS One-Attempt Return Label is not valid return service
with UPS Premium Care accessorial.
maximum: 1
type: string
minLength: 1
maxLength: 2
Description:
description: Description for type of Return Service.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: ReturnService
description: Container for type of Return Services.
Shipment_ShipmentRatingOptions:
type: object
maximum: 1
properties:
NegotiatedRatesIndicator:
description: 'NegotiatedRatesIndicator - Required to display two types
of discounts: 1) Bids or Account Based Rates2) Web/Promotional Discounts
BidsAccount Based Rates: If the indicator is present, the Shipper is authorized,
and the Rating API XML Request is configured to return Negotiated Rates,
then Negotiated Rates should be returned in the response. Web/Promotional
Discounts: If the indicator is present, the Shipper is authorized for
Web/Promotional Discounts then Negotiated Rates should be returned in
the response.'
maximum: 1
type: string
FRSShipmentIndicator:
description: FRS Indicator. The indicator is required to obtain rates for
UPS Ground Freight Pricing (GFP). The account number must be enabled
for GFP.
maximum: 1
type: string
RateChartIndicator:
description: RateChartIndicator - If present in a request, the response
will contain a RateChart element.
maximum: 1
type: string
UserLevelDiscountIndicator:
description: UserLevelDiscountIndicator - required to obtain rates for User
Level Promotions. This is required to obtain User Level Discounts. There
must also be no ShipperNumber in the Shipper container.
maximum: 1
type: string
TPFCNegotiatedRatesIndicator:
description: This indicator applies for a third party (3P) / Freight collect
(FC) shipment only. For 3P/FC shipment if the shipper wishes to request
for the negotiated rates of the third party then this indicator should
be included in the request. If authorized the 3P/FC negotiated rates will
be applied to the shipment and rates will be returned in response.
maximum: 1
type: string
xml:
name: ShipmentRatingOptions
description: Shipment Rating Options container.
Shipment_InvoiceLineTotal:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: 'Invoice Line Total Currency type. The Currency code should
match the origin country''s or territory''s currency code, otherwise the
currency code entered will be ignored. Note: UPS doesn''t support all
international currency codes. Please check the developer guides for Supported
Currency codes.'
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Total amount of the invoice accompanying the shipment. Required when the InvoiceLineTotal container exists in the rate request. Valid values are from 1 to 99999999.
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: InvoiceLineTotal
description: Container to hold InvoiceLineTotal Information. Required if the
shipment is from US/PR Outbound to non US/PR destination with the PackagingType
of UPS PAK(04).Required for international shipments when using request option
"ratetimeintransit" or "shoptimeintransit".
Shipment_PromotionalDiscountInformation:
type: object
maximum: 1
required:
- PromoAliasCode
- PromoCode
properties:
PromoCode:
description: Promotion Code. A discount that is applied to the user. Required
if PromotionalDiscountInformation container is present.
maximum: 1
type: string
minLength: 9
maxLength: 9
PromoAliasCode:
description: Promotion Alias code Required if PromotionalDiscountInformation
container is present.
maximum: 1
type: string
minLength: 20
maxLength: 20
xml:
name: PromotionalDiscountInformation
description: PromotionalDiscountInformation container. This container contains
discount information that the customer wants to request each time while placing
a shipment.
Shipment_DeliveryTimeInformation:
type: object
maximum: 1
required:
- PackageBillType
properties:
PackageBillType:
description: |
Valid values are:
- 02 - Document only
- 03 - Non-Document
- 04 - WWEF Pallet
- 07 - Domestic Pallet
If 04 is included, Worldwide Express Freight and UPS Worldwide Express Freight Midday services (if applicable) will be included in the response.
maximum: 1
type: string
minLength: 2
maxLength: 2
Pickup:
"$ref": "#/components/schemas/DeliveryTimeInformation_Pickup"
ReturnContractServices:
type: array
items:
"$ref": "#/components/schemas/DeliveryTimeInformation_ReturnContractServices"
xml:
name: DeliveryTimeInformation
description: Container for requesting Time In Transit Information. Required
to view time in transit information. Required to view any time in transit
information.
DeliveryTimeInformation_Pickup:
type: object
maximum: 1
required:
- Date
properties:
Date:
description: "Shipment Date; The Pickup date is a Shipment Date and it is a required input field. The user is allowed to query up to 35 days into the past and 60 days into the future. Format: YYYYMMDD If a date is not provided, it will be defaulted to the current system date."
maximum: 1
type: string
minLength: 8
maxLength: 8
Time:
description: Reflects the time the package is tendered to UPS for shipping (can be dropped off at UPS or picked up by UPS). Military Time Format HHMMSS or HHMM. Invalid pickup time will not be validated.
maximum: 1
type: string
minLength: 4
maxLength: 6
xml:
name: Pickup
description: Pickup container.
DeliveryTimeInformation_ReturnContractServices:
type: object
required:
- Code
properties:
Code:
description: Return contract Service code. Valid Code "01" - Heavy Goods.
If 01 will return Heavy Goods service transit times for a given origin
and destination (if applicable) Invalid Code will be ignore.
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: Return contract service Description
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ReturnContractServices
description: Return contract services container
RateResponse:
type: object
required:
- Response
- RatedShipment
properties:
Response:
"$ref": "#/components/schemas/RateResponse_Response"
RatedShipment:
description: |
RatedShipment Container.
**NOTE:** For versions >= v2409, this element will always be returned as an array. For requests using versions < v2409, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/RateResponse_RatedShipment"
xml:
name: RateResponse
description: Rate Response Container.
maximum: 1
RateResponse_Response:
type: object
required:
- ResponseStatus
properties:
ResponseStatus:
"$ref": "#/components/schemas/Response_ResponseStatus"
Alert:
description: |
Alert Container. There can be zero to many alert containers with code and description.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/Response_Alert"
AlertDetail:
description: |
Alert Detail Container. Currently applies to and returned only for request containing HazMat and SubVersion greater than or equal to 1701.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/Response_AlertDetail"
TransactionReference:
"$ref": "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response Container.
maximum: 1
Response_ResponseStatus:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: Identifies the success or failure of the transaction. 1 =
Successful
maximum: 1
type: string
minLength: 1
maxLength: 1
Description:
description: Describes Response Status Code. Returns text of "Success"
for a valid request.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ResponseStatus
description: Response Status Container.
Response_Alert:
type: object
required:
- Description
- Code
properties:
Code:
description: Warning code returned by the system.
maximum: 1
type: string
minLength: 1
maxLength: 10
Description:
description: Warning messages returned by the system.
maximum: 1
type: string
minLength: 1
maxLength: 150
xml:
name: Alert
description: Alert container. There can be zero to many alert containers with
code and description.
Response_AlertDetail:
type: object
required:
- Description
- Code
properties:
Code:
description: Warning code returned by the system.
maximum: 1
type: string
minLength: 1
maxLength: 10
Description:
description: Warning messages returned by the system.
maximum: 1
type: string
minLength: 1
maxLength: 150
ElementLevelInformation:
"$ref": "#/components/schemas/AlertDetail_ElementLevelInformation"
xml:
name: AlertDetail
AlertDetail_ElementLevelInformation:
type: object
maximum: 1
required:
- Level
properties:
Level:
description: |
Define type of element in request. Possible values are -
- 'H' for the header details level,
- 'S' for the shipment level,
- 'P' for the package level,
- 'C' for the commodity level.
maximum: 1
type: string
minLength: 1
maxLength: 1
ElementIdentifier:
description: |
Contains more information about the type of element. Returned if Level is 'P' or 'C'.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/ElementLevelInformation_ElementIdentifier"
xml:
name: ElementLevelInformation
description: Provides more information about the element that represents the
alert.
ElementLevelInformation_ElementIdentifier:
type: object
required:
- Value
- Code
properties:
Code:
description: Represents the type of element. Possible values are 'P' and
'C'.
maximum: 1
type: string
minLength: 1
maxLength: 1
Value:
description: Represents the value of element.
maximum: 1
type: string
minLength: 1
maxLength: 5
xml:
name: ElementIdentifier
Response_TransactionReference:
type: object
maximum: 1
properties:
CustomerContext:
description: The CustomerContext Information which will be echoed during
response.
type: string
minLength: 1
maxLength: 512
maximum: 1
xml:
name: TransactionReference
description: Transaction Reference Container.
RateResponse_RatedShipment:
type: object
properties:
Disclaimer:
description: |
Disclaimer is used to provide more information to the shipper regarding the processed shipment. It is used to notify the shipper about possible taxes and duties that might have been added or might apply to the shipment. Refer to the Appendix for various disclaimers. This field may be returned only if TaxInformationIndicator is present in the request.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/RatedShipment_Disclaimer"
Service:
"$ref": "#/components/schemas/RatedShipment_Service"
RateChart:
description: |
Rate Type with which Shipment is rated. Possible RateChart values for different regions will be:
US 48 origin:
- 1 – Daily Rates
- 3 – Standard List Rates
- 4 – Retail Rates.
Alaska/Hawaii origin:
- 1 – Daily Rates
- 3 – Standard List Rates
- 4 – Retail Rates.
All Other origins:
- 1 – Rates
- 5 - Regional Rates
- 6 - General List Rates.
- 3 and 4 do not apply
maximum: 1
type: string
minLength: 1
maxLength: 1
Zone:
type: string
minLength: 1
maxLength: 4
description: |
The Zone field will be returned in the Rate API response only when the latest subversion 2409 or greater
RatedShipmentAlert:
description: |
Rated Shipment Alert container. There can be zero to many RatedShipmentAlert containers with code and description.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/RatedShipment_RatedShipmentAlert"
BillableWeightCalculationMethod:
description: Indicates whether the billable weight calculation method is
utilized at the package or shipment level. This information will be returned
only if RatingMethodRequestedIndicator is present in the request. Possible
values:01 = Shipment Billable Weight02 = Package Billable Weight
maximum: 1
type: string
minLength: 2
maxLength: 2
RatingMethod:
description: Indicates whether the Shipment was rated at the shipment-level
or the package-level. This information will be returned only if RatingMethodRequestedIndicator
is present in the request. Possible values:01 = Shipment level02 = Package
level
maximum: 1
type: string
minLength: 2
maxLength: 2
BillingWeight:
"$ref": "#/components/schemas/RatedShipment_BillingWeight"
TransportationCharges:
"$ref": "#/components/schemas/RatedShipment_TransportationCharges"
BaseServiceCharge:
"$ref": "#/components/schemas/RatedShipment_BaseServiceCharge"
ItemizedCharges:
description: |
Itemized Charges are returned only when the subversion element is present and greater than or equal to '1601'. These charges would be returned only when subversion is greater than or equal to 1601.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/RatedShipment_ItemizedCharges"
FRSShipmentData:
"$ref": "#/components/schemas/RatedShipment_FRSShipmentData"
ServiceOptionsCharges:
"$ref": "#/components/schemas/RatedShipment_ServiceOptionsCharges"
TaxCharges:
description: |
TaxCharges container are returned only when TaxInformationIndicator is present in request and when Negotiated Rates are not applicable. TaxCharges container contains Tax information for a given shipment.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/RatedShipment_TaxCharges"
TotalCharges:
"$ref": "#/components/schemas/RatedShipment_TotalCharges"
TotalChargesWithTaxes:
"$ref": "#/components/schemas/RatedShipment_TotalChargesWithTaxes"
NegotiatedRateCharges:
"$ref": "#/components/schemas/RatedShipment_NegotiatedRateCharges"
RatedPackage:
description: |
Rated Package Container.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/RatedShipment_RatedPackage"
TimeInTransit:
"$ref": "#/components/schemas/RatedShipment_TimeInTransit"
GuaranteedDelivery:
"$ref": "#/components/schemas/RatedShipment_GuaranteedDelivery"
RoarRatedIndicator:
description: Informational only
maximum: 1
type: string
xml:
name: RatedShipment
required:
- BillingWeight
- TotalCharges
- ServiceOptionsCharges
- Service
- TransportationCharges
- RatedPackage
maximum: 1
RatedShipment_Disclaimer:
type: object
required:
- Description
- Code
properties:
Code:
description: Code representing type of Disclaimer. Refer to the Appendix
for possible code values.
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: Disclaimer description. Please refer to Appendix for possible
descriptions.
maximum: 1
type: string
xml:
name: Disclaimer
RatedShipment_Service:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: The UPS service code.
maximum: 1
type: string
minLength: 1
maxLength: 3
Description:
description: The UPS service Description.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: Service
description: Service Container.
RatedShipment_RatedShipmentAlert:
type: object
required:
- Description
- Code
properties:
Code:
description: The rated shipments warning code returned by the system.
maximum: 1
type: string
minLength: 1
maxLength: 10
Description:
description: The rated shipment warning Description returned by the system.
maximum: 1
type: string
minLength: 1
maxLength: 150
xml:
name: RatedShipmentAlert
RatedShipment_BillingWeight:
type: object
required:
- UnitOfMeasurement
- Weight
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/BillingWeight_UnitOfMeasurement"
Weight:
description: The value for the billable weight associated with the shipment. When using a negotiated divisor different from the published UPS divisor (139 for inches and 5,000 for cm), the weight returned is based on the published divisor. Rates, however, are based on the negotiated divisor.
maximum: 1
type: string
minLength: 1
maxLength: 5
xml:
name: BillingWeight
maximum: 1
description: Billing Weight Container.
BillingWeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: The code associated with the unit of measure for the billable weight of a shipment. Possible values are KGS or LBS.
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: The description for the billable weight associated with the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: UnitOfMeasurement
description: Unit Of Measurement Container.
RatedShipment_TransportationCharges:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the transportation costs for the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 3
MonetaryValue:
description: The value for the transportation costs associated with the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 16
xml:
name: TransportationCharges
description: Transportation Charges Container.
RatedShipment_BaseServiceCharge:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the base service charge
costs for the shipment.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: The base value of the specific service for the shipment. This
is equal to transportation charges - fuel surcharges.
maximum: 1
type: string
minLength: 1
maxLength: 16
xml:
name: BaseServiceCharge
description: Base Service Charge Container. These charges would be returned
only when subversion is greater than or equal to 1701
RatedShipment_ItemizedCharges:
type: object
required:
- CurrencyCode
- MonetaryValue
- Code
properties:
Code:
description: Identification code for itemized charge.
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description of Itemized Charge that had been charged.
maximum: 1
type: string
minLength: 1
maxLength: 50
CurrencyCode:
description: The IATA currency code associated with the Itemized Charge
costs for the shipment.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: The value for Itemized Charge costs associated with the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 19
SubType:
description: The sub-type of Itemized Charge type.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: ItemizedCharges
RatedShipment_FRSShipmentData:
type: object
required:
- TransportationCharges
properties:
TransportationCharges:
"$ref": "#/components/schemas/FRSShipmentData_TransportationCharges"
FreightDensityRate:
"$ref": "#/components/schemas/FRSShipmentData_FreightDensityRate"
HandlingUnits:
description: |
Handling Unit for Density based rating container.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/FRSShipmentData_HandlingUnits"
xml:
name: FRSShipmentData
description: FRSShipmentData container. Only returned when the FRSShipmentIIndicator
is used. UPS Ground Freight Pricing Only.
maximum: 1
FRSShipmentData_TransportationCharges:
type: object
required:
- DiscountPercentage
- GrossCharge
- DiscountAmount
- NetCharge
properties:
GrossCharge:
"$ref": "#/components/schemas/TransportationCharges_GrossCharge"
DiscountAmount:
"$ref": "#/components/schemas/TransportationCharges_DiscountAmount"
DiscountPercentage:
description: Discount Percentage
maximum: 1
type: string
minLength: 2
maxLength: 2
NetCharge:
"$ref": "#/components/schemas/TransportationCharges_NetCharge"
xml:
name: TransportationCharges
maximum: 1
description: Transportation Charges Container
TransportationCharges_GrossCharge:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the transportation costs
for the shipment.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Total charges Monetary value. Valid values are from 0 to 9999999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: GrossCharge
description: Gross Transportation Charges Container
TransportationCharges_DiscountAmount:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the transportation costs
for the shipment.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Total charges Monetary value. Valid values are from 0 to 9999999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: DiscountAmount
description: Discount Container
TransportationCharges_NetCharge:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the transportation costs
for the shipment.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Total charges Monetary value. Valid values are from 0 to 9999999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: NetCharge
description: Net Transportation Rate Container
FRSShipmentData_FreightDensityRate:
type: object
maximum: 1
required:
- TotalCubicFeet
- Density
properties:
Density:
description: Density is returned if the Shipper is eligible for Density
based rate. Valid values:0 to 999.9
maximum: 1
type: string
minLength: 1
maxLength: 5
TotalCubicFeet:
description: TotalCubic feet is returned if the Shipper is eligible for
Density based rate. Valid values:0 to 99999.999
maximum: 1
type: string
minLength: 1
maxLength: 9
xml:
name: FreightDensityRate
description: FreightDensityRate container for Density based rating.
FRSShipmentData_HandlingUnits:
type: object
required:
- Type
- Quantity
- Dimensions
properties:
Quantity:
description: Handling Unit Quantity for Density based rating.
maximum: 1
type: string
minLength: 1
maxLength: 8
Type:
"$ref": "#/components/schemas/HandlingUnits_Type"
Dimensions:
"$ref": "#/components/schemas/HandlingUnits_Dimensions"
AdjustedHeight:
"$ref": "#/components/schemas/HandlingUnits_AdjustedHeight"
xml:
name: HandlingUnits
HandlingUnits_AdjustedHeight:
type: object
maximum: 1
required:
- UnitOfMeasurement
- Value
properties:
Value:
description: Adjusted Height value for the handling unit. Adjusted Height
is done only when Handling unit type is SKD = Skid or PLT = Pallet.
maximum: 1
type: string
minLength: 1
maxLength: 19
UnitOfMeasurement:
"$ref": "#/components/schemas/AdjustedHeight_UnitOfMeasurement"
xml:
name: AdjustedHeight
description: Container to hold Adjusted Height information.
RatedPackage_BaseServiceCharge:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the base service charge
costs for the shipment.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: The base value of the specific service for the shipment. This
is equal to transportation charges - fuel surcharges.
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: BaseServiceCharge
description: Base Service Charge Container. These charges would be returned
only when subversion is greater than or equal to 1701
RatedShipment_ServiceOptionsCharges:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the accessorial charges for the shipment.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: The value for the accessorial charges associated with the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: ServiceOptionsCharges
description: Service Options Charges Container.
RatedShipment_TaxCharges:
type: object
required:
- Type
- MonetaryValue
properties:
Type:
description: Tax Type code. The code represents the type of Tax applied
to a shipment. Please refer to Appendix I for possible Tax Type codes.
maximum: 1
type: string
minLength: 1
maxLength: 9
MonetaryValue:
description: Tax Monetary Value represent the Tax amount. Valid values
are from 0 to 99999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: TaxCharges
RatedShipment_TotalCharges:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the total charges for the shipment.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: The value for the total charges associated with the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: TotalCharges
description: Total Charges Container.
RatedShipment_TotalChargesWithTaxes:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: TotalChargesWithTaxes currency code type. The currency code
used in the Shipment request is returned.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: TotalChargesWithTaxes monetary value amount. Valid values
are from 0 to 99999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: TotalChargesWithTaxes
description: TotalChargesWithTaxes container would be returned only if TaxInformationIndicator
is present in request and when Negotiated Rates are not applicable. TotalChargesWithTaxes
contains total charges including total taxes applied to a shipment.
RatedShipment_NegotiatedRateCharges:
type: object
properties:
BaseServiceCharge:
description: |
Negotiated base service charge container.These charges would be returned only when subversion is greater than or equal to 2201.
type: array
items:
"$ref": "#/components/schemas/NegotiatedRateCharges_BaseServiceCharge"
RateModifier:
description: |
RateModifier inside Negotiated charges container to hold Modifier charges at package level
**Note:** Applies only if SubVersion is 2407 and greater (Rate OAuth)
type: array
items:
"$ref": "#/components/schemas/NegotiatedRateCharges_RateModifier"
ItemizedCharges:
description: |
Itemized Charges are returned only when the subversion element is present and greater than or equal to '1601'. These charges would be returned only when subversion is greater than or equal to 1601.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/NegotiatedRateCharges_ItemizedCharges"
TaxCharges:
description: |
TaxCharges container are returned only when TaxInformationIndicator is present in request. TaxCharges container contains Tax information for a given shipment.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/NegotiatedRateCharges_TaxCharges"
TotalCharge:
"$ref": "#/components/schemas/NegotiatedRateCharges_TotalCharge"
TotalChargesWithTaxes:
"$ref": "#/components/schemas/NegotiatedRateCharges_TotalChargesWithTaxes"
xml:
name: NegotiatedRateCharges
required:
- TotalCharge
description: Negotiated Rate Charges Container. For tiered rates and promotional
discounts, if a particular shipment based on zone, origin, destination or
even shipment size doesn't qualify for the existing discount then no negotiated
rates container will be returned. Published rates will be the applicable rate.
maximum: 1
NegotiatedRateCharges_BaseServiceCharge:
type: object
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: 'The IATA currency code associated with the base service Charge.'
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: 'The value for base service charge.'
maximum: 1
type: string
minLength: 1
maxLength: 16
NegotiatedRateCharges_RateModifier:
type: object
required:
- ModifierType
- ModifierDesc
- Amount
properties:
ModifierType:
description: 'Rate Modifier Type. Example- "ORM".'
maximum: 1
type: string
minLength: 1
maxLength: 3
ModifierDesc:
description: 'Rate Modifier Description. Example- "Origin Modifier".'
maximum: 1
type: string
minLength: 1
maxLength: 50
Amount:
description: 'Amount. Example- "-1.00","0.25" It contains positive or negative values.'
maximum: 1
type: string
minLength: 1
maxLength: 16
NegotiatedRateCharges_ItemizedCharges:
type: object
required:
- CurrencyCode
- MonetaryValue
- Code
properties:
Code:
description: Identification code for itemized charge.
maximum: 1
type: string
minLength: 1
maxLength: 3
Description:
description: Description of Itemized Charge that had been charged.
maximum: 1
type: string
minLength: 1
maxLength: 50
CurrencyCode:
description: The IATA currency code associated with the Itemized Charge
costs for the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 3
MonetaryValue:
description: The value for Itemized Charge costs associated with the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 19
SubType:
description: The sub-type of Itemized Charge type.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: ItemizedCharges
NegotiatedRateCharges_TaxCharges:
type: object
required:
- Type
- MonetaryValue
properties:
Type:
description: Tax Type code. The code represents the type of Tax applied
to a shipment. Please refer to Appendix I for possible Tax Type codes.
type: string
MonetaryValue:
description: Tax Monetary Value represent the Tax amount. Valid values
are from 0 to 99999999999999.99
type: string
xml:
name: TaxCharges
NegotiatedRateCharges_TotalCharge:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the Negotiated Rate
total charges for the shipment.
type: string
MonetaryValue:
description: The value for the Negotiated Rate total charges associated
with the shipment.
type: string
xml:
name: TotalCharge
description: Total Charges Container.
TotalCharge_CurrencyCode:
description: The IATA currency code associated with the Negotiated Rate total
charges for the shipment.
maximum: 1
type: string
minLength: 3
maxLength: 3
TotalCharge_MonetaryValue:
description: The value for the Negotiated Rate total charges associated with
the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 16
NegotiatedRateCharges_TotalChargesWithTaxes:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: TotalChargesWithTaxes currency code type. The currency code
used in the Shipment request is returned.
type: string
MonetaryValue:
description: TotalChargesWithTaxes monetary value amount. Valid values
are from 0 to 99999999999999.99
type: string
xml:
name: TotalChargesWithTaxes
description: TotalChargesWithTaxes container would be returned only if TaxInformationIndicator
is present in request. TotalChargesWithTaxes contains total charges including
total taxes applied to a shipment.
RatedShipment_RatedPackage:
type: object
properties:
BaseServiceCharge:
"$ref": "#/components/schemas/RatedPackage_BaseServiceCharge"
TransportationCharges:
"$ref": "#/components/schemas/RatedPackage_TransportationCharges"
ServiceOptionsCharges:
"$ref": "#/components/schemas/RatedPackage_ServiceOptionsCharges"
TotalCharges:
"$ref": "#/components/schemas/RatedPackage_TotalCharges"
Weight:
description: The weight of the package in the rated Package.
type: string
BillingWeight:
"$ref": "#/components/schemas/RatedPackage_BillingWeight"
Accessorial:
description: |
The container for Accessorial indicators. This information would be returned only if ItemizedChargesRequested was present during Rate request. This is valid only for UPS Worldwide Express Freight and UPS Worldwide Express Freight Mid-day service request with Dry Ice or Oversize Pallet and SubVersion greater than or equal to 1707. This is valid only for UPS Worldwide Express Freight and UPS Worldwide Express Freight Middday Service.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/RatedPackage_Accessorial"
ItemizedCharges:
description: |
Itemized Charges are returned only when the subversion element is present and greater than or equal to '1607'. These charges would be returned only when subversion is greater than or equal to 1607.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/RatedPackage_ItemizedCharges"
NegotiatedCharges:
"$ref": "#/components/schemas/RatedPackage_NegotiatedCharges"
SimpleRate:
"$ref": "#/components/schemas/RatedPackage_SimpleRate"
RateModifier:
description: |
Container for returned Rate Modifier information. Applies only if SubVersion is 2205 or greater.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/RatedPackage_RateModifier"
xml:
name: RatedPackage
RatedPackage_TransportationCharges:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the transportation costs
for the package.
type: string
MonetaryValue:
description: The value for the transportation costs associated with the
package.
type: string
xml:
name: TransportationCharges
description: Transportation Charges Container.
RatedPackage_ServiceOptionsCharges:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the accessorial charges
for the package.
type: string
MonetaryValue:
description: The value for the accessorial charges associated with the package.
type: string
xml:
name: ServiceOptionsCharges
description: Service Options Charges Container.
RatedPackage_TotalCharges:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: The IATA currency code associated with the total charges for
the package.
type: string
MonetaryValue:
description: The value for the total charges associated with the package.
type: string
xml:
name: TotalCharges
description: Total Charges Container.
RatedPackage_Weight:
description: The weight of the package in the rated Package.
maximum: 1
type: string
minLength: 5
maxLength: 5
RatedPackage_BillingWeight:
type: object
required:
- UnitOfMeasurement
- Weight
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/RatedPackage_BillingWeight_UnitOfMeasurement"
Weight:
description: The value for the billable weight associated with the package. When
using a negotiated divisor different from the published UPS divisor (139
for inches and 5,000 for cm), the weight returned is based on the published
divisor. Rates, however, are based on the negotiated divisor.
type: string
xml:
name: BillingWeight
maximum: 1
description: Billing Weight Container.
RatedPackage_BillingWeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: The code associated with the unit of measure for the billable weight of a package.
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: The Description for the Unit Of Measurement.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: UnitOfMeasurement
description: Unit Of Measurement Container.
RatedPackage_Accessorial:
type: object
required:
- Code
properties:
Code:
description: Code for Accessorial Indicator.
type: string
Description:
description: Description for Accessorial Indicator.
type: string
xml:
name: Accessorial
Accessorial_Code:
description: Code for Accessorial Indicator.
maximum: 1
type: string
minLength: 3
maxLength: 3
Accessorial_Description:
description: Description for Accessorial Indicator.
maximum: 1
type: string
minLength: 1
maxLength: 50
RatedPackage_ItemizedCharges:
type: object
required:
- CurrencyCode
- MonetaryValue
- Code
properties:
Code:
description: Identification code for itemized charge.
maximum: 1
type: string
minLength: 1
maxLength: 3
Description:
description: Description of Itemized Charge that had been charged.
maximum: 1
type: string
minLength: 1
maxLength: 50
CurrencyCode:
description: The IATA currency code associated with the Itemized Charge
costs for the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 3
MonetaryValue:
description: The value for Itemized Charge costs associated with the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 19
SubType:
description: The sub-type of Itemized Charge type.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: ItemizedCharges
RatedPackage_RateModifier:
type: object
required:
- ModifierType
- ModifierDesc
- Amount
properties:
ModifierType:
description: 'Rate Modifier Type. Example: "ORM". Applies only if SubVersion
is 2205 or greater.'
maximum: 1
type: string
minLength: 1
maxLength: 3
ModifierDesc:
description: 'Rate Modifier Description. Example: "Origin Modifier". Applies
only if SubVersion is 2205 or greater.'
maximum: 1
type: string
minLength: 1
maxLength: 50
Amount:
description: 'Amount. Example: "-1.00","0.25". It contains positive or negative
values. Applies only if SubVersion is 2205 or greater.'
maximum: 1
type: string
minLength: 1
maxLength: 16
RatedPackage_NegotiatedCharges:
type: object
properties:
RateModifier:
description: |
RateModifier inside Negotiated charges container to hold Modifier charges at package level
**Note:** Applies only if SubVersion is 2407 and greater (Rate OAuth)
type: array
items:
"$ref": "#/components/schemas/NegotiatedCharges_RateModifier"
ItemizedCharges:
description: |
Negotiated Itemized Accessorial and Sur Charges. These charges would be returned only when subversion is greater than or equal to 1607.
**NOTE:** For versions >= v2403, this element will always be returned as an array. For requests using versions < v2403, this element will be returned as an array if there is more than one object and a single object if there is only 1.
type: array
items:
"$ref": "#/components/schemas/NegotiatedCharges_ItemizedCharges"
xml:
name: NegotiatedCharges
description: Negotiated Rates container. These charges would be returned only
when -1) subversion is greater than or equal to 16072) if negotiated rates
were requested for GFP shipments and account number is eligible to receive
negotiated rates.
maximum: 1
NegotiatedCharges_RateModifier:
type: object
required:
- ModifierType
- ModifierDesc
- Amount
properties:
ModifierType:
description: 'Rate Modifier Type. Example- "ORM".'
maximum: 1
type: string
minLength: 1
maxLength: 3
ModifierDesc:
description: 'Rate Modifier Description. Example- "Origin Modifier".'
maximum: 1
type: string
minLength: 1
maxLength: 50
Amount:
description: 'Amount. Example- "-1.00","0.25" It contains positive or negative values.'
maximum: 1
type: string
minLength: 1
maxLength: 16
NegotiatedCharges_ItemizedCharges:
type: object
required:
- CurrencyCode
- MonetaryValue
- Code
properties:
Code:
description: Identification code for itemized charge.
maximum: 1
type: string
minLength: 1
maxLength: 3
Description:
description: Description of Itemized Charge that had been charged.
maximum: 1
type: string
minLength: 1
maxLength: 50
CurrencyCode:
description: The IATA currency code associated with the Itemized Charge
costs for the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 3
MonetaryValue:
description: The value for Itemized Charge costs associated with the shipment.
maximum: 1
type: string
minLength: 1
maxLength: 19
SubType:
description: The sub-type of Itemized Charge type.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: ItemizedCharges
RatedPackage_SimpleRate:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Simple Rate Code
- XS = Extra Small
- S = Small
- M = Medium
- L = Large
- XL = Extra Large
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: SimpleRate
description: SimpleRate will be returned if Simple Rate present in request
RatedShipment_TimeInTransit:
type: object
maximum: 1
required:
- ServiceSummary
- PickupDate
properties:
PickupDate:
description: 'The date the user requests UPS to pickup the package from
the origin. Format: YYYYMMDD. In the event this Pickup date differs from
the Pickup date in the Estimated Arrival Container, a warning will be
returned. In the event this Pickup date differs from the Pickup date
in the Estimated Arrival Container, a warning will be returned.'
maximum: 1
type: string
minLength: 8
maxLength: 8
DocumentsOnlyIndicator:
description: If the indicator is present then the shipment was processed
as Document Only.
maximum: 1
type: string
PackageBillType:
description: Package bill type for the shipment. Valid values:02 - Document
only 03 - Non-Document04 - Pallet
maximum: 1
type: string
minLength: 2
maxLength: 2
ServiceSummary:
"$ref": "#/components/schemas/TimeInTransit_ServiceSummary"
AutoDutyCode:
description: 'Required output for International requests. If Documents indicator
is set for Non-document a duty is automatically calculated. The possible
values to be returned are: 01 - Dutiable02 - Non-Dutiable03 - Low-value04
- Courier Remission05 - Gift06 - Military07 - Exception08 - Line Release09
- Section 321 low value.'
maximum: 1
type: string
minLength: 2
maxLength: 2
Disclaimer:
description: The Disclaimer is provided based upon the origin and destination
country or territory codes provided in the request document. The possible
disclaimers that can be returned are available in the Service Guaranteed
Disclaimers table.
maximum: 1
type: string
xml:
name: TimeInTransit
description: Container for returned Time in Transit information. Will only
be returned if request option was either "ratetimeintransit" or "shoptimeintransit"
and DeliveryTimeInformation container was present in request.
TimeInTransit_ServiceSummary:
type: object
required:
- EstimatedArrival
- Service
properties:
Service:
"$ref": "#/components/schemas/ServiceSummary_Service"
GuaranteedIndicator:
description: Empty Tag. Indicates whether the service will be guaranteed
or not. Required for International Requests.
maximum: 1
type: string
Disclaimer:
description: The Disclaimer is provided based upon the origin and destination
country or territory codes provided in the request document. The disclaimer
is returned as a conditional statement to the validity of the service
being guaranteed. The possible disclaimers that can be returned are available
in the Service Guaranteed Disclaimers table.
maximum: 1
type: string
EstimatedArrival:
"$ref": "#/components/schemas/ServiceSummary_EstimatedArrival"
SaturdayDelivery:
description: Saturday delivery information for a service. Values are1 -
Saturday Delivery Available with additional charges 0 - Saturday Delivery
not available or no additional charge, please check Delivery Date to confirm
if the Delivery will be SaturdayPlease see Saturday Delivery business
rules section for more information.
maximum: 1
type: string
SaturdayDeliveryDisclaimer:
description: Saturday delivery disclaimer message.
maximum: 1
type: string
SundayDelivery:
description: Sunday delivery information for a service. Values are1 - Sunday
Delivery Available with additional charges 0 - Sunday Delivery not available
or no additional charge, please check Delivery Date to confirm if the
Delivery will be SundayPlease see Saturday Delivery business rules section
for more information. Applies only if SubVersion is greater than or equal
to 2007
maximum: 1
type: string
SundayDeliveryDisclaimer:
description: Sunday delivery disclaimer message. Applies only if SubVersion
is greater than or equal to 2007
maximum: 1
type: string
xml:
name: ServiceSummary
maximum: 1
description: Container for all available service information.
ServiceSummary_Service:
type: object
maximum: 1
properties:
Description:
description: Optional. Description of service. Example, UPS Next Day Air,
UPS Ground etc, as referenced by the Service Code.
type: string
xml:
name: Service
description: Container for the the UPS service selected for a shipment.
ServiceSummary_EstimatedArrival:
type: object
required:
- DayOfWeek
- Pickup
- Arrival
- BusinessDaysInTransit
properties:
Arrival:
"$ref": "#/components/schemas/EstimatedArrival_Arrival"
BusinessDaysInTransit:
description: Number of business days from Origin to Destination Locations.
maximum: 1
type: string
minLength: 1
maxLength: 5
Pickup:
"$ref": "#/components/schemas/EstimatedArrival_Pickup"
DayOfWeek:
description: 'Day of week for arrival. Valid values are: MONTUEWEDTHUFRISAT'
maximum: 1
type: string
minLength: 1
maxLength: 9
CustomerCenterCutoff:
description: Customer Service call time. Returned for domestic as well as
international requests.
maximum: 1
type: string
minLength: 1
maxLength: 6
DelayCount:
description: Number of days delayed at customs. Returned for International
requests.
maximum: 1
type: string
minLength: 1
maxLength: 3
HolidayCount:
description: Number of National holidays during transit. Returned for International
requests.
maximum: 1
type: string
minLength: 1
maxLength: 2
RestDays:
description: Number of rest days, i.e. non movement. Returned for International
requests.
maximum: 1
type: string
minLength: 1
maxLength: 2
TotalTransitDays:
description: The total number of days in transit from one location to the
next. Returned for International requests.
maximum: 1
type: string
minLength: 1
maxLength: 5
xml:
name: EstimatedArrival
maximum: 1
description: Container for the Time-In-Transit arrival information by service
EstimatedArrival_Arrival:
type: object
maximum: 1
required:
- Date
properties:
Date:
description: 'Scheduled Local Delivery Date. Format: YYYYMMDD'
maximum: 1
type: string
minLength: 8
maxLength: 8
Time:
description: The time UPS will pick up the shipment. This is commit Time.
Military Time Format HHMMSS or HHMM
maximum: 1
type: string
minLength: 4
maxLength: 6
xml:
name: Arrival
description: Container for the Time-In-Transit arrival information by service.
This is the most accurate delivery information available via the Rating API
and will reflect changes in delivery schedules due to peak business seasons
or holidays.
EstimatedArrival_Pickup:
type: object
maximum: 1
required:
- Date
properties:
Date:
description: 'The date UPS picks up the package from the origin. Format:
YYYYMMDD. In the event the Pickup date differs from the Ship On Date,
provided in the request, a warning message will be returned.'
type: string
Time:
description: The time UPS will pick up the shipment. Military Time Format
HHMMSS or HHMM
type: string
xml:
name: Pickup
description: The date and pick up time container.
RatedShipment_GuaranteedDelivery:
type: object
maximum: 1
properties:
BusinessDaysInTransit:
description: 'The rated shipments guaranteed delivery date. Denotes UPS published guarantee times. (i.e. 3DaySelect = 3)'
type: string
DeliveryByTime:
description: The rated shipments committed delivery time.
type: string
ScheduledDeliveryDate:
description: The rated shipments scheduled delivery date.
type: string
description: Guaranteed Delivery Container.
ErrorResponse:
type: object
properties:
response:
"$ref": "#/components/schemas/CommonErrorResponse"
CommonErrorResponse:
type: object
description: The error response containing any errors that occurred.
properties:
errors:
type: array
description: The error array containing any errors that occurred.
items:
"$ref": "#/components/schemas/ErrorMessage"
ErrorMessage:
type: object
properties:
code:
type: string
description: The error code.
message:
type: string
description: The error message.
description: The error response containing any errors that occurred.