openapi: 3.0.3
info:
title: Ship
termsOfService: https://www.ups.com/upsdeveloperkit/assets/html/serviceAgreement.html
version: ''
description: |
The Shipping Package API gives the application many ways to manage the shipment of packages to their destination.
# Reference
- Business Rules
- Appendix 1
- Appendix 2
- Errors
- FAQ
- Best Practices
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:
"/shipments/{version}/ship":
post:
description: "The Shipping API makes UPS shipping services available to client
applications that communicate with UPS \nusing the Internet"
summary: Shipment
tags:
- Shipping
security:
- OAuth2: []
operationId: Shipment
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
required: false
- in: header
name: transactionSrc
schema:
type: string
default: testing
description: An identifier of the client/source application that is making
the request.Length 512
required: false
- in: query
name: additionaladdressvalidation
schema:
type: string
minimum: 1
description: "Valid Values: \ncity = validation will include city.Length 15"
required: false
- in: path
name: version
schema:
type: string
minimum: 1
default: v2409
description: |
Indicates Ship API to display the new release features in Ship API response based on Ship release.
Valid values:
- v2409
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/SHIPRequestWrapper"
examples:
'Standard Example':
summary: Shipping Request(Standard Example)
value:
ShipmentRequest:
Request:
SubVersion: '1801'
RequestOption: nonvalidate
TransactionReference:
CustomerContext: ''
Shipment:
Description: Ship WS test
Shipper:
Name: ShipperName
AttentionName: ShipperZs Attn Name
TaxIdentificationNumber: '123456'
Phone:
Number: '1115554758'
Extension: " "
ShipperNumber: " "
FaxNumber: '8002222222'
Address:
AddressLine:
- 2311 York Rd
City: Timonium
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: Happy Dog Pet Supply
AttentionName: 1160b_74
Phone:
Number: '9225377171'
Address:
AddressLine:
- 123 Main St
City: timonium
StateProvinceCode: MD
PostalCode: '21030'
CountryCode: US
Residential: " "
ShipFrom:
Name: T and T Designs
AttentionName: 1160b_74
Phone:
Number: '1234567890'
FaxNumber: '1234567890'
Address:
AddressLine:
- 2311 York Rd
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: " "
Service:
Code: '03'
Description: Express
Package:
Description: " "
Packaging:
Code: '02'
Description: Nails
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '10'
Width: '30'
Height: '45'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '5'
LabelSpecification:
LabelImageFormat:
Code: GIF
Description: GIF
HTTPUserAgent: Mozilla/4.5
'Negotiated Rates':
summary: Shipping Request with Negotiated Rates
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '1601'
TransactionReference:
CustomerContext: ''
Shipment:
TaxInformationIndicator: ''
ShipmentRatingOptions:
NegotiatedRatesIndicator: X
Description: 1507 US shipment
Shipper:
Name: Shipper_name
AttentionName: Shipper_Attn.name
CompanyDisplayableName: Shipper_company
ShipperNumber: ''
Phone:
Number: '5555555555'
Address:
AddressLine:
- Shipper_Addrline1
City: BERLIN
StateProvinceCode: ''
PostalCode: '10785'
CountryCode: DE
ShipTo:
Name: ShipTo_name
AttentionName: ShipTo_Attn.name
CompanyDisplayableName: ShipTo_company
Phone:
Number: '5555555555'
Address:
AddressLine:
- Shipper_Addrline1
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFrom_name
AttentionName: ShipFrom_Attn.name
CompanyDisplayableName: ShipFrom_company
Address:
AddressLine:
- ShipFrom_Addrline1
City: BERLIN
StateProvinceCode: ''
PostalCode: '10785'
CountryCode: DE
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '07'
Description: UPS
Package:
Description: Package1
Packaging:
Code: '02'
Description: Customer Supplied Package
Dimensions:
UnitOfMeasurement:
Code: CM
Description: Centimeters
Length: '8'
Width: '2'
Height: '2'
PackageWeight:
UnitOfMeasurement:
Code: KGS
Description: Kilograms
Weight: '20.2'
'International Forms':
summary: Shipping Request with International Forms
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
TransactionReference:
CustomerContext: ''
Shipment:
Description: Description of Goods
Shipper:
Name: Henry Lee Thomson
AttentionName: John Smith
ShipperNumber: " "
TaxIdentificationNumber: '456789'
Phone:
Number: '1234567890'
Address:
AddressLine:
- 34 Queen St
City: Toronto
StateProvinceCode: 'ON'
PostalCode: M5C2M6
CountryCode: CA
ShipTo:
Name: Happy Dog Pet Supply
AttentionName: Marley Brinson
TaxIdentificationNumber: '458889'
Phone:
Number: '1234567890'
Address:
AddressLine:
- B.B. King Blvd.
City: Charlotte
StateProvinceCode: NC
PostalCode: '28256'
CountryCode: US
ShipFrom:
Name: T and T Designs
AttentionName: Mike
Phone:
Number: '1234567890'
FaxNumber: '1234567999'
TaxIdentificationNumber: '456999'
Address:
AddressLine:
- 34 Queen St
City: Toronto
StateProvinceCode: 'ON'
PostalCode: M5C2M6
CountryCode: CA
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: " "
Service:
Code: '08'
Description: Expedited
Package:
Description: International Goods
Packaging:
Code: '02'
PackageWeight:
UnitOfMeasurement:
Code: KGS
Weight: '10'
ShipmentServiceOptions:
InternationalForms:
FormType: '04'
FormGroupIdName: USMCA Form
Contacts:
SoldTo:
Option: " "
Name: ACME Designs
AttentionName: Wile E Coyote
TaxIdentificationNumber: " "
Phone:
Number: '5551479876'
Address:
AddressLine:
- 123 Main St
City: Phoenix
StateProvinceCode: GA
PostalCode: '30076'
CountryCode: US
Producer:
Option: " "
CompanyName: Tree Service
Address:
AddressLine:
- 678 Elm St
City: Marietta
StateProvinceCode: GA
PostalCode: '30066'
CountryCode: US
Phone:
Number: '5555555555'
EmailAddress: " "
TaxIdentificationNumber: " "
Product:
Description: Today is the best day of the week
CommodityCode: '12345678'
OriginCountryCode: US
JointProductionIndicator: " "
NetCostCode: NC
NetCostDateRange:
BeginDate: '20050801'
EndDate: '20051015'
PreferenceCriteria: A
ProducerInfo: No[1]
BlanketPeriod:
BeginDate: '20050115'
EndDate: '20050816'
LabelSpecification:
LabelImageFormat:
Code: GIF
'Shipping Dry Ice or Lithium Batteries':
summary: Shipping Dry Ice or Lithium Batteries
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
TransactionReference:
CustomerContext: ''
SubVersion: '1701'
Shipment:
DGSignatoryInfo:
UploadOnlyIndicator: Y
ShipperDeclaration: '01'
Date: '20200112'
Place: GA
Title: DGPaperImage
Name: DGSignatory
Description: ER1703
Shipper:
Name: Shipper_Name
AttentionName: Shipper_AttentionName
TaxIdentificationNumber: '123456'
Phone:
Number: '1234567890'
ShipperNumber: " "
Address:
AddressLine:
- 12380 Morris Rd
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipTo:
Name: ShipTo_CompanyName
AttentionName: ShipTo_AttentionName
Phone:
Number: '1234567890'
FaxNumber: '1234567890'
TaxIdentificationNumber: '123456'
Address:
AddressLine:
- 793 Foothill Blvd
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFrom_CompanyName
AttentionName: ShipFrom_AttentionName
Phone:
Number: '1234567890'
FaxNumber: '1234567890'
TaxIdentificationNumber: '123456'
Address:
AddressLine:
- 12380 Morris Rd
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: " "
Service:
Code: '03'
Description: Ground
Package:
- HazMatPackageInformation:
OuterPackagingType: FIBERBOARD BOX
QValue: '0.1'
OverPackedIndicator: " "
AllPackedInOneIndicator: " "
Description: Package Description
Packaging:
Code: '02'
Description: Customer Supplied Package
Dimensions:
Length: '10'
Width: '10'
Height: '10'
UnitOfMeasurement:
Code: IN
Description: Inches
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '10'
PackageServiceOptions:
HazMat:
LocalProperShippingName: Ship
LocalTechnicalName: Local
EmergencyPhone: '1234567890'
ReferenceNumber: '12345'
HazardLabelRequired: Y
aDRPackingGroupLetter: '1'
PackagingTypeQuantity: '100'
SubRiskClass: SubRisk
aDRItemNumber: '1234567890'
TechnicalName: Hazmat TechnicalName
ClassDivisionNumber: '12345'
Quantity: '100.0'
UOM: IN
PackagingType: Box
IDNumber: UN3480
ProperShippingName: Lithium ion batteries
AdditionalDescription: Hazmat AdditionalDescription
PackagingGroupType: III
PackagingInstructionCode: '1234'
ReportableQuantity: RQ
RegulationSet: CFR
TransportationMode: Ground
CommodityRegulatedLevelCode: LQ
TransportCategory: '0'
TunnelRestrictionCode: Nothing
ChemicalRecordIdentifier: '100'
PackageIdentifier: '123'
- Description: DG
NumOfPieces: '10'
Packaging:
Code: '02'
Description: desc
Dimensions:
UnitOfMeasurement:
Code: IN
Description: IN
Length: '2'
Width: '2'
Height: '2'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: LBS
Weight: '50'
PackageServiceOptions:
DryIce:
RegulationSet: CFR
DryIceWeight:
UnitOfMeasurement:
Code: '01'
Description: LBS
Weight: '50'
PackedByStoreIndicator: " "
PackageIdentifier: '123'
LabelSpecification:
LabelImageFormat:
Code: GIF
'Shipping Hazmat Goods':
summary: Shipping Hazmat Goods
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
TransactionReference:
CustomerContext: ''
SubVersion: '1701'
Shipment:
Description: Ship WS test
Shipper:
Name: ShipperName
AttentionName: ShipperZs Attn Name
TaxIdentificationNumber: '123456'
Phone:
Number: '1115554758'
Extension: '1'
ShipperNumber: " "
FaxNumber: '8002222222'
Address:
AddressLine:
- 12380 Morris Road
City: LUTHERVILLE TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: Happy Dog Pet Supply
AttentionName: 1160b_74
Phone:
Number: '9225377171'
Address:
AddressLine:
- 460 Rue du Valibout
City: SMITHFIELD
StateProvinceCode: RI
PostalCode: '02917'
CountryCode: US
ShipFrom:
Name: T and T Designs
AttentionName: 1160b_74
Phone:
Number: '1234567890'
FaxNumber: '1234567890'
Address:
AddressLine:
- 12380 Morris Road
City: LUTHERVILLE TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: " "
Service:
Code: '03'
Description: UPS Worldwide Saver
Package:
Description: UPS Worldwide Saver
Packaging:
Code: '02'
Dimensions:
UnitOfMeasurement:
Code: IN
Length: '6'
Width: '9'
Height: '7'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Weight: '68'
PackageServiceOptions:
PackageIdentifier: '12380'
HazMat:
PackagingTypeQuantity: '1'
SubRiskClass: " "
TechnicalName: OXYGEN/NITROGEN
ClassDivisionNumber: '2.2'
Quantity: '6'
UOM: kg
PackagingType: Fibreboard Box
IDNumber: UN3480
ProperShippingName: Lithium Ion Batteries
PackagingGroupType: " "
PackagingInstructionCode: Pack
EmergencyPhone: '9253702575'
EmergencyContact: Shipping Dept.
RegulationSet: CFR
TransportationMode: CAO
CommodityRegulatedLevelCode: FR
TransportCategory: xyz
TunnelRestrictionCode: xyz
ChemicalRecordIdentifier: '40'
NumOfPiecesInShipment: '10000'
LabelSpecification:
LabelImageFormat:
Code: GIF
Description: GIF
HTTPUserAgent: Mozilla/4.5
'Billing Third Party':
summary: Billing Third Party
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '1901'
TransactionReference:
CustomerContext: ''
Shipment:
Description: Payments
Shipper:
Name: Shipper_name
AttentionName: Shipper_name
CompanyDisplayableName: Shipper_name
Phone:
Number: '1234567890'
Extension: '1234'
ShipperNumber: " "
FaxNumber: '1234'
EMailAddress: " "
Address:
AddressLine:
- ShipperAddress
- ShipperAddress
- ShipperAddress
City: 01-222 Warszawa
StateProvinceCode: GA
PostalCode: '1222'
CountryCode: PL
ShipTo:
Name: ShipToName
AttentionName: ShipToName
CompanyDisplayableName: ShipToName
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
EMailAddress: " "
Address:
AddressLine:
- ShipToAddress
- ShipToAddress
- ShipToAddress
City: 01-222 Warszawa
StateProvinceCode: GA
PostalCode: '1222'
CountryCode: PL
ShipFrom:
Name: ShipFromName
AttentionName: ShipFromName
CompanyDisplayableName: ShipFromName
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Description: EIN
Phone:
Number: '1234567890'
Extension: '1234'
ShipFromAccountNumber: " "
FaxNumber: '1234'
Address:
AddressLine:
- ShipFromAddress
- ShipFromAddress
- ShipFromAddress
City: 01-222 Warszawa
StateProvinceCode: GA
PostalCode: '1222'
CountryCode: PL
EMailAddress: " "
PaymentInformation:
ShipmentCharge:
Type: '01'
BillThirdParty:
AccountNumber: " "
Name: " "
AttentionName: " "
VatTaxID: 1234AB
TaxIDType: '01'
CertifiedElectronicMail: abc@123.123
InterchangeSystemCode: SDI
SuppressPrintInvoiceIndicator: " "
Address:
PostalCode: '30005'
CountryCode: US
Service:
Code: '011'
Description: Standard
InvoiceLineTotal:
CurrencyCode: USD
MonetaryValue: '10'
NumOfPiecesInShipment: '1'
USPSEndorsement: '5'
CostCenter: '123'
PackageID: '1'
InformationSourceCode: A3
ShipmentServiceOptions: " "
Package:
Description: IF
NumOfPieces: '10'
Packaging:
Code: '02'
Description: desc
Dimensions:
UnitOfMeasurement:
Code: CM
Description: CM
Length: '2'
Width: '2'
Height: '3'
PackageWeight:
UnitOfMeasurement:
Code: KGS
Description: LBS
Weight: '50'
LabelSpecification:
LabelImageFormat:
Code: GIF
Description: GIF
'Multi-Piece Shipping':
summary: Multi-Piece Shipping
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '1701'
TransactionReference:
CustomerContext: ''
Shipment:
Package:
- PackageWeight:
Weight: '50'
UnitOfMeasurement:
Description: desc
Code: LBS
Dimensions:
Height: '2'
Width: '2'
Length: '02'
UnitOfMeasurement:
Description: desc
Code: IN
Packaging:
Description: desc
Code: '02'
Description: desc
- PackageWeight:
Weight: '50'
UnitOfMeasurement:
Description: desc
Code: LBS
Dimensions:
Height: '2'
Width: '2'
Length: '02'
UnitOfMeasurement:
Description: desc
Code: IN
Packaging:
Description: desc
Code: '02'
Description: desc
- Description: desc
Packaging:
Code: '02'
Description: desc
Dimensions:
UnitOfMeasurement:
Code: IN
Description: desc
Length: '02'
Width: '2'
Height: '2'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: desc
Weight: '50'
Description: UPS Premier
Shipper:
Name: ShipperName
AttentionName: GA
CompanyDisplayableName: GA
TaxIdentificationNumber: '12345'
Phone:
Number: '1234567890'
Extension: '12'
ShipperNumber: " "
FaxNumber: '2134'
EMailAddress: " "
Address:
AddressLine:
- address
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipTo:
Name: ship
AttentionName: GA
CompanyDisplayableName: GA
TaxIdentificationNumber: '1234'
Phone:
Number: '1234567890'
Extension: '12'
FaxNumber: '1234'
EMailAddress: " "
Address:
AddressLine:
- AddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ResidentialAddressIndicator: Y
ShipFrom:
Name: ship
AttentionName: GA
CompanyDisplayableName: ShipFrom_CompanyDisplayableName
TaxIdentificationNumber: '5555555555'
Phone:
Number: '1234567890'
Extension: '12'
FaxNumber: '5555555555'
Address:
AddressLine:
- AddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
EMailAddress: " "
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: " "
Service:
Code: '01'
Description: desc
LabelSpecification:
LabelImageFormat:
Code: ZPL
Description: desc
HTTPUserAgent: Mozilla/4.5
LabelStockSize:
Height: '6'
Width: '4'
'Ship to a UPS Access Point':
summary: Ship to a UPS Access Point
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
TransactionReference:
CustomerContext: ''
Shipment:
Description: D2R shipments
Shipper:
Name: Shipper Name
AttentionName: Attn. Name
CompanyDisplayableName: Shipper company
TaxIdentificationNumber: '456789'
Phone:
Number: '5555555555'
ShipperNumber: " "
EMailAddress: " "
Address:
AddressLine:
- AddressLine1
City: BOLTON
StateProvinceCode: 'ON'
PostalCode: '20999'
CountryCode: DE
ShipTo:
Name: ShipTo Name
AttentionName: ShipTo Attn. Name
CompanyDisplayableName: ShipTo Company
Phone:
Number: '6787462345'
EMailAddress: " "
Address:
AddressLine:
- Morris Rd
City: Alpharetta
StateProvinceCode: 'ON'
PostalCode: L7E5C1
CountryCode: CA
AlternateDeliveryAddress:
AttentionName: Attn. Name
Name: Alt. Name
UPSAccessPointID: GB00088
Address:
AddressLine:
- Morris RD
City: Alpharetta
StateProvinceCode: 'ON'
PostalCode: '20999'
CountryCode: DE
ShipFrom:
Name: ShipFrom Name
AttentionName: ShipFrom Attn. Name
CompanyDisplayableName: ShipFrom company
Phone:
Number: '6787463456'
ShipFromAccountNumber: " "
Address:
AddressLine:
- Old Alpharetta rd
City: BOLTON
StateProvinceCode: 'ON'
PostalCode: '20999'
CountryCode: DE
EMailAddress: " "
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: " "
Service:
Code: '11'
Description: Express
ShipmentIndicationType:
Code: '01'
Description: D2R shipment
ShipmentServiceOptions:
Notification:
NotificationCode: '012'
EMail:
EMailAddress: " "
VoiceMessage:
PhoneNumber: '5555555555'
TextMessage:
PhoneNumber: '5555555555'
Locale:
Language: ENG
Dialect: US
Package:
Description: D2R shipment
Packaging:
Code: '02'
Description: D2R package
Dimensions:
UnitOfMeasurement:
Code: CM
Description: Centemeters
Length: '5'
Width: '6'
Height: '7'
PackageWeight:
UnitOfMeasurement:
Code: KGS
Description: Kilograms
Weight: '15'
PackageServiceOptions:
DeclaredValue:
Type:
Code: '01'
Description: Declared value
CurrencyCode: EUR
MonetaryValue: '10.30'
LabelSpecification:
LabelImageFormat:
Code: GIF
LabelStockSize:
Height: '6'
Width: '4'
'World Wide Economy Shipping':
summary: World Wide Economy Shipping
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '2108'
TransactionReference:
CustomerContext: ''
Shipment:
Description: Worldwide econmoy Parcel
Shipper:
Name: Shipper_name
AttentionName: UPS
CompanyDisplayableName: Shipper_name
Phone:
Number: '1234567890'
Extension: '1234'
ShipperNumber: ''
FaxNumber: '1234'
EMailAddress: ''
Address:
AddressLine:
- 2311 York Rd
- 2311 York Rd
- 2311 York Rd
City: Lutherville Timonium
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: Happy Dog Pet Supply
AttentionName: ShipToName
CompanyDisplayableName: ShipToName
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
EMailAddress: ''
Address:
AddressLine:
- 12380 Morris Road
- 12380 Morris Road
- 12380 Morris Road
City: STARZACH
StateProvinceCode: GA
PostalCode: '72181'
CountryCode: DE
ShipFrom:
Name: UPS
AttentionName: ShipFromName
CompanyDisplayableName: ShipFromName
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Description: EIN
Phone:
Number: '1234567890'
Extension: '1234'
ShipFromAccountNumber: ''
FaxNumber: '1234'
Address:
AddressLine:
- 2311 York Rd
- 2311 York Rd
- 2311 York Rd
City: Lutherville Timonium
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
EMailAddress: ''
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: ''
ShipmentRatingOptions:
NegotiatedRatesIndicator: Y
Service:
Code: '072'
Description: UPS Worldwide Economy DDP
NumOfPiecesInShipment: ''
ShipmentValueThresholdCode: ''
ShipmentServiceOptions:
Notification:
NotificationCode: '6'
EMail:
EMailAddress: ''
UndeliverableEMailAddress: ''
FromEMailAddress: ''
FromName: ''
Memo: '1905'
MasterCartonIndicator: Y
Package:
Description: Worldwide econmoy Postal
NumOfPieces: '10'
Packaging:
Code: '02'
Description: Customer Supplied Package
Dimensions:
UnitOfMeasurement:
Code: IN
Description: IN
Length: '10'
Width: '10'
Height: '10'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '0.1'
LabelSpecification:
LabelImageFormat:
Code: GIF
Description: GIF
HTTPUserAgent: Mozilla/4.5
'Proactive Response Shipping':
summary: Proactive Response Shipping
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
TransactionReference:
CustomerContext: ''
SubVersion: '1701'
Shipment:
Description: '1701'
Shipper:
Name: Shipper_Name
AttentionName: Shipper_AttentionName
TaxIdentificationNumber: '123456'
Phone:
Number: '1234567890'
ShipperNumber: ''
Address:
AddressLine:
- 12380 Morris Rd
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipTo:
Name: ShipTo_CompanyName
AttentionName: ShipTo_AttentionName
Phone:
Number: '1234567890'
FaxNumber: '1234567890'
TaxIdentificationNumber: '123456'
Address:
AddressLine:
- 793 Foothill Blvd
City: San Luis Obispo
StateProvinceCode: CA
PostalCode: '93405'
CountryCode: US
ShipFrom:
Name: ShipFrom_CompanyName
AttentionName: ShipFrom_AttentionName
Phone:
Number: '1234567890'
FaxNumber: '1234567890'
TaxIdentificationNumber: '123456'
Address:
AddressLine:
- 12380 Morris Rd
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '03'
Description: Ground
Package:
Description: Package Description
Packaging:
Code: '02'
Description: Customer Supplied Package
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '10'
Width: '10'
Height: '10'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Weight: '1'
PackageServiceOptions:
ProactiveIndicator: X
LabelSpecification:
LabelImageFormat:
Code: GIF
'Shipping with EEI Form':
summary: Shipping with EEI Form
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '1901'
TransactionReference:
CustomerContext: ''
Shipment:
Description: IF
Shipper:
Name: Shipper_name
AttentionName: Shipper_name
CompanyDisplayableName: Shipper_name
Phone:
Number: '1234567890'
Extension: '1234'
ShipperNumber: ''
FaxNumber: '8002222222'
EMailAddress: ''
Address:
AddressLine:
- 2 South Main Street
City: LONDON
StateProvinceCode: GA
PostalCode: TW59NR
CountryCode: GB
ShipTo:
Name: ShipToName
AttentionName: ShipToName
CompanyDisplayableName: ShipToName
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
EMailAddress: ''
Address:
AddressLine:
- 103 Avenue des Champs-Élysées
City: Paris
StateProvinceCode: ''
PostalCode: '75008'
CountryCode: FR
ShipFrom:
Name: ShipFromName
AttentionName: ShipFromName
CompanyDisplayableName: ShipFromName
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Description: IF
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
Address:
AddressLine:
- 2 South Main Street
City: TW59NR
StateProvinceCode: GA
PostalCode: TW59NR
CountryCode: GB
EMailAddress: ''
VendorInfo:
VendorCollectIDTypeCode: '0356'
VendorCollectIDNumber: IMDEU1234567
ConsigneeType: '01'
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '96'
Description: IF
InvoiceLineTotal:
CurrencyCode: USD
MonetaryValue: '10'
NumOfPiecesInShipment: '1'
ShipmentServiceOptions:
InternationalForms:
FormType: '01'
CN22Form:
LabelSize: '6'
PrintsPerPage: '1'
LabelPrintType: pdf
CN22Type: '1'
CN22OtherDescription: test cn22
FoldHereText: fold
CN22Content:
CN22ContentQuantity: '300'
CN22ContentDescription: desc
CN22ContentWeight:
UnitOfMeasurement:
Code: LBS
Description: LBS
Weight: '70'
CN22ContentTotalValue: '2'
CN22ContentCurrencyCode: USD
CN22ContentCountryOfOrigin: US
CN22ContentTariffNumber: '4565655'
FormGroupIdName: Invoice
SEDFilingOption: ''
EEIFilingOption:
Code: '1'
EMailAddress: ''
Description: EEI
UPSFiled:
POA:
Code: '1'
Description: POA
ShipperFiled:
Code: B
Description: ShipperFiled
PreDepartureITNNumber: ''
ExemptionLegend: ''
EEIShipmentReferenceNumber: '1234'
Contacts:
ForwardAgent:
CompanyName: UPS
TaxIdentificationNumber: 94-308351500
Address:
AddressLine:
- AddressLine
City: Alpharetta
StateProvinceCode: GA
Town: Town
PostalCode: '30005'
CountryCode: US
UltimateConsignee:
CompanyName: UPS
Address:
AddressLine:
- Address
City: Alpharetta
StateProvinceCode: GA
Town: TOWN
PostalCode: '30005'
CountryCode: US
UltimateConsigneeType:
Code: D
Description: Direct Consumer
Producer:
Option: ''
CompanyName: ProducerCompanyName
TaxIdentificationNumber: '1234'
Address:
AddressLine:
- Address
City: Marietta
StateProvinceCode: GA
Town: Town
PostalCode: '166222'
CountryCode: CA
AttentionName: Name
Phone:
Number: '1234567890'
Extension: '1234'
EMailAddress: ''
SoldTo:
Name: ACME Designs
AttentionName: ACME Designs
TaxIdentificationNumber: '1234'
Phone:
Number: '1234567890'
Extension: '1234'
Option: '01'
Address:
AddressLine:
- 103 Avenue des Champs-Élysées
City: Paris
StateProvinceCode: ''
PostalCode: '75008'
CountryCode: FR
EMailAddress: ''
Product:
Description: Widgets
Unit:
Number: '1'
UnitOfMeasurement:
Code: KGS
Description: LBS
Value: '1'
CommodityCode: '12345679'
PartNumber: '1234'
OriginCountryCode: US
JointProductionIndicator: ''
NetCostCode: NC
NetCostDateRange:
BeginDate: '20220115'
EndDate: '20220816'
PreferenceCriteria: A
ProducerInfo: 'Yes'
MarksAndNumbers: '1'
NumberOfPackagesPerCommodity: '1'
ProductWeight:
UnitOfMeasurement:
Code: KGS
Description: Description
Weight: '10'
ScheduleB:
Number: '12345'
Quantity: '5'
UnitOfMeasurement:
Code: PCS
Description: PCS
ExportType: D
SEDTotalValue: '123.45'
PackingListInfo:
PackageAssociated:
PackageNumber: '01'
ProductAmount: '147'
EEIInformation:
ExportInformation: OS
License:
Number: 123.16B2
Code: C30
LicenseLineValue: ''
ECCNNumber: EAR99
InvoiceNumber: asdf123
InvoiceDate: '20130410'
PurchaseOrderNumber: 999jjj777
TermsOfShipment: CFR
ReasonForExport: Sale
Comments: Enter in any extra information about the current
shipment.
Discount:
MonetaryValue: '100'
FreightCharges:
MonetaryValue: '75'
InsuranceCharges:
MonetaryValue: '789'
OtherCharges:
MonetaryValue: '10'
Description: '10'
CurrencyCode: USD
BlanketPeriod:
BeginDate: '20130420'
EndDate: '20130430'
ExportDate: '20210406'
ExportingCarrier: A
CarrierID: IATA
InBondCode: '70'
EntryNumber: 1A34567876545360
PointOfOrigin: MS
PointOfOriginType: MS
ModeOfTransport: Rail
PortOfExport: Overland
PortOfUnloading: Germany
LoadingPier: Pier 17 Dock 31
PartiesToTransaction: N
License:
Number: ''
Date: ''
ExceptionCode: ''
ECCNNumber: ''
Package:
Description: IF
Packaging:
Code: '30'
Description: IF
Dimensions:
UnitOfMeasurement:
Code: CM
Description: IF
Length: '50'
Width: '37'
Height: '40'
PackageWeight:
UnitOfMeasurement:
Code: KGS
Description: IF
Weight: '50'
USPSEndorsement: ''
CostCenter: '123'
PackageID: ''
InformationSourceCode: ''
ShipmentValueThresholdCode: '01'
'Shipping with Tax ID':
summary: Shipping with Tax ID
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '1901'
TransactionReference:
CustomerContext: ''
Shipment:
Description: IF
Shipper:
Name: Shipper_name
AttentionName: Shipper_name
CompanyDisplayableName: Shipper_name
Phone:
Number: '1234567890'
Extension: '1234'
ShipperNumber: ''
FaxNumber: '8002222222'
EMailAddress: ''
Address:
AddressLine:
- 2 South Main Street
City: LONDON
StateProvinceCode: GA
PostalCode: TW59NR
CountryCode: GB
ShipTo:
Name: ShipToName
AttentionName: ShipToName
CompanyDisplayableName: ShipToName
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
EMailAddress: ''
Address:
AddressLine:
- 2311 York Rd
City: STARZACH
StateProvinceCode: GA
PostalCode: '72181'
CountryCode: DE
ShipFrom:
Name: ShipFromName
AttentionName: ShipFromName
CompanyDisplayableName: ShipFromName
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Description: IF
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
Address:
AddressLine:
- 2 South Main Street
City: TW59NR
StateProvinceCode: GA
PostalCode: TW59NR
CountryCode: GB
EMailAddress: ''
VendorInfo:
VendorCollectIDTypeCode: '0356'
VendorCollectIDNumber: IMDEU1234567
ConsigneeType: '01'
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '96'
Description: IF
InvoiceLineTotal:
CurrencyCode: USD
MonetaryValue: '10'
NumOfPiecesInShipment: '1'
ShipmentServiceOptions:
InternationalForms:
FormType: '01'
CN22Form:
LabelSize: '6'
PrintsPerPage: '1'
LabelPrintType: pdf
CN22Type: '1'
CN22OtherDescription: test cn22
FoldHereText: fold
CN22Content:
CN22ContentQuantity: '300'
CN22ContentDescription: desc
CN22ContentWeight:
UnitOfMeasurement:
Code: LBS
Description: LBS
Weight: '70'
CN22ContentTotalValue: '2'
CN22ContentCurrencyCode: USD
CN22ContentCountryOfOrigin: US
CN22ContentTariffNumber: '4565655'
FormGroupIdName: Invoice
SEDFilingOption: ''
EEIFilingOption:
Code: '1'
EMailAddress: ''
Description: EEI
UPSFiled:
POA:
Code: '1'
Description: POA
ShipperFiled:
Code: B
Description: ShipperFiled
PreDepartureITNNumber: ''
ExemptionLegend: ''
EEIShipmentReferenceNumber: '1234'
Contacts:
ForwardAgent:
CompanyName: UPS
TaxIdentificationNumber: '12345'
Address:
AddressLine:
- AddressLine
City: Alpharetta
StateProvinceCode: GA
Town: Town
PostalCode: '30005'
CountryCode: US
UltimateConsignee:
CompanyName: UPS
Address:
AddressLine:
- Address
City: Alpharetta
StateProvinceCode: GA
Town: TOWN
PostalCode: '30005'
CountryCode: US
UltimateConsigneeType:
Code: D
Description: Direct Consumer
Producer:
Option: ''
CompanyName: ProducerCompanyName
TaxIdentificationNumber: '1234'
Address:
AddressLine:
- Address
City: Marietta
StateProvinceCode: GA
Town: Town
PostalCode: '166222'
CountryCode: CA
AttentionName: Name
Phone:
Number: '1234567890'
Extension: '1234'
EMailAddress: ''
SoldTo:
Name: ACME Designs
AttentionName: ACME Designs
TaxIdentificationNumber: '1234'
Phone:
Number: '1234567890'
Extension: '1234'
Option: '01'
Address:
AddressLine:
- Address
City: STARZACH
StateProvinceCode: GA
Town: town
PostalCode: '72181'
CountryCode: DE
EMailAddress: ''
Product:
Description: Description
Unit:
Number: '1'
UnitOfMeasurement:
Code: KGS
Description: LBS
Value: '1'
CommodityCode: '12345679'
PartNumber: '1234'
OriginCountryCode: US
JointProductionIndicator: ''
NetCostCode: NC
NetCostDateRange:
BeginDate: '20110115'
EndDate: '20110816'
PreferenceCriteria: A
ProducerInfo: 'Yes'
MarksAndNumbers: '1'
NumberOfPackagesPerCommodity: '1'
ProductWeight:
UnitOfMeasurement:
Code: KGS
Description: Desc
Weight: '10'
ScheduleB:
Number: '12345'
Quantity: '5'
UnitOfMeasurement:
Code: PCS
Description: PCS
ExportType: D
SEDTotalValue: '123.45'
PackingListInfo:
PackageAssociated:
PackageNumber: '01'
ProductAmount: '147'
EEIInformation:
ExportInformation: OS
License:
Number: 123.16B2
Code: C30
LicenseLineValue: ''
ECCNNumber: EAR99
InvoiceNumber: asdf123
InvoiceDate: '20130410'
PurchaseOrderNumber: 999jjj777
TermsOfShipment: CFR
ReasonForExport: Sale
Comments: Enter in any extra information about the current
shipment.
Discount:
MonetaryValue: '100'
FreightCharges:
MonetaryValue: '75'
InsuranceCharges:
MonetaryValue: '789'
OtherCharges:
MonetaryValue: '10'
Description: '10'
CurrencyCode: USD
BlanketPeriod:
BeginDate: '20130420'
EndDate: '20130430'
ExportDate: '20210406'
ExportingCarrier: A
CarrierID: IATA
InBondCode: '70'
EntryNumber: 1A34567876545360
PointOfOrigin: MS
PointOfOriginType: MS
ModeOfTransport: Rail
PortOfExport: Overland
PortOfUnloading: Germany
LoadingPier: Pier 17 Dock 31
PartiesToTransaction: N
License:
Number: ''
Date: ''
ExceptionCode: ''
ECCNNumber: ''
Package:
Description: IF
Packaging:
Code: '30'
Description: IF
Dimensions:
UnitOfMeasurement:
Code: CM
Description: IF
Length: '50'
Width: '37'
Height: '40'
PackageWeight:
UnitOfMeasurement:
Code: KGS
Description: IF
Weight: '50'
USPSEndorsement: ''
CostCenter: '123'
PackageID: ''
InformationSourceCode: ''
ShipmentValueThresholdCode: '01'
'Shipping with Carbon Offsets':
summary: Shipping with Carbon Offsets
value:
ShipmentRequest:
Shipment:
Description: DG
ShipmentDate: '20231012'
Shipper:
Name: Shipper_name
AttentionName: Shipper_name
CompanyDisplayableName: Shipper_name
Phone:
Number: '1234567890'
Extension: '1234'
ShipperNumber: 3217GG
FaxNumber: '1234'
EMailAddress: test@ups.com
Address:
AddressLine:
- ShipperAddress
- ShipperAddress
- ShipperAddress
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipTo:
Name: ShipToName
AttentionName: ShipToName
CompanyDisplayableName: ShipToName
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
EMailAddress: test@ups.com
Address:
AddressLine:
- ShipToAddress
- ShipToAddress
- ShipToAddress
City: carrollton
StateProvinceCode: GA
PostalCode: '30117'
CountryCode: US
ShipFrom:
Name: ShipFromName
AttentionName: ShipFromName
CompanyDisplayableName: ShipFromName
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
Address:
AddressLine:
- ShipFromAddress
- ShipFromAddress
- ShipFromAddress
City: Texas
StateProvinceCode: TX
PostalCode: '77040'
CountryCode: US
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: 3217GG
Service:
Code: '01'
Description: Next Day Air
InvoiceLineTotal:
CurrencyCode: USD
MonetaryValue: '10'
NumOfPiecesInShipment: '1'
ShipmentServiceOptions:
UPScarbonneutralIndicator: ''
Package:
Description: DG
NumOfPieces: '10'
Packaging:
Code: '02'
Description: desc
Dimensions:
UnitOfMeasurement:
Code: IN
Description: IN
Length: '2'
Width: '2'
Height: '2'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: LBS
Weight: '50'
PackageServiceOptions:
PackedByStoreIndicator: ''
PackageIdentifier: '123'
'Trade direct - Master shipment ':
summary: Trade direct - Master shipment
description: Trade direct master shipment creation request.
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '2205'
TransactionReference:
CustomerContext: Verify success responses for TD Master from CA to US.
TransactionIdentifier: ''
Shipment:
TradeDirect:
GeneralDescriptionOfGoods: Phones and Accessories
Master:
SoldToSameAsShipTo: 'True'
Pickup:
Name: UPS SCS c/o FMI Logistics
AttentionName: Origin CFS
Phone:
Number: '4103330104'
Extension: '123'
Address:
AddressLine: 7151-44th Street SE
City: Calgary
StateProvinceCode: AB
PostalCode: T2C4E8
CountryCode: CA
EMailAddress: abc@ups.com
SoldTo:
Name: Ace Levy
AttentionName: Doc
CompanyDisplayableName: UPS SCS
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Description: EIN
Phone:
Number: '4103330104'
Extension: '123'
FaxNumber: '4103334104'
Address:
AddressLine: 1221 29th St NW STE A
City: Auburn
StateProvinceCode: WA
PostalCode: '98001'
CountryCode: US
EMailAddress: abc@ups.com
TradeComplianceDetails:
TermsOfShipment: CFR
ReasonForExport: For Sale
Comments: Exported
DeclarationStatement: Invoice
NotificationBeforeDelivery:
RequestType: '001'
MediaTypeCode: '03'
Language: ENG
Dialect: US
ShipFromCompanyName: UPS SCS
CompanyName: UPS SCS
Phone:
Number: '3103330104'
Extension: '555'
Name: TD mail Notification
SubjectLine: subnotice
Memo: notimo
EmailAddress: abc@ups.com
AlternateEmailAddress: abc@ups.com
UomType: Imperial
CurrencyCode: CAD
ShipmentType: TRADEDIRECTCROSSBORDER
Description: TD test Case
Shipper:
Name: 'UPS TDCB'
AttentionName: Katrina
CompanyDisplayableName: UPS TDCB
TaxIdentificationNumber: '12345'
Phone:
Number: '1234567890'
Extension: '123'
ShipperNumber: 'XXXXXX'
FaxNumber: '1234'
EMailAddress: abc@ups.com
Address:
AddressLine: 1221 29th St NW STE A
City: Auburn
StateProvinceCode: WA
PostalCode: '98001'
CountryCode: US
ShipTo:
Name: UPS TDCB
AttentionName: Master Brunt
CompanyDisplayableName: UPS TDCB
Phone:
Number: '1234567890'
Extension: '123'
FaxNumber: '1234'
EMailAddress: abc@ups.com
Address:
AddressLine: 1221 29th St NW STE A
City: Auburn
StateProvinceCode: WA
PostalCode: '98001'
CountryCode: US
ShipFrom:
Name: UPS TDCB
AttentionName: 'Johnny '
CompanyDisplayableName: UPS TDCB
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Description: EIN
Phone:
Number: '1234567890'
Extension: '123'
ShipFromAccountNumber: 'XXXXXX'
FaxNumber: '1234'
Address:
AddressLine: 7151-44th Street SE
City: Calgary
StateProvinceCode: AB
PostalCode: T2C4E8
CountryCode: CA
EMailAddress: abc@ups.com
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: 'XXXXXX'
Service:
Code: T0
Description: UPS WW Expedited
InvoiceLineTotal:
CurrencyCode: USD
MonetaryValue: '10'
NumOfPiecesInShipment: '1'
ShipmentServiceOptions: ''
BarCodeImageIndicator: ''
BarCodeAndLabelIndicator: ''
ShipmentDate: '20250424'
LabelSpecification:
LabelImageFormat:
Code: GIF
Description: GIF
HTTPUserAgent: Mozilla/4.5
'Trade direct - Child shipment':
summary: Trade direct - Child shipment
description: Trade direct child shipment creation request.
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '2205'
TransactionReference:
CustomerContext: >-
verify success reponse when child shipment is created with TD account.
TransactionIdentifier: ''
Shipment:
TradeDirect:
Child:
Product:
- Code: KGS
Description: iPhones Apple
UnitPrice: '20'
TotalValue: '100'
NumberOfUnits: '5'
ProductNumber: AP78
CountryOriginCode: US
UnitOfMeasure: KGS
- Code: KGS
Description: iPhones Cases
UnitPrice: '5'
TotalValue: '25'
NumberOfUnits: '5'
ProductNumber: CP24
CountryOriginCode: US
UnitOfMeasure: KGS
Type: SMALLPACKAGE
USI: ''
ShipmentType: TRADEDIRECTCROSSBORDER
CurrencyCode: CAD
Description: Trade Direct TEstCase
Shipper:
Name: UPS TDCB
AttentionName: Katrina
CompanyDisplayableName: UPS TDCB
TaxIdentificationNumber: '12345'
Phone:
Number: '1234567890'
Extension: '123'
ShipperNumber: 'XXXXXX'
FaxNumber: '1234'
EMailAddress: abc@ups.com
Address:
AddressLine: 1221 29th St NW STE A
City: Auburn
StateProvinceCode: WA
PostalCode: '98001'
CountryCode: US
ShipTo:
Name: Reven Riverside
AttentionName: Stone
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
EMailAddress: abc@ups.com
Address:
AddressLine: 403 Broadford Rd
City: Bellevue
StateProvinceCode: ID
PostalCode: '83313'
CountryCode: US
ShipFrom:
Name: UPS TDCB
AttentionName: Master Brunt
CompanyDisplayableName: UPS TDCB
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Description: EIN
Phone:
Number: '1234567890'
Extension: '123'
ShipFromAccountNumber: ''
FaxNumber: '1234'
Address:
AddressLine: 1221 29th St NW STE A
City: Auburn
StateProvinceCode: WA
PostalCode: '98001'
CountryCode: US
EMailAddress: abc@ups.com
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: 'XXXXXX'
Service:
Code: '01'
Description: UPS Ground
InvoiceLineTotal:
CurrencyCode: USD
MonetaryValue: '10'
NumOfPiecesInShipment: '1'
ShipmentServiceOptions:
Notification:
NotificationCode: '6'
EMail:
EMailAddress: abc@ups.com
TextMessage:
PhoneNumber: '9494974020'
Locale:
Language: ENG
Dialect: US
ShipmentDate: '20250424'
Package:
Description: Worldwide econmoy Postal
NumOfPieces: '10'
Packaging:
Code: '02'
Description: customer Package
Dimensions:
UnitOfMeasurement:
Code: IN
Description: IN
Length: '4'
Width: '3'
Height: '3'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: LBS
Weight: '3'
ShipmentRatingOptions:
NegotiatedRatesIndicator: ''
LabelSpecification:
LabelImageFormat:
Code: png
Description: png
HTTPUserAgent: Mozilla/4.5
LabelStockSize:
Height: '6'
Width: '4'
'Trade direct - LTL shipment':
summary: Trade direct - LTL shipment
description: Trade direct LTL child shipment creation request.
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '2205'
TransactionReference:
CustomerContext: >-
verify success reponse when LTL child shipment is created with TD account.
TransactionIdentifier: ''
Shipment:
TradeDirect:
Child:
Product:
- Code: KGS
Description: Lipstick
UnitPrice: '8'
TotalValue: '40'
NumberOfUnits: '5'
ProductNumber: LS56
CurrencyCode: CAD
CountryOriginCode: US
UnitOfMeasure: CR
- Code: BOX
Description: Compack
UnitPrice: '8'
TotalValue: '40'
NumberOfUnits: '5'
ProductNumber: CP57
CurrencyCode: CAD
CountryOriginCode: US
UnitOfMeasure: CR
- Code: BOX
Description: 'Lip Liner '
UnitPrice: '8'
TotalValue: '40'
NumberOfUnits: '5'
ProductNumber: LL58
CurrencyCode: CAD
CountryOriginCode: US
UnitOfMeasure: CR
LtlPackage:
NumberOfIdenticalUnits: "1"
HandlingUnits:
Quantity: '1'
Type: BOXES
FreightClass: '150'
Dimensions:
Length: '10'
Width: '10'
Height: '10'
UnitOfMeasurement: IN
PackageWeight:
Weight: '10'
UnitOfMeasurement: LBS
Type: LTL
USI: ''
ShipmentType: TRADEDIRECTCROSSBORDER
CurrencyCode: CAD
Description: Trade Direct TestCase
Shipper:
Name: UPS TDCB
AttentionName: Katrina
CompanyDisplayableName: UPS TDCB
TaxIdentificationNumber: '12345'
Phone:
Number: '1234567890'
Extension: '123'
ShipperNumber: 'XXXXXX'
FaxNumber: '1234'
EMailAddress: abc@ups.com
Address:
AddressLine: 1221 29th St NW STE A
City: Auburn
StateProvinceCode: WA
PostalCode: '98001'
CountryCode: US
ShipTo:
Name: Reven Riverside
AttentionName: Stone
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
EMailAddress: abc@ups.com
Address:
AddressLine: 403 Broadford Rd
City: Bellevue
StateProvinceCode: ID
PostalCode: '83313'
CountryCode: US
ShipFrom:
Name: UPS TDCB
AttentionName: Master Brunt
CompanyDisplayableName: UPS TDCB
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Description: EIN
Phone:
Number: '1234567890'
Extension: '123'
ShipFromAccountNumber: 'XXXXXX'
FaxNumber: '1234'
Address:
AddressLine: '1221 29th St NW STE A'
City: Auburn
StateProvinceCode: WA
PostalCode: '98001'
CountryCode: US
EMailAddress: abc@ups.com
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: 'XXXXXX'
Service:
Code: T1
Description: UPS Trade Direct
InvoiceLineTotal:
CurrencyCode: USD
MonetaryValue: '10'
NumOfPiecesInShipment: '1'
ShipmentServiceOptions: ''
ShipmentDate: '20250424'
Package:
Description: Worldwide econmoy Postal
NumOfPieces: '10'
Packaging:
Code: '02'
Description: customer Package
Dimensions:
UnitOfMeasurement:
Code: IN
Description: IN
Length: '40'
Width: '30'
Height: '30'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: KGS
Weight: '30'
ShipmentRatingOptions:
NegotiatedRatesIndicator: ''
LabelSpecification:
LabelImageFormat:
Code: GIF
Description: GIF
HTTPUserAgent: Mozilla/4.5
LabelStockSize:
Height: '6'
Width: '4'
'WorldEase Shipment':
summary: WorldEase Shipment
description: A basic WorldEase shipment request with a single package
value:
Request:
RequestOption: Validate
SubVersion: "1607"
TransactionReference:
CustomerContext: GovTest
TransactionIdentifier: UPS123
Shipment:
Shipper:
Name: UPS Corporate
AttentionName: Governance Team
Address:
AddressLine1: 55 Glenlake Parkway NorthEast
City: Atlanta
CountryCode: US
PostalCode: "30028"
StateProvinceCode: GA
Phone: "1234567890"
ShipperNumber: 34BY43
TaxIdentificationNumber: "12344"
ShipFrom:
Name: UPS Corporate
Address:
AddressLine1: 55 Glenlake Parkway NorthEast
City: Atlanta
CountryCode: US
PostalCode: "30028"
StateProvinceCode: GA
Phone: "1234567890"
FaxNumber: "1234567999"
TaxIdentificationNumber: "12344"
ShipTo:
Name: ShipToName
AttentionName: MIG Team
Address:
AddressLine1: 2311 York Rd.
City: Lutherville-Timonium
CountryCode: US
PostalCode: "21093"
StateProvinceCode: MD
Phone: "1234567890"
FaxNumber: "1234567999"
TaxIdentificationNumber: "456999"
Package:
- Description: International Goods
PackageWeight:
UnitOfMeasurement:
Code: LBS
Weight: "10"
Packaging:
Code: "02"
Service:
Code: "01"
Description: Expedited
WorldEase:
DestinationCountryCode: FR
DestinationPostalCode: 30005-4616
GCCN: 123X56GPFWZ
MasterEUConsolidationIndicator: "0"
MasterHasDocBox: "0"
MasterShipmentChgType: FOB
VendorCollectIDNumberExemptIndicator: false
PortOfEntry:
Name: Seagirt Terminal, Port of Baltimore
Consignee: John Doe
Address:
AddressLine1: 2600 Broening Hwy
City: Baltimore
CountryCode: US
PostalCode: "21224"
StateProvinceCode: MD
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/SHIPResponseWrapper"
'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"
"/shipments/{version}/void/cancel/{shipmentidentificationnumber}":
delete:
description: The Void Shipping API is used to cancel the previously scheduled
shipment
summary: Void Shipment
tags:
- Shipping
security:
- OAuth2: []
operationId: VoidShipment
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
required: false
- in: header
name: transactionSrc
schema:
type: string
default: testing
description: An identifier of the client/source application that is making
the request.Length 512
required: false
- in: header
name: shipperNumber
schema:
type: string
description: "Shipper Number
Required only for Roadie Shipments"
required: false
- in: query
name: trackingnumber
schema:
type: string
minimum: 1
description: "The package's tracking number. You may have \nup to 20 different
tracking numbers listed.\nIf more than one tracking number, pass this \nvalue
as: trackingnumber= \n[\"1ZISUS010330563105\",\"1ZISUS01033056310\n8\"]
with a coma separating each number.\nAlpha-numeric. Must pass 1Z rules.
Must be \nupper case. Length 18"
required: false
- in: path
name: version
schema:
type: string
default: v2409
description: |
API Version
Valid values:
- v3 (Valid only for Roadie Shipments)
- v2409
required: true
- in: path
name: shipmentidentificationnumber
schema:
type: string
minimum: 1
description: "The shipment's identification number \nAlpha-numeric. Must pass
1Z rules. Must be \nupper case. Length 18"
required: true
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/VOIDSHIPMENTResponseWrapper"
'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"
"/labels/{version}/recovery":
post:
description: The Label Shipping API allows us to retrieve forward and return
labels.
summary: Label Recovery
tags:
- Shipping
security:
- OAuth2: []
operationId: LabelRecovery
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
required: false
- in: header
name: transactionSrc
schema:
type: string
default: testing
description: An identifier of the client/source application that is making
the request.Length 512
required: false
- in: path
name: version
schema:
type: string
minimum: 1
default: v1
description: "When UPS introduces new elements in the \nresponse that are
not associated with new \nrequest elements, Subversion is used. This \nensures
backward compatibility. \nv1 original features of the application. No \nsupport
for CODTurn-inPage, HighValueReport \nor InternationalForms features returned
in the \nresponse\nv1701 includes support for CODTurn-inPage \nfeatures
returned in the response.\nV1903\n Length 5.To support Roadie labels, the API version
in the URL must be v2603."
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/LABELRECOVERYRequestWrapper"
examples:
'Standard Example':
summary: Label Recovery Request (Standard Example)
value:
LabelRecoveryRequest:
LabelDelivery:
LabelLinkIndicator: ''
ResendEmailIndicator: ''
LabelSpecification:
HTTPUserAgent: Mozilla/4.5
LabelImageFormat:
Code: ZPL
LabelStockSize:
Height: '6'
Width: '4'
Request:
RequestOption: Non_Validate
SubVersion: '1903'
TransactionReference:
CustomerContext: ''
TrackingNumber: 1Z12345E8791315509
Translate:
Code: '01'
DialectCode: US
LanguageCode: eng
'Label Recovery Request (Roadie)':
summary: Label Recovery Request (Roadie)
value:
LabelRecoveryRequest:
LabelSpecification:
LabelImageFormat:
Code: GIF
Request:
SubVersion: '2603'
TransactionReference:
CustomerContext: 'Success case'
TrackingNumbers:
TrackingNumber:
- 1R12345678912345
- 1R12356732456789
ReferenceValues:
ShipperNumber: 'XXXXXX'
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/LABELRECOVERYResponseWrapper"
'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"
"/shipments/{deprecatedVersion}/ship":
post:
deprecated: true
description: "The Shipping API makes UPS shipping services available to client
applications that communicate with UPS \nusing the Internet"
summary: Shipment
tags:
- Shipping
security:
- OAuth2: []
operationId: Deprecated Shipment
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
required: false
- in: header
name: transactionSrc
schema:
type: string
default: testing
description: An identifier of the client/source application that is making
the request.Length 512
required: false
- in: query
name: additionaladdressvalidation
schema:
type: string
minimum: 1
description: "Valid Values: \ncity = validation will include city.Length 15"
required: false
- in: path
name: deprecatedVersion
schema:
type: string
minimum: 1
default: v1
description: |
Indicates Ship API to display the new release features in Ship API response based on Ship release.
Valid values:
- v1
- v1601
- v1607
- v1701
- v1707
- v1801
- v1807
- v2108
- v2205
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/SHIPRequestWrapper"
examples:
'Standard Example':
summary: Shipping Request(Standard Example)
value:
ShipmentRequest:
Request:
SubVersion: '1801'
RequestOption: nonvalidate
TransactionReference:
CustomerContext: ''
Shipment:
Description: Ship WS test
Shipper:
Name: ShipperName
AttentionName: ShipperZs Attn Name
TaxIdentificationNumber: '123456'
Phone:
Number: '1115554758'
Extension: " "
ShipperNumber: " "
FaxNumber: '8002222222'
Address:
AddressLine:
- 2311 York Rd
City: Timonium
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: Happy Dog Pet Supply
AttentionName: 1160b_74
Phone:
Number: '9225377171'
Address:
AddressLine:
- 123 Main St
City: timonium
StateProvinceCode: MD
PostalCode: '21030'
CountryCode: US
Residential: " "
ShipFrom:
Name: T and T Designs
AttentionName: 1160b_74
Phone:
Number: '1234567890'
FaxNumber: '1234567890'
Address:
AddressLine:
- 2311 York Rd
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: " "
Service:
Code: '03'
Description: Express
Package:
Description: " "
Packaging:
Code: '02'
Description: Nails
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '10'
Width: '30'
Height: '45'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '5'
LabelSpecification:
LabelImageFormat:
Code: GIF
Description: GIF
HTTPUserAgent: Mozilla/4.5
'Negotiated Rates':
summary: Shipping Request with Negotiated Rates
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '1601'
TransactionReference:
CustomerContext: ''
Shipment:
TaxInformationIndicator: ''
ShipmentRatingOptions:
NegotiatedRatesIndicator: X
Description: 1507 US shipment
Shipper:
Name: Shipper_name
AttentionName: Shipper_Attn.name
CompanyDisplayableName: Shipper_company
ShipperNumber: ''
Phone:
Number: '5555555555'
Address:
AddressLine:
- Shipper_Addrline1
City: BERLIN
StateProvinceCode: ''
PostalCode: '10785'
CountryCode: DE
ShipTo:
Name: ShipTo_name
AttentionName: ShipTo_Attn.name
CompanyDisplayableName: ShipTo_company
Phone:
Number: '5555555555'
Address:
AddressLine:
- Shipper_Addrline1
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFrom_name
AttentionName: ShipFrom_Attn.name
CompanyDisplayableName: ShipFrom_company
Address:
AddressLine:
- ShipFrom_Addrline1
City: BERLIN
StateProvinceCode: ''
PostalCode: '10785'
CountryCode: DE
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '07'
Description: UPS
Package:
Description: Package1
Packaging:
Code: '02'
Description: Customer Supplied Package
Dimensions:
UnitOfMeasurement:
Code: CM
Description: Centimeters
Length: '8'
Width: '2'
Height: '2'
PackageWeight:
UnitOfMeasurement:
Code: KGS
Description: Kilograms
Weight: '20.2'
'International Form':
summary: Shipping Request with International Forms
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
TransactionReference:
CustomerContext: ''
Shipment:
Description: Description of Goods
Shipper:
Name: Henry Lee Thomson
AttentionName: John Smith
ShipperNumber: " "
TaxIdentificationNumber: '456789'
Phone:
Number: '1234567890'
Address:
AddressLine:
- 34 Queen St
City: Toronto
StateProvinceCode: 'ON'
PostalCode: M5C2M6
CountryCode: CA
ShipTo:
Name: Happy Dog Pet Supply
AttentionName: Marley Brinson
TaxIdentificationNumber: '458889'
Phone:
Number: '1234567890'
Address:
AddressLine:
- B.B. King Blvd.
City: Charlotte
StateProvinceCode: NC
PostalCode: '28256'
CountryCode: US
ShipFrom:
Name: T and T Designs
AttentionName: Mike
Phone:
Number: '1234567890'
FaxNumber: '1234567999'
TaxIdentificationNumber: '456999'
Address:
AddressLine:
- 34 Queen St
City: Toronto
StateProvinceCode: 'ON'
PostalCode: M5C2M6
CountryCode: CA
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: " "
Service:
Code: '08'
Description: Expedited
Package:
Description: International Goods
Packaging:
Code: '02'
PackageWeight:
UnitOfMeasurement:
Code: KGS
Weight: '10'
ShipmentServiceOptions:
InternationalForms:
FormType: '04'
FormGroupIdName: USMCA Form
Contacts:
SoldTo:
Option: " "
Name: ACME Designs
AttentionName: Wile E Coyote
TaxIdentificationNumber: " "
Phone:
Number: '5551479876'
Address:
AddressLine:
- 123 Main St
City: Phoenix
StateProvinceCode: GA
PostalCode: '30076'
CountryCode: US
Producer:
Option: " "
CompanyName: Tree Service
Address:
AddressLine:
- 678 Elm St
City: Marietta
StateProvinceCode: GA
PostalCode: '30066'
CountryCode: US
Phone:
Number: '5555555555'
EmailAddress: " "
TaxIdentificationNumber: " "
Product:
Description: Today is the best day of the week
CommodityCode: '12345678'
OriginCountryCode: US
JointProductionIndicator: " "
NetCostCode: NC
NetCostDateRange:
BeginDate: '20050801'
EndDate: '20051015'
PreferenceCriteria: A
ProducerInfo: No[1]
BlanketPeriod:
BeginDate: '20050115'
EndDate: '20050816'
LabelSpecification:
LabelImageFormat:
Code: GIF
'Dry Ice/Lithium Batteries':
summary: Shipping Dry Ice or Lithium Batteries
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
TransactionReference:
CustomerContext: ''
SubVersion: '1701'
Shipment:
DGSignatoryInfo:
UploadOnlyIndicator: Y
ShipperDeclaration: '01'
Date: '20200112'
Place: GA
Title: DGPaperImage
Name: DGSignatory
Description: ER1703
Shipper:
Name: Shipper_Name
AttentionName: Shipper_AttentionName
TaxIdentificationNumber: '123456'
Phone:
Number: '1234567890'
ShipperNumber: " "
Address:
AddressLine:
- 12380 Morris Rd
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipTo:
Name: ShipTo_CompanyName
AttentionName: ShipTo_AttentionName
Phone:
Number: '1234567890'
FaxNumber: '1234567890'
TaxIdentificationNumber: '123456'
Address:
AddressLine:
- 793 Foothill Blvd
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipFrom:
Name: ShipFrom_CompanyName
AttentionName: ShipFrom_AttentionName
Phone:
Number: '1234567890'
FaxNumber: '1234567890'
TaxIdentificationNumber: '123456'
Address:
AddressLine:
- 12380 Morris Rd
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: " "
Service:
Code: '03'
Description: Ground
Package:
- HazMatPackageInformation:
OuterPackagingType: FIBERBOARD BOX
QValue: '0.1'
OverPackedIndicator: " "
AllPackedInOneIndicator: " "
Description: Package Description
Packaging:
Code: '02'
Description: Customer Supplied Package
Dimensions:
Length: '10'
Width: '10'
Height: '10'
UnitOfMeasurement:
Code: IN
Description: Inches
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '10'
PackageServiceOptions:
HazMat:
LocalProperShippingName: Ship
LocalTechnicalName: Local
EmergencyPhone: '1234567890'
ReferenceNumber: '12345'
HazardLabelRequired: Y
aDRPackingGroupLetter: '1'
PackagingTypeQuantity: '100'
SubRiskClass: SubRisk
aDRItemNumber: '1234567890'
TechnicalName: Hazmat TechnicalName
ClassDivisionNumber: '12345'
Quantity: '100.0'
UOM: IN
PackagingType: Box
IDNumber: UN3480
ProperShippingName: Lithium ion batteries
AdditionalDescription: Hazmat AdditionalDescription
PackagingGroupType: III
PackagingInstructionCode: '1234'
ReportableQuantity: RQ
RegulationSet: CFR
TransportationMode: Ground
CommodityRegulatedLevelCode: LQ
TransportCategory: '0'
TunnelRestrictionCode: Nothing
ChemicalRecordIdentifier: '100'
PackageIdentifier: '123'
- Description: DG
NumOfPieces: '10'
Packaging:
Code: '02'
Description: desc
Dimensions:
UnitOfMeasurement:
Code: IN
Description: IN
Length: '2'
Width: '2'
Height: '2'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: LBS
Weight: '50'
PackageServiceOptions:
DryIce:
RegulationSet: CFR
DryIceWeight:
UnitOfMeasurement:
Code: '01'
Description: LBS
Weight: '50'
PackedByStoreIndicator: " "
PackageIdentifier: '123'
LabelSpecification:
LabelImageFormat:
Code: GIF
'Hazmat Goods':
summary: Shipping Hazmat Goods
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
TransactionReference:
CustomerContext: ''
SubVersion: '1701'
Shipment:
Description: Ship WS test
Shipper:
Name: ShipperName
AttentionName: ShipperZs Attn Name
TaxIdentificationNumber: '123456'
Phone:
Number: '1115554758'
Extension: '1'
ShipperNumber: " "
FaxNumber: '8002222222'
Address:
AddressLine:
- 12380 Morris Road
City: LUTHERVILLE TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: Happy Dog Pet Supply
AttentionName: 1160b_74
Phone:
Number: '9225377171'
Address:
AddressLine:
- 460 Rue du Valibout
City: SMITHFIELD
StateProvinceCode: RI
PostalCode: '02917'
CountryCode: US
ShipFrom:
Name: T and T Designs
AttentionName: 1160b_74
Phone:
Number: '1234567890'
FaxNumber: '1234567890'
Address:
AddressLine:
- 12380 Morris Road
City: LUTHERVILLE TIMONIUM
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: " "
Service:
Code: '03'
Description: UPS Worldwide Saver
Package:
Description: UPS Worldwide Saver
Packaging:
Code: '02'
Dimensions:
UnitOfMeasurement:
Code: IN
Length: '6'
Width: '9'
Height: '7'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Weight: '68'
PackageServiceOptions:
PackageIdentifier: '12380'
HazMat:
PackagingTypeQuantity: '1'
SubRiskClass: " "
TechnicalName: OXYGEN/NITROGEN
ClassDivisionNumber: '2.2'
Quantity: '6'
UOM: kg
PackagingType: Fibreboard Box
IDNumber: UN3480
ProperShippingName: Lithium Ion Batteries
PackagingGroupType: " "
PackagingInstructionCode: Pack
EmergencyPhone: '9253702575'
EmergencyContact: Shipping Dept.
RegulationSet: CFR
TransportationMode: CAO
CommodityRegulatedLevelCode: FR
TransportCategory: xyz
TunnelRestrictionCode: xyz
ChemicalRecordIdentifier: '40'
NumOfPiecesInShipment: '10000'
LabelSpecification:
LabelImageFormat:
Code: GIF
Description: GIF
HTTPUserAgent: Mozilla/4.5
'Billing Third Party':
summary: Billing Third Party
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '1901'
TransactionReference:
CustomerContext: ''
Shipment:
Description: Payments
Shipper:
Name: Shipper_name
AttentionName: Shipper_name
CompanyDisplayableName: Shipper_name
Phone:
Number: '1234567890'
Extension: '1234'
ShipperNumber: " "
FaxNumber: '1234'
EMailAddress: " "
Address:
AddressLine:
- ShipperAddress
- ShipperAddress
- ShipperAddress
City: 01-222 Warszawa
StateProvinceCode: GA
PostalCode: '1222'
CountryCode: PL
ShipTo:
Name: ShipToName
AttentionName: ShipToName
CompanyDisplayableName: ShipToName
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
EMailAddress: " "
Address:
AddressLine:
- ShipToAddress
- ShipToAddress
- ShipToAddress
City: 01-222 Warszawa
StateProvinceCode: GA
PostalCode: '1222'
CountryCode: PL
ShipFrom:
Name: ShipFromName
AttentionName: ShipFromName
CompanyDisplayableName: ShipFromName
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Description: EIN
Phone:
Number: '1234567890'
Extension: '1234'
ShipFromAccountNumber: " "
FaxNumber: '1234'
Address:
AddressLine:
- ShipFromAddress
- ShipFromAddress
- ShipFromAddress
City: 01-222 Warszawa
StateProvinceCode: GA
PostalCode: '1222'
CountryCode: PL
EMailAddress: " "
PaymentInformation:
ShipmentCharge:
Type: '01'
BillThirdParty:
AccountNumber: " "
Name: " "
AttentionName: " "
VatTaxID: 1234AB
TaxIDType: '01'
CertifiedElectronicMail: abc@123.123
InterchangeSystemCode: SDI
SuppressPrintInvoiceIndicator: " "
Address:
PostalCode: '30005'
CountryCode: US
Service:
Code: '011'
Description: Standard
InvoiceLineTotal:
CurrencyCode: USD
MonetaryValue: '10'
NumOfPiecesInShipment: '1'
USPSEndorsement: '5'
CostCenter: '123'
PackageID: '1'
InformationSourceCode: A3
ShipmentServiceOptions: " "
Package:
Description: IF
NumOfPieces: '10'
Packaging:
Code: '02'
Description: desc
Dimensions:
UnitOfMeasurement:
Code: CM
Description: CM
Length: '2'
Width: '2'
Height: '3'
PackageWeight:
UnitOfMeasurement:
Code: KGS
Description: LBS
Weight: '50'
LabelSpecification:
LabelImageFormat:
Code: GIF
Description: GIF
'Multi-Piece Shipping':
summary: Multi-Piece Shipping
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '1701'
TransactionReference:
CustomerContext: ''
Shipment:
Package:
- PackageWeight:
Weight: '50'
UnitOfMeasurement:
Description: desc
Code: LBS
Dimensions:
Height: '2'
Width: '2'
Length: '02'
UnitOfMeasurement:
Description: desc
Code: IN
Packaging:
Description: desc
Code: '02'
Description: desc
- PackageWeight:
Weight: '50'
UnitOfMeasurement:
Description: desc
Code: LBS
Dimensions:
Height: '2'
Width: '2'
Length: '02'
UnitOfMeasurement:
Description: desc
Code: IN
Packaging:
Description: desc
Code: '02'
Description: desc
- Description: desc
Packaging:
Code: '02'
Description: desc
Dimensions:
UnitOfMeasurement:
Code: IN
Description: desc
Length: '02'
Width: '2'
Height: '2'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: desc
Weight: '50'
Description: UPS Premier
Shipper:
Name: ShipperName
AttentionName: GA
CompanyDisplayableName: GA
TaxIdentificationNumber: '12345'
Phone:
Number: '1234567890'
Extension: '12'
ShipperNumber: " "
FaxNumber: '2134'
EMailAddress: " "
Address:
AddressLine:
- address
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipTo:
Name: ship
AttentionName: GA
CompanyDisplayableName: GA
TaxIdentificationNumber: '1234'
Phone:
Number: '1234567890'
Extension: '12'
FaxNumber: '1234'
EMailAddress: " "
Address:
AddressLine:
- AddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ResidentialAddressIndicator: Y
ShipFrom:
Name: ship
AttentionName: GA
CompanyDisplayableName: ShipFrom_CompanyDisplayableName
TaxIdentificationNumber: '5555555555'
Phone:
Number: '1234567890'
Extension: '12'
FaxNumber: '5555555555'
Address:
AddressLine:
- AddressLine
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
EMailAddress: " "
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: " "
Service:
Code: '01'
Description: desc
LabelSpecification:
LabelImageFormat:
Code: ZPL
Description: desc
HTTPUserAgent: Mozilla/4.5
LabelStockSize:
Height: '6'
Width: '4'
'Ship to UPSAccessPoint':
summary: Ship to a UPS Access Point
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
TransactionReference:
CustomerContext: ''
Shipment:
Description: D2R shipments
Shipper:
Name: Shipper Name
AttentionName: Attn. Name
CompanyDisplayableName: Shipper company
TaxIdentificationNumber: '456789'
Phone:
Number: '5555555555'
ShipperNumber: " "
EMailAddress: " "
Address:
AddressLine:
- AddressLine1
City: BOLTON
StateProvinceCode: 'ON'
PostalCode: '20999'
CountryCode: DE
ShipTo:
Name: ShipTo Name
AttentionName: ShipTo Attn. Name
CompanyDisplayableName: ShipTo Company
Phone:
Number: '6787462345'
EMailAddress: " "
Address:
AddressLine:
- Morris Rd
City: Alpharetta
StateProvinceCode: 'ON'
PostalCode: L7E5C1
CountryCode: CA
AlternateDeliveryAddress:
AttentionName: Attn. Name
Name: Alt. Name
UPSAccessPointID: GB00088
Address:
AddressLine:
- Morris RD
City: Alpharetta
StateProvinceCode: 'ON'
PostalCode: '20999'
CountryCode: DE
ShipFrom:
Name: ShipFrom Name
AttentionName: ShipFrom Attn. Name
CompanyDisplayableName: ShipFrom company
Phone:
Number: '6787463456'
ShipFromAccountNumber: " "
Address:
AddressLine:
- Old Alpharetta rd
City: BOLTON
StateProvinceCode: 'ON'
PostalCode: '20999'
CountryCode: DE
EMailAddress: " "
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: " "
Service:
Code: '11'
Description: Express
ShipmentIndicationType:
Code: '01'
Description: D2R shipment
ShipmentServiceOptions:
Notification:
NotificationCode: '012'
EMail:
EMailAddress: " "
VoiceMessage:
PhoneNumber: '5555555555'
TextMessage:
PhoneNumber: '5555555555'
Locale:
Language: ENG
Dialect: US
Package:
Description: D2R shipment
Packaging:
Code: '02'
Description: D2R package
Dimensions:
UnitOfMeasurement:
Code: CM
Description: Centemeters
Length: '5'
Width: '6'
Height: '7'
PackageWeight:
UnitOfMeasurement:
Code: KGS
Description: Kilograms
Weight: '15'
PackageServiceOptions:
DeclaredValue:
Type:
Code: '01'
Description: Declared value
CurrencyCode: EUR
MonetaryValue: '10.30'
LabelSpecification:
LabelImageFormat:
Code: GIF
LabelStockSize:
Height: '6'
Width: '4'
'World Wide Economy':
summary: World Wide Economy Shipping
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '2108'
TransactionReference:
CustomerContext: ''
Shipment:
Description: Worldwide econmoy Parcel
Shipper:
Name: Shipper_name
AttentionName: UPS
CompanyDisplayableName: Shipper_name
Phone:
Number: '1234567890'
Extension: '1234'
ShipperNumber: ''
FaxNumber: '1234'
EMailAddress: ''
Address:
AddressLine:
- 2311 York Rd
- 2311 York Rd
- 2311 York Rd
City: Lutherville Timonium
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
ShipTo:
Name: Happy Dog Pet Supply
AttentionName: ShipToName
CompanyDisplayableName: ShipToName
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
EMailAddress: ''
Address:
AddressLine:
- 12380 Morris Road
- 12380 Morris Road
- 12380 Morris Road
City: STARZACH
StateProvinceCode: GA
PostalCode: '72181'
CountryCode: DE
ShipFrom:
Name: UPS
AttentionName: ShipFromName
CompanyDisplayableName: ShipFromName
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Description: EIN
Phone:
Number: '1234567890'
Extension: '1234'
ShipFromAccountNumber: ''
FaxNumber: '1234'
Address:
AddressLine:
- 2311 York Rd
- 2311 York Rd
- 2311 York Rd
City: Lutherville Timonium
StateProvinceCode: MD
PostalCode: '21093'
CountryCode: US
EMailAddress: ''
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: ''
ShipmentRatingOptions:
NegotiatedRatesIndicator: Y
Service:
Code: '072'
Description: UPS Worldwide Economy DDP
NumOfPiecesInShipment: ''
ShipmentValueThresholdCode: ''
ShipmentServiceOptions:
Notification:
NotificationCode: '6'
EMail:
EMailAddress: ''
UndeliverableEMailAddress: ''
FromEMailAddress: ''
FromName: ''
Memo: '1905'
MasterCartonIndicator: Y
Package:
Description: Worldwide econmoy Postal
NumOfPieces: '10'
Packaging:
Code: '02'
Description: Customer Supplied Package
Dimensions:
UnitOfMeasurement:
Code: IN
Description: IN
Length: '10'
Width: '10'
Height: '10'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: Pounds
Weight: '0.1'
LabelSpecification:
LabelImageFormat:
Code: GIF
Description: GIF
HTTPUserAgent: Mozilla/4.5
'10':
summary: Proactive Response Shipping
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
TransactionReference:
CustomerContext: ''
SubVersion: '1701'
Shipment:
Description: '1701'
Shipper:
Name: Shipper_Name
AttentionName: Shipper_AttentionName
TaxIdentificationNumber: '123456'
Phone:
Number: '1234567890'
ShipperNumber: ''
Address:
AddressLine:
- 12380 Morris Rd
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipTo:
Name: ShipTo_CompanyName
AttentionName: ShipTo_AttentionName
Phone:
Number: '1234567890'
FaxNumber: '1234567890'
TaxIdentificationNumber: '123456'
Address:
AddressLine:
- 793 Foothill Blvd
City: San Luis Obispo
StateProvinceCode: CA
PostalCode: '93405'
CountryCode: US
ShipFrom:
Name: ShipFrom_CompanyName
AttentionName: ShipFrom_AttentionName
Phone:
Number: '1234567890'
FaxNumber: '1234567890'
TaxIdentificationNumber: '123456'
Address:
AddressLine:
- 12380 Morris Rd
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '03'
Description: Ground
Package:
Description: Package Description
Packaging:
Code: '02'
Description: Customer Supplied Package
Dimensions:
UnitOfMeasurement:
Code: IN
Description: Inches
Length: '10'
Width: '10'
Height: '10'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Weight: '1'
PackageServiceOptions:
ProactiveIndicator: X
LabelSpecification:
LabelImageFormat:
Code: GIF
'11':
summary: Shipping with EEI Form
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '1901'
TransactionReference:
CustomerContext: ''
Shipment:
Description: IF
Shipper:
Name: Shipper_name
AttentionName: Shipper_name
CompanyDisplayableName: Shipper_name
Phone:
Number: '1234567890'
Extension: '1234'
ShipperNumber: ''
FaxNumber: '8002222222'
EMailAddress: ''
Address:
AddressLine:
- 2 South Main Street
City: LONDON
StateProvinceCode: GA
PostalCode: TW59NR
CountryCode: GB
ShipTo:
Name: ShipToName
AttentionName: ShipToName
CompanyDisplayableName: ShipToName
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
EMailAddress: ''
Address:
AddressLine:
- 103 Avenue des Champs-Élysées
City: Paris
StateProvinceCode: ''
PostalCode: '75008'
CountryCode: FR
ShipFrom:
Name: ShipFromName
AttentionName: ShipFromName
CompanyDisplayableName: ShipFromName
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Description: IF
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
Address:
AddressLine:
- 2 South Main Street
City: TW59NR
StateProvinceCode: GA
PostalCode: TW59NR
CountryCode: GB
EMailAddress: ''
VendorInfo:
VendorCollectIDTypeCode: '0356'
VendorCollectIDNumber: IMDEU1234567
ConsigneeType: '01'
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '96'
Description: IF
InvoiceLineTotal:
CurrencyCode: USD
MonetaryValue: '10'
NumOfPiecesInShipment: '1'
ShipmentServiceOptions:
InternationalForms:
FormType: '01'
CN22Form:
LabelSize: '6'
PrintsPerPage: '1'
LabelPrintType: pdf
CN22Type: '1'
CN22OtherDescription: test cn22
FoldHereText: fold
CN22Content:
CN22ContentQuantity: '300'
CN22ContentDescription: desc
CN22ContentWeight:
UnitOfMeasurement:
Code: LBS
Description: LBS
Weight: '70'
CN22ContentTotalValue: '2'
CN22ContentCurrencyCode: USD
CN22ContentCountryOfOrigin: US
CN22ContentTariffNumber: '4565655'
FormGroupIdName: Invoice
SEDFilingOption: ''
EEIFilingOption:
Code: '1'
EMailAddress: ''
Description: EEI
UPSFiled:
POA:
Code: '1'
Description: POA
ShipperFiled:
Code: B
Description: ShipperFiled
PreDepartureITNNumber: ''
ExemptionLegend: ''
EEIShipmentReferenceNumber: '1234'
Contacts:
ForwardAgent:
CompanyName: UPS
TaxIdentificationNumber: 94-308351500
Address:
AddressLine:
- AddressLine
City: Alpharetta
StateProvinceCode: GA
Town: Town
PostalCode: '30005'
CountryCode: US
UltimateConsignee:
CompanyName: UPS
Address:
AddressLine:
- Address
City: Alpharetta
StateProvinceCode: GA
Town: TOWN
PostalCode: '30005'
CountryCode: US
UltimateConsigneeType:
Code: D
Description: Direct Consumer
Producer:
Option: ''
CompanyName: ProducerCompanyName
TaxIdentificationNumber: '1234'
Address:
AddressLine:
- Address
City: Marietta
StateProvinceCode: GA
Town: Town
PostalCode: '166222'
CountryCode: CA
AttentionName: Name
Phone:
Number: '1234567890'
Extension: '1234'
EMailAddress: ''
SoldTo:
Name: ACME Designs
AttentionName: ACME Designs
TaxIdentificationNumber: '1234'
Phone:
Number: '1234567890'
Extension: '1234'
Option: '01'
Address:
AddressLine:
- 103 Avenue des Champs-Élysées
City: Paris
StateProvinceCode: ''
PostalCode: '75008'
CountryCode: FR
EMailAddress: ''
Product:
Description: Widgets
Unit:
Number: '1'
UnitOfMeasurement:
Code: KGS
Description: LBS
Value: '1'
CommodityCode: '12345679'
PartNumber: '1234'
OriginCountryCode: US
JointProductionIndicator: ''
NetCostCode: NC
NetCostDateRange:
BeginDate: '20220115'
EndDate: '20220816'
PreferenceCriteria: A
ProducerInfo: 'Yes'
MarksAndNumbers: '1'
NumberOfPackagesPerCommodity: '1'
ProductWeight:
UnitOfMeasurement:
Code: KGS
Description: Description
Weight: '10'
ScheduleB:
Number: '12345'
Quantity: '5'
UnitOfMeasurement:
Code: PCS
Description: PCS
ExportType: D
SEDTotalValue: '123.45'
PackingListInfo:
PackageAssociated:
PackageNumber: '01'
ProductAmount: '147'
EEIInformation:
ExportInformation: OS
License:
Number: 123.16B2
Code: C30
LicenseLineValue: ''
ECCNNumber: EAR99
InvoiceNumber: asdf123
InvoiceDate: '20130410'
PurchaseOrderNumber: 999jjj777
TermsOfShipment: CFR
ReasonForExport: Sale
Comments: Enter in any extra information about the current
shipment.
Discount:
MonetaryValue: '100'
FreightCharges:
MonetaryValue: '75'
InsuranceCharges:
MonetaryValue: '789'
OtherCharges:
MonetaryValue: '10'
Description: '10'
CurrencyCode: USD
BlanketPeriod:
BeginDate: '20130420'
EndDate: '20130430'
ExportDate: '20210406'
ExportingCarrier: A
CarrierID: IATA
InBondCode: '70'
EntryNumber: 1A34567876545360
PointOfOrigin: MS
PointOfOriginType: MS
ModeOfTransport: Rail
PortOfExport: Overland
PortOfUnloading: Germany
LoadingPier: Pier 17 Dock 31
PartiesToTransaction: N
License:
Number: ''
Date: ''
ExceptionCode: ''
ECCNNumber: ''
Package:
Description: IF
Packaging:
Code: '30'
Description: IF
Dimensions:
UnitOfMeasurement:
Code: CM
Description: IF
Length: '50'
Width: '37'
Height: '40'
PackageWeight:
UnitOfMeasurement:
Code: KGS
Description: IF
Weight: '50'
USPSEndorsement: ''
CostCenter: '123'
PackageID: ''
InformationSourceCode: ''
ShipmentValueThresholdCode: '01'
'12':
summary: Shipping with Tax ID
value:
ShipmentRequest:
Request:
RequestOption: nonvalidate
SubVersion: '1901'
TransactionReference:
CustomerContext: ''
Shipment:
Description: IF
Shipper:
Name: Shipper_name
AttentionName: Shipper_name
CompanyDisplayableName: Shipper_name
Phone:
Number: '1234567890'
Extension: '1234'
ShipperNumber: ''
FaxNumber: '8002222222'
EMailAddress: ''
Address:
AddressLine:
- 2 South Main Street
City: LONDON
StateProvinceCode: GA
PostalCode: TW59NR
CountryCode: GB
ShipTo:
Name: ShipToName
AttentionName: ShipToName
CompanyDisplayableName: ShipToName
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
EMailAddress: ''
Address:
AddressLine:
- 2311 York Rd
City: STARZACH
StateProvinceCode: GA
PostalCode: '72181'
CountryCode: DE
ShipFrom:
Name: ShipFromName
AttentionName: ShipFromName
CompanyDisplayableName: ShipFromName
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Description: IF
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
Address:
AddressLine:
- 2 South Main Street
City: TW59NR
StateProvinceCode: GA
PostalCode: TW59NR
CountryCode: GB
EMailAddress: ''
VendorInfo:
VendorCollectIDTypeCode: '0356'
VendorCollectIDNumber: IMDEU1234567
ConsigneeType: '01'
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: ''
Service:
Code: '96'
Description: IF
InvoiceLineTotal:
CurrencyCode: USD
MonetaryValue: '10'
NumOfPiecesInShipment: '1'
ShipmentServiceOptions:
InternationalForms:
FormType: '01'
CN22Form:
LabelSize: '6'
PrintsPerPage: '1'
LabelPrintType: pdf
CN22Type: '1'
CN22OtherDescription: test cn22
FoldHereText: fold
CN22Content:
CN22ContentQuantity: '300'
CN22ContentDescription: desc
CN22ContentWeight:
UnitOfMeasurement:
Code: LBS
Description: LBS
Weight: '70'
CN22ContentTotalValue: '2'
CN22ContentCurrencyCode: USD
CN22ContentCountryOfOrigin: US
CN22ContentTariffNumber: '4565655'
FormGroupIdName: Invoice
SEDFilingOption: ''
EEIFilingOption:
Code: '1'
EMailAddress: ''
Description: EEI
UPSFiled:
POA:
Code: '1'
Description: POA
ShipperFiled:
Code: B
Description: ShipperFiled
PreDepartureITNNumber: ''
ExemptionLegend: ''
EEIShipmentReferenceNumber: '1234'
Contacts:
ForwardAgent:
CompanyName: UPS
TaxIdentificationNumber: '12345'
Address:
AddressLine:
- AddressLine
City: Alpharetta
StateProvinceCode: GA
Town: Town
PostalCode: '30005'
CountryCode: US
UltimateConsignee:
CompanyName: UPS
Address:
AddressLine:
- Address
City: Alpharetta
StateProvinceCode: GA
Town: TOWN
PostalCode: '30005'
CountryCode: US
UltimateConsigneeType:
Code: D
Description: Direct Consumer
Producer:
Option: ''
CompanyName: ProducerCompanyName
TaxIdentificationNumber: '1234'
Address:
AddressLine:
- Address
City: Marietta
StateProvinceCode: GA
Town: Town
PostalCode: '166222'
CountryCode: CA
AttentionName: Name
Phone:
Number: '1234567890'
Extension: '1234'
EMailAddress: ''
SoldTo:
Name: ACME Designs
AttentionName: ACME Designs
TaxIdentificationNumber: '1234'
Phone:
Number: '1234567890'
Extension: '1234'
Option: '01'
Address:
AddressLine:
- Address
City: STARZACH
StateProvinceCode: GA
Town: town
PostalCode: '72181'
CountryCode: DE
EMailAddress: ''
Product:
Description: Description
Unit:
Number: '1'
UnitOfMeasurement:
Code: KGS
Description: LBS
Value: '1'
CommodityCode: '12345679'
PartNumber: '1234'
OriginCountryCode: US
JointProductionIndicator: ''
NetCostCode: NC
NetCostDateRange:
BeginDate: '20110115'
EndDate: '20110816'
PreferenceCriteria: A
ProducerInfo: 'Yes'
MarksAndNumbers: '1'
NumberOfPackagesPerCommodity: '1'
ProductWeight:
UnitOfMeasurement:
Code: KGS
Description: Desc
Weight: '10'
ScheduleB:
Number: '12345'
Quantity: '5'
UnitOfMeasurement:
Code: PCS
Description: PCS
ExportType: D
SEDTotalValue: '123.45'
PackingListInfo:
PackageAssociated:
PackageNumber: '01'
ProductAmount: '147'
EEIInformation:
ExportInformation: OS
License:
Number: 123.16B2
Code: C30
LicenseLineValue: ''
ECCNNumber: EAR99
InvoiceNumber: asdf123
InvoiceDate: '20130410'
PurchaseOrderNumber: 999jjj777
TermsOfShipment: CFR
ReasonForExport: Sale
Comments: Enter in any extra information about the current
shipment.
Discount:
MonetaryValue: '100'
FreightCharges:
MonetaryValue: '75'
InsuranceCharges:
MonetaryValue: '789'
OtherCharges:
MonetaryValue: '10'
Description: '10'
CurrencyCode: USD
BlanketPeriod:
BeginDate: '20130420'
EndDate: '20130430'
ExportDate: '20210406'
ExportingCarrier: A
CarrierID: IATA
InBondCode: '70'
EntryNumber: 1A34567876545360
PointOfOrigin: MS
PointOfOriginType: MS
ModeOfTransport: Rail
PortOfExport: Overland
PortOfUnloading: Germany
LoadingPier: Pier 17 Dock 31
PartiesToTransaction: N
License:
Number: ''
Date: ''
ExceptionCode: ''
ECCNNumber: ''
Package:
Description: IF
Packaging:
Code: '30'
Description: IF
Dimensions:
UnitOfMeasurement:
Code: CM
Description: IF
Length: '50'
Width: '37'
Height: '40'
PackageWeight:
UnitOfMeasurement:
Code: KGS
Description: IF
Weight: '50'
USPSEndorsement: ''
CostCenter: '123'
PackageID: ''
InformationSourceCode: ''
ShipmentValueThresholdCode: '01'
'13':
summary: Shipping with Carbon Offsets
value:
ShipmentRequest:
Shipment:
Description: DG
ShipmentDate: '20231012'
Shipper:
Name: Shipper_name
AttentionName: Shipper_name
CompanyDisplayableName: Shipper_name
Phone:
Number: '1234567890'
Extension: '1234'
ShipperNumber: 3217GG
FaxNumber: '1234'
EMailAddress: test@ups.com
Address:
AddressLine:
- ShipperAddress
- ShipperAddress
- ShipperAddress
City: Alpharetta
StateProvinceCode: GA
PostalCode: '30005'
CountryCode: US
ShipTo:
Name: ShipToName
AttentionName: ShipToName
CompanyDisplayableName: ShipToName
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
EMailAddress: test@ups.com
Address:
AddressLine:
- ShipToAddress
- ShipToAddress
- ShipToAddress
City: carrollton
StateProvinceCode: GA
PostalCode: '30117'
CountryCode: US
ShipFrom:
Name: ShipFromName
AttentionName: ShipFromName
CompanyDisplayableName: ShipFromName
TaxIdentificationNumber: '1234'
TaxIDType:
Code: EIN
Phone:
Number: '1234567890'
Extension: '1234'
FaxNumber: '1234'
Address:
AddressLine:
- ShipFromAddress
- ShipFromAddress
- ShipFromAddress
City: Texas
StateProvinceCode: TX
PostalCode: '77040'
CountryCode: US
PaymentInformation:
ShipmentCharge:
Type: '01'
BillShipper:
AccountNumber: 3217GG
Service:
Code: '01'
Description: Next Day Air
InvoiceLineTotal:
CurrencyCode: USD
MonetaryValue: '10'
NumOfPiecesInShipment: '1'
ShipmentServiceOptions:
UPScarbonneutralIndicator: ''
Package:
Description: DG
NumOfPieces: '10'
Packaging:
Code: '02'
Description: desc
Dimensions:
UnitOfMeasurement:
Code: IN
Description: IN
Length: '2'
Width: '2'
Height: '2'
PackageWeight:
UnitOfMeasurement:
Code: LBS
Description: LBS
Weight: '50'
PackageServiceOptions:
PackedByStoreIndicator: ''
PackageIdentifier: '123'
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/SHIPResponseWrapper"
'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"
"/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}":
delete:
deprecated: true
description: The Void Shipping API is used to cancel the previously scheduled
shipment
summary: Void Shipment
tags:
- Shipping
security:
- OAuth2: []
operationId: Deprecated VoidShipment
parameters:
- in: header
name: transId
schema:
type: string
description: An identifier unique to the request. Length 32
required: false
- in: header
name: transactionSrc
schema:
type: string
default: testing
description: An identifier of the client/source application that is making
the request.Length 512
required: false
- in: query
name: trackingnumber
schema:
type: string
minimum: 1
description: "The package's tracking number. You may have \nup to 20 different
tracking numbers listed.\nIf more than one tracking number, pass this \nvalue
as: trackingnumber= \n[\"1ZISUS010330563105\",\"1ZISUS01033056310\n8\"]
with a coma separating each number.\nAlpha-numeric. Must pass 1Z rules.
Must be \nupper case. Length 18"
required: false
- in: path
name: deprecatedVersion
schema:
type: string
default: v1
description: |
API Version.
Valid values:
- v1
required: true
- in: path
name: shipmentidentificationnumber
schema:
type: string
minimum: 1
description: "The shipment's identification number \nAlpha-numeric. Must pass
1Z rules. Must be \nupper case. Length 18"
required: true
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/VOIDSHIPMENTResponseWrapper"
'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:
SHIPRequestWrapper:
xml:
name: ShipmentRequest
maximum: 1
type: object
required:
- ShipmentRequest
properties:
ShipmentRequest:
"$ref": "#/components/schemas/ShipmentRequest"
SHIPResponseWrapper:
xml:
name: ShipmentResponse
description: 'N/A '
maximum: 1
type: object
required:
- ShipmentResponse
properties:
ShipmentResponse:
"$ref": "#/components/schemas/ShipmentResponse"
ShipmentRequest:
type: object
required:
- Request
- Shipment
properties:
Request:
"$ref": "#/components/schemas/ShipmentRequest_Request"
Shipment:
"$ref": "#/components/schemas/ShipmentRequest_Shipment"
LabelSpecification:
"$ref": "#/components/schemas/ShipmentRequest_LabelSpecification"
ReceiptSpecification:
"$ref": "#/components/schemas/ShipmentRequest_ReceiptSpecification"
xml:
name: ShipmentRequest
description: Shipment Request.
maximum: 1
Address_POE:
properties:
AddressLine:
type: array
description: Address Line
minLength: 1
maxLength: 35
example: 12380 Morris Rd.
maximum: 2
items:
type: string
City:
type: string
description: City
maxLength: 30
example: Alpharetta
StateProvinceCode:
type: string
description: |
The code of the address's admininstrative division (state, province, distict, prefecture, etc...). Required for US, Canada, and Vietnam (VN).
- For US or Canada, the value must be a valid US state or Canadian province code.
- For Vietnam (VN), the value must be a valid province code (for example, VN-44).
- If the country or territory is Ireland, the StateProvinceCode must contain the county.
minLength: 2
maxLength: 5
example: GA
PostalCode:
type: string
description: Postal code
minLength: 5
maxLength: 10
pattern: ^\d{5}(?:[-\s]\d{4})?$
example:
1: 30005
2: 30005-4616
CountryCode:
type: string
description: Country code
minLength: 2
maxLength: 2
pattern: ^[A-Z]{2}$
example: US
required:
- AddressLine
- City
- CountryCode
type: object
Shipment_WorldEase:
description: |
WorldEase is a contract service offering in the UPS shipping that decreases brokerage fees by consolidating
loose packages into one shipment for customs clearance.
properties:
DestinationCountryCode:
type: string
description: The final destination country code.
minLength: 2
maxLength: 2
pattern: ^[A-Z]{2}$
example: FR
DestinationPostalCode:
type: string
description: The final destination postal code.
minLength: 5
maxLength: 10
pattern: ^\d{5}(?:[-\s]\d{4})?$
example:
1: 30005
2: 30005-4616
GCCN:
type: string
description: The Global Consolidation Clearance Number(GCCN) generated for the master shipment. This is required for child shipment.
maxLength: 18
example: 123X56GPFWZ
MasterEUConsolidationIndicator:
type: string
description: 1 indicates a Master Consolidation request for the European Union.
MasterHasDocBox:
type: string
description: This field indicates whether the shipment is a master shipment and specifies the document box type. This is required for Master shipment only.
Valid values
0 - Virtual DocBox
1 - Physical DocBox.
MasterShipmentChgType:
type: string
description: |
Code that indicates how shipping charges will be paid.
| Code | Name | Description: |
| :--: | :-- | :-- |
| CAF | Cost And Freight | Shipper pays to point of import, conignee pays balance. |
| COL | Freight Collect | Consignee (with valid UPS account) pays all shipping charges |
| DDP | Delivered Duty Paid | Shipper pays shipping and duty, consignee pays the Value Added Tax (VAT) |
| FOB | Free On Board | Shipper pays to point to export, consignee pays balance |
| PRE | Prepaid | Shipper pays all shipping charges |
| SDT | Free Domicile | Child Shipper pays for shipping, duities and taxes |
enum: ["CAF","COL","DDP","FOB","PRE","SDT"]
VendorCollectIDNumberExemptIndicator:
type: string
description: This field indicates if VendorCollectIDTypeCode and VendorCollectIDNumber should be exempt from validation. "0" indicates VendorCollectIDTypeCode and VendorCollectIDNumber fields are required.
PortOfEntry:
type: object
description: Container for port of entry details
properties:
Name:
type: string
description: Port of entry name
maxLength: 35
example: Seagirt Terminal, Port of Baltimore
ClearancePortCode:
type: string
description: Port code
example: 56982
Consignee:
type: string
description: Port of entry consignee
maxLength: 35
example: John Doe
Address:
description: Address of the POE. For Master/Child Shipment
"$ref": "#/components/schemas/Address_POE"
required:
- Name
- ClearancePortCode
- Consignee
- Address
required:
- DestinationCountryCode
- MasterShipmentChgType
- PortOfEntry
type: object
ShipmentRequest_Request:
type: object
maximum: 1
required:
- RequestOption
properties:
RequestOption:
description: "Optional Processing. \n\nNote: Full address validation is
not performed. Therefore, it is the responsibility of the Shipping Tool
User to ensure the address entered is correct to avoid an address correction
fee. Valid values:\nnonvalidate = No street level address validation
would be performed, but Postal Code/State combination validation would
still be performed.\n\nvalidate = No street level address validation would
be performed, but City/State/Postal Code/ combination validation would
still be performed."
maximum: 1
type: string
minLength: 1
maxLength: 15
SubVersion:
description: "When UPS introduces new elements in the response that are
not associated with new request elements, Subversion is used. This ensures
backward compatibility.\n\nTo get such elements you need to have the right
Subversion. The value of the subversion is explained in the Response element
Description.\n\nExample: Itemized Charges are returned only when the Subversion
element is present and greater than or equal to 1601. \n\nFormat: YYMM
= Year and month of the release.\n\nExample: 1607 = 2016 July Supported
values: 1601, 1607, 1701, 1707, 1801, 1807, 2108, 2205"
maximum: 1
type: string
minLength: 4
maxLength: 4
TransactionReference:
"$ref": "#/components/schemas/Request_TransactionReference"
xml:
name: Request
description: Request Container
Request_TransactionReference:
type: object
maximum: 1
properties:
CustomerContext:
description: The CustomerContext Information which will be echoed during
response.
maximum: 1
type: string
minLength: 1
maxLength: 512
xml:
name: TransactionReference
description: TransactionReference identifies transactions between client and
server.
ShipmentRequest_Shipment:
type: object
maximum: 1
properties:
Description:
description: "The Description of Goods for the shipment. Applies to international
and domestic shipments. \n\nProvide a detailed description of items being
shipped for documents and non-documents. \n\nExamples: \"annual reports\"
and \"9 mm steel screws\". Required if all of the listed conditions are
true: \nShipFrom and ShipTo countries or territories are not the same;
The packaging type is not UPS Letter; The ShipFrom and or ShipTo countries
or territories are not in the European Union or the ShipFrom and ShipTo
countries or territories are both in the European Union and the shipments
service type is not UPS Standard. \n\nThe Description of Goods field is required
for all UAE shipments, including Import, Export, and Domestic shipments.
This requirement applies to both Document and Non‑Document shipments."
maximum: 1
type: string
minLength: 1
maxLength: 50
ReturnService:
"$ref": "#/components/schemas/Shipment_ReturnService"
DocumentsOnlyIndicator:
description: "Indicates a shipment contains written, typed, or printed communication
of no commercial value. \n\nIf DocumentsOnly is not specified then it
implies that the shipment contains non documents or documents of commercial
value. \n\nDefault is a shipment contains non- documents or documents
of commercial value. This is an empty tag, any value inside is ignored.
\n\nValid only for shipments with different origin and destination countries
or territories. The origin country or territory is not US, and the destination
country or territory is not CA, PR or MX."
maximum: 1
type: string
Shipper:
"$ref": "#/components/schemas/Shipment_Shipper"
ShipTo:
"$ref": "#/components/schemas/Shipment_ShipTo"
AlternateDeliveryAddress:
"$ref": "#/components/schemas/Shipment_AlternateDeliveryAddress"
ShipFrom:
"$ref": "#/components/schemas/Shipment_ShipFrom"
PaymentInformation:
"$ref": "#/components/schemas/Shipment_PaymentInformation"
FRSPaymentInformation:
"$ref": "#/components/schemas/Shipment_FRSPaymentInformation"
GlobalTaxInformation:
$ref: '#/components/schemas/Shipment_GlobalTaxInformation'
WorldEase:
"$ref": "#/components/schemas/Shipment_WorldEase"
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
PromotionalDiscountInformation:
"$ref": "#/components/schemas/Shipment_PromotionalDiscountInformation"
DGSignatoryInfo:
"$ref": "#/components/schemas/Shipment_DGSignatoryInfo"
ShipmentRatingOptions:
"$ref": "#/components/schemas/Shipment_ShipmentRatingOptions"
MovementReferenceNumber:
description: Movement Reference Number (MRN) information. Must contain
alphanumeric characters only. Must be a length of 18 characters. The 3rd
and 4th Characters must be the Shipper country or territory ISO Code.
maximum: 1
type: string
minLength: 18
maxLength: 18
ReferenceNumber:
type: array
items:
"$ref": "#/components/schemas/Shipment_ReferenceNumber"
Service:
"$ref": "#/components/schemas/Shipment_Service"
InvoiceLineTotal:
"$ref": "#/components/schemas/Shipment_InvoiceLineTotal"
ShipmentRiskEnteringEU:
description: "Code that identifies the risk of the Shipment entering the European Union (EU).
\n Values: 01 = AT RISK of Entering the EU
\n 02 = NOT AT RISK of Entering the EU
\n 03 = RISK UNKNOWN of Entering the EU"
maximum: 1
type: string
minLength: 2
maxLength: 2
NumOfPiecesInShipment:
description: Total number of pieces in all pallets in a UPS Worldwide Express
Freight Shipment. It is required for UPS Worldwide Express Freight and
UPS Worldwide Express Freight Midday Shipment. Valid values are 1 to 99999.
maximum: 1
type: string
minLength: 1
maxLength: 5
USPSEndorsement:
description: "USPS Endorsement.\nValid values: \n1 = Return Service Requested
\n2 = Forwarding Service Requested \n3 = Address Service Requested \n4
= Change Service Requested and \n5 = No Service Selected. \nNote: For
International Mail Innovations shipments use No Service Selected. International
Mail Innovations shipments are applicable for Priority Mail Innovations
and Mail Innovations Economy Mail Innovations services only. Required
for Mail Innovations forward shipments."
maximum: 1
type: string
minLength: 1
maxLength: 1
MILabelCN22Indicator:
description: Indicates single label with both MI label and CN22 form. International
CN22 form is required.
maximum: 1
type: string
SubClassification:
description: "A component encoded on the barcode of the Mail Innovations
label. Valid values: \nIR = Irregular\nMA = Machineable\nSubClass is
only required if the customer's contract have them subclass the package
not UPS."
maximum: 1
type: string
minLength: 2
maxLength: 2
CostCenter:
description: |-
Customer assigned identifier for report and billing summarization displays to the right of the Cost Center title. Required for Mail Innovations Return shipments. It is shown on the bottom of the shipping label as reference 2.
Cost Center length is alphanumeric with a max length of 30 for Mail Innovations forward shipments.
Cost Center length is numeric with a max length of 4 for Mail Innovations Return shipments.
maximum: 1
type: string
minLength: 1
maxLength: 30
CostCenterBarcodeIndicator:
description: Presence/Absence indicator. Presence of this indicator means
that the customer is requesting for the CostCenter field to be barcoded
at the bottom of the label.
maximum: 1
type: string
PackageID:
description: Customer-assigned unique piece identifier that returns visibility
events. Required only for Mail Innovations forward shipments. Alpha numeric
values only. It is shown on the bottom of the shipping label as reference
1.
maximum: 1
type: string
minLength: 1
maxLength: 30
PackageIDBarcodeIndicator:
description: Presence/Absence indicator. Presence of this indicator means
that the customer is requesting for the PackageID field to be barcoded
at the bottom of the label.
maximum: 1
type: string
IrregularIndicator:
description: "Mail classification defined by the USPS. Valid values: \n1
= Balloon\n2 = Oversize\n3 = Not Applicable"
maximum: 1
type: string
minLength: 1
maxLength: 1
ShipmentIndicationType:
type: array
items:
"$ref": "#/components/schemas/Shipment_ShipmentIndicationType"
MIDualReturnShipmentKey:
description: "MIDualReturnShipmentKey is unique key required to process
Mail Innovations Dual Return Shipment. \n\nThe unique identifier (key)
would be returned in response of first phase of Mail Innovations Dual
Return Shipments. \n\nThis unique identifier (key) would be part of request
for second phase of Mail Innovations Dual Return Shipments.\n\nFormat:
\nFor Package return shipments, the package tracking number is concatenated
with the system time (YYYY-MM-DDHH.MM.SS.NNN), followed by service code.
\n\nFor MI Return shipments, the Mail Manifest ID (MMI) is concatenated
with the system time. The unique identifier (key) is required to link
the package and the Mail Innovations portion of Dual Return shipment.
\n\nIf unique identifier (key) is empty in the request for UPS Mail Innovations
Return Service, the request will be treated as the first phase of the
Mail Innovations Dual Returns Request. \n\nIf the MIDualReturnShipmentIndicator
is present with empty or null MIDualReturnShipmentKey in UPS Package Return
Shipment, the request will be treated as the first phase of Dual MI Return
Label Shipment. \n\nThis field would be ignored if MIDualReturnShipmentIndicator
is not present in UPS Package Return Shipment request."
maximum: 1
type: string
minLength: 4
maxLength: 50
MIDualReturnShipmentIndicator:
description: "MIDualReturnShipmentIndicator is an indicator to identify
a Package Shipment is part of UPS Mail Innovations Dual Label Shipment.
\n\nIts presence means Package Shipment is part of UPS Mail Innovations
Dual Label shipment. If the indicator is present in Package Shipment
request, shipment would be considered as part of a Dual Mail Innovations
Returns. \n\nThis indicator is not valid with UPS Mail Innovations Returns
Service code."
maximum: 1
type: string
RatingMethodRequestedIndicator:
description: |-
Presence/Absence Indicator. Any value inside is ignored. RatingMethodRequestedIndicator is an indicator.
If present, Billable Weight Calculation method information 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. 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. 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.
maximum: 1
type: string
ShipmentServiceOptions:
"$ref": "#/components/schemas/Shipment_ShipmentServiceOptions"
Locale:
description: "Represents 5 character ISO Locale that allows the user to
request Reference Number Code on Label, Label instructions and Receipt
instructions (if applicable) in desired language. \nLocale is specified
by the combination of language code and country or territory code - 2
character language code and 2 character country or territory code seperated
by an underscore ('_') character. If Locale element is requested along
with LabelLinksIndicator, the URL to retrieve Label and Receipts (if applicable)
will be returned in the requested Locale. Please note only LabelURL and
ReceiptURL (if applicable) will be returned. LocalLanguageLabelURL and
LocalLanguageReceiptURL will not be returned if Locale element is present
in request.\nQueen's English (en_GB) is the default"
maximum: 1
type: string
minLength: 5
maxLength: 5
ShipmentValueThresholdCode:
description: |-
Shipment Value Threshold Code. 01 = Shipment value is below or equals to threshold value
02 = Shipment value is above threshold value. NA = Not Applicable
maximum: 1
type: string
minLength: 2
maxLength: 2
ShipperType:
description: |-
Shipment Value for ShipperType. 01 = Business 02 = Consumer/Individual NA = Not Applicable.
Required for EU Inbound Shipments.
maximum: 1
type: string
minLength: 2
maxLength: 2
ConsigneeType:
description: |-
Shipment Value for ConsigneeType. 01 = Business 02 = Consumer/Individual NA = Not Applicable.
Required for EU Inbound Shipments.
maximum: 1
type: string
minLength: 2
maxLength: 2
MasterCartonID:
description: 'Master Carton ID. If Economy Service (17 or 72) : Economy
Shipment will be associated with given Master Carton ID. If Non-Economy
Service: Master Carton Shipment will be created for given Master Carton
ID.'
maximum: 1
type: string
minLength: 1
maxLength: 24
MasterCartonIndicator:
description: "Master Carton Indicator. Presence of the indicator means Master
Carton ID will be created and returned to client. \nThis is an empty tag,
any value inside is ignored. MasterCartonIndicator
is only valid with Econmoy Shipment (Service Code 17 or 72). Will be ignored
if master carton id present."
maximum: 1
type: string
ShipmentDate:
description: 'User can send up to 7 days in the future with current date
as day zero. Format: YYYYMMDD'
type: string
maximum: 1
maxLength: 8
minLength: 8
Package:
type: array
maximum: 200
items:
"$ref": "#/components/schemas/Shipment_Package"
QuoteID:
description: This field is used to pass the Quote ID generated from the Global Checkout API. This is mandatory to validate your Global Checkout Guaranteed Landed Cost.
maximum: 1
type: string
minLength: 35
maxLength: 35
TradeDirect:
$ref: '#/components/schemas/Shipment_TradeDirect'
HealthcareIdentifier:
description: It is required to Identify the shipment as a Home Healthcare shipment. When present, triggers healthcare eligibility check and enables package-level healthcare processing. Valid value is 001.
maximum: 1
type: string
minLength: 3
maxLength: 3
xml:
name: Shipment
required:
- Shipper
- Service
- ShipTo
- Package
description: Shipment Container
Shipment_ReturnService:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Return Service types:
- 2 = UPS Print and Mail (PNM)
- 3 = UPS Return Service 1-Attempt (RS1)
- 5 = UPS Return Service 3-Attempt (RS3)
- 8 = UPS Electronic Return Label (ERL)
- 9 = UPS Print Return Label (PRL)
- 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
maximum: 1
type: string
minLength: 1
maxLength: 2
Description:
description: Return Service description.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ReturnService
description: Type of Return service. When this container exists, the shipment
is a return shipment.
Shipment_Shipper:
type: object
maximum: 1
required:
- Address
- ShipperNumber
- Name
properties:
Name:
description: "Shippers company name. \n\nFor forward Shipment 35 characters
are accepted, but only 30 characters will be printed on the label."
maximum: 1
type: string
minLength: 1
maxLength: 35
AttentionName:
description: "Shippers Attention Name. \n\nFor forward Shipment 35 characters
are accepted, but only 30 characters will be printed on the label. Required
if destination is international. Required if Invoice and CO International
forms are requested and the ShipFrom address is not present."
maximum: 1
type: string
minLength: 1
maxLength: 35
CompanyDisplayableName:
description: "Shipper's CompanyDisplayableName.\n\nThe CompanyDisplayableName
will be displayed in tracking results and notification messages in place
of the name associated with the shipper account. \nThe original shipper
account name will be displayed for all Return Services and Import Control
Shipments. This is available for Shipper accounts enabled by UPS and
applies to Forward Shipments."
maximum: 1
type: string
minLength: 1
maxLength: 35
TaxIdentificationNumber:
deprecated: true
description: Shipper's Tax Identification Number. Conditionally required
if EEI form (International forms) is requested and ship From is not mentioned.
This element has been deprecated, replacement can be found in the GlobalTaxInformation container.
maximum: 1
type: string
minLength: 1
maxLength: 15
Phone:
"$ref": "#/components/schemas/Shipper_Phone"
ShipperNumber:
description: "Shipper's six digit alphanumeric account number.\n\nMust be
associated with the UserId specified in the AccessRequest XML. \n\nThe
account must be a valid UPS account number that is active. \n\nFor US,
PR and CA accounts, the account must be either a daily pickup account,
an occasional account, or a customer B.I.N account. \n\nDrop Shipper accounts
are valid for return service shipments only if the account is Trade Direct
(TD) enabled. \n\nAll other accounts must be either a daily pickup account
or an occasional account."
maximum: 1
type: string
minLength: 6
maxLength: 6
FaxNumber:
description: Shipper's Fax Number.
maximum: 1
type: string
minLength: 1
maxLength: 14
EMailAddress:
description: Shipper's email address.
maximum: 1
type: string
minLength: 1
maxLength: 50
Address:
"$ref": "#/components/schemas/Shipper_Address"
xml:
name: Shipper
description: Container for the Shipper's information.
Shipper_Phone:
type: object
maximum: 1
required:
- Number
properties:
Number:
description: |
Shipper's phone Number. Valid values are 0 - 9.
If Shipper country or territory is US, PR, CA, and VI, the layout is:
area code, 7 digit PhoneNumber or
area code, 7 digit PhoneNumber, 4 digit extension number.
For other countries or territories, the layout is: country or territory code, area code, 7 digit number.
A phone number is required if destination is international.
maximum: 1
type: string
minLength: 1
maxLength: 15
Extension:
description: Shipper's phone extension.
maximum: 1
type: string
minLength: 1
maxLength: 4
xml:
name: Phone
description: Container tag for Phone Number.
Shipper_Address:
type: object
maximum: 1
required:
- AddressLine
- City
- CountryCode
properties:
AddressLine:
description: |
The Shipper street address including name and number (when applicable). Up to three occurrences are allowed; only the first is printed on the label.
35 characters are accepted, but for the first occurrence, only 30 characters will be printed on the label for return shipments.
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: Shipper's City. For forward Shipment 30 characters are accepted, but only 15 characters will be printed on the label.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: |
Shipper's state or province code.
For forward Shipment 5 characters are accepted, but only 2 characters will be printed on the label. 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.
Required for Vietnam (VN).
- For Vietnam (VN), the value must be a valid province code (for example, VN-44).
- If the country or territory is Ireland, the StateProvinceCode must contain the county.
maximum: 1
type: string
minLength: 1
maxLength: 5
PostalCode:
description: Shipper's postal code.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: |
Shipper's country or territory code.
Refer to country or territory Codes in the Appendix for valid values.
Drop Shipper accounts are valid for return service shipments only if the account is Trade Direct (TD) enabled.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
description: |
Address tag Container. The package should be returned to this address if the package is undeliverable.
This address appears on the upper left hand corner of the label.
Note: If the ShipFrom container is not present then this address will be used as the ShipFrom address. If this address is used as the ShipFrom the shipment will be rated from this origin address.
Shipment_ShipTo:
type: object
maximum: 1
required:
- Address
- Name
properties:
Name:
description: Consignee's company name. All other accounts must be either
a daily pickup account or an occasional account.
maximum: 1
type: string
minLength: 1
maxLength: 35
AttentionName:
description: |
Contact name at the consignee's location. Required for: UPS Next Day Air® Early service, and when ShipTo country or territory is different than ShipFrom country or territory.
Required if Invoice International form is requested.
maximum: 1
type: string
minLength: 1
maxLength: 35
CompanyDisplayableName:
description: Not applicable for ShipTo
maximum: 1
type: string
minLength: 1
maxLength: 35
TaxIdentificationNumber:
deprecated: true
description: Consignee's tax identification number. This element has been deprecated, replacement can be found in the GlobalTaxInformation container.
maximum: 1
type: string
minLength: 1
maxLength: 15
Phone:
"$ref": "#/components/schemas/ShipTo_Phone"
FaxNumber:
description: Consignee's fax number. If ShipTo country or territory is
US 10 digits allowed, otherwise 1-15 digits allowed.
maximum: 1
type: string
minLength: 1
maxLength: 15
EMailAddress:
description: Consignee's email address.
maximum: 1
type: string
minLength: 1
maxLength: 50
Address:
"$ref": "#/components/schemas/ShipTo_Address"
LocationID:
description: Location ID is a unique identifier referring to a specific
shipping/receiving location. Location ID must be alphanumeric characters.
All letters must be capitalized.
maximum: 1
type: string
minLength: 3
maxLength: 10
xml:
name: ShipTo
description: Ship To Container.
ShipTo_Phone:
type: object
maximum: 1
required:
- Number
properties:
Number:
description: |
Consignee's phone Number. Required for: UPS Next Day Air® Early service, and when Ship To country or territory is different than the ShipFrom country or territory.
If ShipTo country or territory is US, PR, CA, and VI, the layout is:
area code, 7 digit PhoneNumber or
area code, 7 digit PhoneNumber, 4 digit extension number; number.
For other countries or territories, the layout is: country or territory code, area code, 7 digit number.
maximum: 1
type: string
minLength: 1
maxLength: 15
Extension:
description: Consignee's phone extension.
maximum: 1
type: string
minLength: 1
maxLength: 4
xml:
name: Phone
description: Container for Phone Number
ShipTo_Address:
type: object
maximum: 1
required:
- AddressLine
- City
- CountryCode
properties:
AddressLine:
description: Address Line of the consignee. All three Address Lines will be printed on the label.
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: Consignee's city. 30 characters are accepted, but only 15 characters
will be printed on the label.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: |
Consignee’s state or province code. Required for US, Canada, and Vietnam (VN).
- For US or Canada, the value must be a valid US state or Canadian province code.
- For Vietnam (VN), the value must be a valid province code (for example, VN-44).
- If the country or territory is Ireland, the StateProvinceCode must contain the county.
maximum: 1
type: string
minLength: 1
maxLength: 5
PostalCode:
description: |
Consignee's postal code. If the ShipTo country or territory is US or Puerto Rico, 5 or 9 digits are required.
If the ShipTo country or territory is CA, then the postal code is required and must be 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit.
Otherwise optional. For all other countries or territories the postal code is optional and must be no more than 9 alphanumeric characters long.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: |
Consignee's country or territory code. Must be a valid UPS Billing country or territory code.
For Return Shipment the country or territory code must meet the following conditions:
- At least two of the following country or territory codes are the same: ShipTo, ShipFrom, and Shipper.
- None of the following country or territory codes are the same and are a member of the EU: ShipTo, ShipFrom, and Shipper.
- If any of the two following country or territory codes: ShipTo/ ShipFrom/ Shipper are members in EU otherwise check if the shipper has Third country or territory Contract.
maximum: 1
type: string
minLength: 2
maxLength: 2
ResidentialAddressIndicator:
description: "This field is a flag to indicate if the receiver is a residential
location. \nTrue if ResidentialAddressIndicator tag exists. This is an
empty tag, any value inside is ignored."
maximum: 1
type: string
POBoxIndicator:
description: This field is a flag to indicate if the receiver address has PO box
indicator. True if POBoxIndicator tag exists; false otherwise.
maximum: 1
type: string
xml:
name: Address
description: Address Container.
Shipment_AlternateDeliveryAddress:
type: object
maximum: 1
required:
- AttentionName
- Address
- Name
properties:
Name:
description: Retail Location Name.
maximum: 1
type: string
minLength: 1
maxLength: 35
AttentionName:
description: Attention Name.
maximum: 1
type: string
minLength: 1
maxLength: 35
UPSAccessPointID:
description: UPS Access Point ID.
maximum: 1
type: string
minLength: 9
maxLength: 9
Address:
"$ref": "#/components/schemas/AlternateDeliveryAddress_Address"
xml:
name: AlternateDeliveryAddress
description: AlternateDeliveryAddress Container. Alternate Delivery Address
(UPS Access Point Address) required if ShipmentIndicationType is 01 or 02.
AlternateDeliveryAddress_Address:
type: object
maximum: 1
required:
- AddressLine
- City
- CountryCode
properties:
AddressLine:
description: Address Line of the Retail Location.
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: Retail Location City.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: |
Retail Location state or province code. Required for US, Canada, and Vietnam (VN).
- For US or Canada, the value must be a valid US state or Canadian province code.
- For Vietnam (VN), the value must be a valid province code (for example, VN-44).
- If the country or territory is Ireland, the StateProvinceCode must contain the county.
maximum: 1
type: string
minLength: 1
maxLength: 5
PostalCode:
description: 'If the Alternate Delivery Address country or territory is
US or Puerto Rico, 5 or 9 digits are required. The character - may be
used to separate the first five digits and the last four digits. If the
Alternate Delivery Address country or territory is CA, then the postal
code is required and must be 6 alphanumeric characters whose format is
A#A#A# where A is an uppercase letter and # is a digit. Otherwise optional.
For all other countries or territories the postal code is optional and
must be no more than 9 alphanumeric characters long.'
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: Retail Location country or territory code.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
description: Address Container.
Shipment_ShipFrom:
type: object
maximum: 1
required:
- Address
- Name
properties:
Name:
description: "The ship from location's name or company name. \n35 characters
are accepted, but for return Shipment only 30 characters will be printed
on the label. Required if ShipFrom tag is in the XML."
maximum: 1
type: string
minLength: 1
maxLength: 35
AttentionName:
description: "The ship from Attention name. \n35 characters are accepted,
but for return Shipment only 30 characters will be printed on the label.
\ Required if ShipFrom tag is in the XML and Invoice or CO International
forms is requested. If not present, will default to the Shipper Attention
Name."
maximum: 1
type: string
minLength: 1
maxLength: 35
CompanyDisplayableName:
description: Not applicable for ShipFrom.
maximum: 1
type: string
minLength: 1
maxLength: 35
TaxIdentificationNumber:
deprecated: true
description: "Company's Tax Identification Number at the pick up location.
\ Conditionally required if EEI form (International forms) is requested.
\nApplies to EEI Form only. This element has been deprecated, replacement can be found in the GlobalTaxInformation container."
maximum: 1
type: string
minLength: 1
maxLength: 15
TaxIDType:
"$ref": "#/components/schemas/ShipFrom_TaxIDType"
Phone:
"$ref": "#/components/schemas/ShipFrom_Phone"
FaxNumber:
description: The Ship from fax number. If Ship from country or territory
is US 10 digits allowed, otherwise 1-15 digits allowed.
maximum: 1
type: string
minLength: 1
maxLength: 15
Address:
"$ref": "#/components/schemas/ShipFrom_Address"
VendorInfo:
"$ref": "#/components/schemas/ShipFrom_VendorInfo"
xml:
name: ShipFrom
description: "Ship From Container. Required for return shipment. \n\nRequired
if pickup location is different from the shipper's address. \n\nRequired for Trade Direct shipment."
ShipFrom_TaxIDType:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: "Company's tax Identification type. Valid values: EIN, DNS,
and FGN. \nApplies to EEI form only."
type: string
Description:
description: Description of TaxID submitted. Applies to EEI form only.
type: string
xml:
name: TaxIDType
description: Tax Identification Container. Applies to EEI form only.
TaxIDType_Code:
description: "Company's tax Identification type. Valid values: EIN, DNS, and
FGN. \nApplies to EEI form only."
maximum: 1
type: string
minLength: 6
maxLength: 6
TaxIDType_Description:
description: Description of TaxID submitted. Applies to EEI form only.
maximum: 1
type: string
minLength: 1
maxLength: 35
ShipFrom_Phone:
type: object
maximum: 1
required:
- Number
properties:
Number:
description: The Ship from phone Number.
maximum: 1
type: string
minLength: 1
maxLength: 15
Extension:
description: The Ship from phone extension.
maximum: 1
type: string
minLength: 1
maxLength: 4
xml:
name: Phone
description: "Container for Phone Number. If ShipFrom country or territory
is US, PR, CA, and VI, the layout is:\narea code, 7 digit phone number or
\narea code, 7 digit phone number, 4 digit extension number.\n\nFor other
countries or territories, the layout is:\ncountry or territory code, area
code, 7 digit number. \n\n If ShipFrom tag is in the XML and International
forms is requested."
ShipFrom_Address:
type: object
maximum: 1
required:
- AddressLine
- City
- CountryCode
properties:
AddressLine:
description: The Ship from street address including name and number (when
applicable). 35 characters are accepted, but for return Shipment only
30 characters will be printed on the label.
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: |
The Ship from city.
30 characters are accepted, but for return Shipment only 15 characters will be printed on the label. Required if ShipFrom is supplied
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: |
Origin location's state or province code. Required if ShipFrom is supplied, and ShipFrom country or territory is US.
Required for Canada, and Vietnam (VN).
- For US or Canada, the value must be a valid US state or Canadian province code.
- For Vietnam (VN), the value must be a valid province code (for example, VN-44).
- If the country or territory is Ireland, the StateProvinceCode must contain the county.
maximum: 1
type: string
minLength: 1
maxLength: 5
PostalCode:
description: |
The ship from locations postal code.
9 characters are accepted. Required if ShipFrom is supplied and the ShipFrom country or territory is the US and Puerto Rico.
For US and Puerto Rico, it must be valid 5 or 9 digit postal code. The character "-" may be used to separate the first five digits and the last four digits.
If the ShipFrom country or territory is CA, then the postal code must be 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit.
For all other countries or territories the postal code is optional and must be no more than 9 alphanumeric characters long.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: |
Origin locations country or territory code. Required if ShipFrom tag is supplied. For Return Shipment the country or territory code must meet the following conditions:
- At least two of the following country or territory codes are the same: ShipTo, ShipFrom, and Shipper.
- None of the following country or territory codes are the same and are a member of the EU: ShipTo, ShipFrom, and Shipper.
- If any of the two following country or territory codes: ShipTo/ShipFrom/ Shipper are members in EU otherwise check if the shipper has Third country or territory Contract.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
description: Ship from Address Container. The package will be originating from
or being shipped from this address. The shipment will be rated from this origin
address to the destination ship to address.
ShipFrom_VendorInfo:
type: object
maximum: 1
required:
- VendorCollectIDTypeCode
- VendorCollectIDNumber
properties:
VendorCollectIDTypeCode:
description: |
Code that identifies the type of Vendor Collect ID Number. Valid Values
- 0000 = Unknown/Other
- 0356 = IOSS Registration Number
- 0357 = VOEC Registration Number
- 0358 = Deprecated
- 0359 = PVA Registration Number
- 1051 = Singapore GST Registration Number
- 1052 = ARN Registration Number
- 1053 = IRD Registration Number
- 1054 = Malaysia Low Value Goods Sales Tax Registration Number
Vendor Collect ID Number type code will be printed on commercial invoice if present.
maximum: 1
type: string
minLength: 1
maxLength: 4
VendorCollectIDNumber:
description: |
Shipper's VAT Tax collection registration number to be entered by Shipper at time of shipment creation. Presence of this number as part of the shipment information implies the shipper has collected/paid the required VAT tax (outside of UPS/UPS systems). Vendor Colect ID Number will be printed on commercial invoice if present.
Sample Values: 'IMDEU1234567' (IOSS #), 'VOEC1234567' (VOEC #), 'GB1234567' (HMRC #)
Required if the shipment is subject to Vendor Collect ID collection
maximum: 1
type: string
minLength: 1
maxLength: 35
ConsigneeType:
description: Consignee Type. 01 = Business 02 = Consumer NA = Not Applicable
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: VendorInfo
description: Vendor Information Container
Shipment_PaymentInformation:
type: object
required:
- ShipmentCharge
properties:
ShipmentCharge:
type: array
maximum: 3
items:
"$ref": "#/components/schemas/PaymentInformation_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. This is an empty tag,
any value inside is ignored. 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: PaymentInformation
maximum: 1
description: Payment information container for detailed shipment charges. The
two shipment charges that are available for specification are Transportation
charges and Duties and Taxes. It is required for non-Ground Freight Pricing
shipments only.
PaymentInformation_ShipmentCharge:
type: object
required:
- Type
properties:
Type:
description: "Valid values: \n01 = Transportation\n02 = Duties and Taxes
03 = Broker of Choice A shipment charge type of 01 = Transportation is
required. \n\nA shipment charge type of 02 = Duties and Taxes is not required;
however, this charge type is invalid for Qualified Domestic Shipments.
\n\nA Qualified Domestic Shipment is any shipment in which one of the
following applies: \n\n1) The origin and destination country or territory
is the same.\n\n2) US to PR shipment.\n\n3) PR to US shipment.\n\n4) The
origin and destination country or territory are both European Union countries
or territories and the GoodsNotInFreeCirculation indicator is not present.\n\n5)
The origin and destination IATA code is the same. 03
= Broker of Choice"
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. This is an empty tag, any value inside is ignored. 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.
This payment method allows you to bill the charges for a specified shipment to a consignee who has agreed to pay the charges. All shipping charges are billed to the consignees UPS account number including the following accessorials: Additional Handling, Delivery Area Surcharges, Delivery Change Requests, Early AM Premium, Early AM Out of Territory, Fuel Surcharge, Hazardous Material Surcharges, Large Package Surcharge, Over Max Limits, and Saturday Delivery.
Declared Value, Delivery Confirmation, On Call Pickup, Remote Area Surcharge, Saturday Pickup of Delivery fees are not passed to the consignee. These charges are billed to the shippers UPS account number.
maximum: 1
type: string
xml:
name: ShipmentCharge
maximum: 1
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
properties:
AccountNumber:
description: "UPS account number. Must be the same UPS account number as
the one provided in Shipper/ShipperNumber. \n\nEither this element or
one of the sibling elements CreditCard or AlternatePaymentMethod must
be provided, but all of them may not be provided."
maximum: 1
type: string
minLength: 6
maxLength: 6
CreditCard:
"$ref": "#/components/schemas/BillShipper_CreditCard"
AlternatePaymentMethod:
description: "Alternate Payment Method.\n\nValid value: 01= PayPal\n\nOnly
valid for forward shipments. It is not valid for Return or Import Control
shipments. \n\nThis element or one of the sibling elements CreditCard
or AccountNumber must be provided, but all of them may not be provided.
\ PayPal 01: Is only valid for forward shipments. It is not valid for
Return or Import Control shipments. \n\nThis element or one of the sibling
elements CreditCard or AccountNumber must be provided, but all of them
may not be provided."
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: BillShipper
description: Container for the BillShipper billing option. The three payment
methods that are available for the Bill Shipper billing option are alternate
payment method, account number or credit card. This element or its sibling
element, BillReceiver, BillThirdParty or ConsigneeBilledIndicator, must be
present but no more than one can be present.
BillShipper_CreditCard:
type: object
maximum: 1
required:
- Type
- Number
- ExpirationDate
- SecurityCode
properties:
Type:
description: |-
Valid values:
- 01 = American Express
- 03 = Discover
- 04 = MasterCard
- 05 = Optima
- 06 = VISA
- 07 = Bravo
- 08 = Diners Club
- 13 = Dankort
- 14 = Hipercard
- 15 = JCB
- 17 = Postepay
- 18 = UnionPay/ExpressPay
- 19 = Visa Electron
- 20 = VPAY
- 21 = Carte Bleue
maximum: 1
type: string
minLength: 2
maxLength: 2
Number:
description: Credit Card number.
maximum: 1
type: string
minLength: 9
maxLength: 16
ExpirationDate:
description: Format is MMYYYY where MM is the 2 digit month and YYYY is the 4 digit year. Valid month values are 01-12 and valid year values are Present Year - (Present Year + 10 years)
maximum: 1
type: string
minLength: 6
maxLength: 6
SecurityCode:
description: Three or four digits that can be found either on top of credit
card number or on the back of credit card. Number of digits varies for
different type of credit card. Valid values are 3 or 4 digits. It is
required to provide the security code if credit card information is provided
and when the ShipFrom countries or territories are other than the below
mentioned countries or territories. Argentina, Bahamas, Costa Rica, Dominican
Republic, Guatemala, Panama, Puerto Rico and Russia.
maximum: 1
type: string
minLength: 3
maxLength: 4
Address:
"$ref": "#/components/schemas/CreditCard_Address"
xml:
name: CreditCard
description: "Credit card information container. Required if neither of the
following is present: \n\n/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/AccountNumber
\nor \n/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/AlternatePaymentMethod.
\n\nCredit card payment is valid for shipments without return service only."
CreditCard_Address:
type: object
maximum: 1
required:
- AddressLine
- City
- CountryCode
properties:
AddressLine:
description: Address Line 1 of the credit card billing address. Usually Street address information.
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: City of the credit card billing address.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: |
State or province code of the credit card billing address. Required for US, Canada, and Vietnam (VN).
- For US or Canada, the value must be a valid US state or Canadian province code.
- For Vietnam (VN), the value must be a valid province code (for example, VN-44).
- If the country or territory is Ireland, the StateProvinceCode must contain the county.
maximum: 1
type: string
minLength: 1
maxLength: 5
PostalCode:
description: Credit card billing addressee postal code.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: Credit card billing address country or territory code. Must be a valid UPS Billing country or territory code.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
description: Container to hold the Credit card Billing Address. It is required
to provide billing address if credit card information is provided and when
the ShipFrom country or territory is the US, PR, and CA.
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. \n\nFor 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. \n\nAll 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 accounts pickup address. The pickup postal code was entered in the UPS system when the account was set-up. The postal code must be the same as the UPS Bill Receiver account number 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 accounts 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 accounts 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
xml:
name: Address
description: Container for additional information for the bill receiver's UPS
accounts address.
ShipmentCharge_BillThirdParty:
type: object
maximum: 1
properties:
AccountNumber:
description: "The UPS account number of the third party shipper. The account
must be a valid UPS account number that is active. \n\nFor 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. \n\nAll
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
CertifiedElectronicMail:
description: Posta Elettronica Certificata (PEC) which is the recipient
code for the customers certified electronic mail value.
maximum: 1
type: string
minLength: 1
maxLength: 30
InterchangeSystemCode:
description: Sistema Di Interscambio(SDI) which is the recipient code for
the customer's interchange value or Interchange System Code
maximum: 1
type: string
minLength: 1
maxLength: 15
Address:
"$ref": "#/components/schemas/BillThirdParty_Address"
xml:
name: BillThirdParty
required:
- Address
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:
PostalCode:
description: |
The postal code for the UPS accounts pickup address. The pickup postal code is the one that was entered in the UPS system when the account was set-up. The postal code must be the same as the UPS Bill Third Party account number 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 accounts 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 accounts 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: The country or territory code for the UPS accounts pickup address.
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
maximum: 1
required:
- Type
- AccountNumber
properties:
Type:
"$ref": "#/components/schemas/FRSPaymentInformation_Type"
AccountNumber:
description: The UPS account number. If the Ground Freight Pricing indicator
and FreightShipmentInformation/DensityEligibleIndicator is present in
the request, this account number must be validated to check if it is Ground
Freight Pricing Density Based Rating enabled.
maximum: 1
type: string
minLength: 6
maxLength: 6
Address:
"$ref": "#/components/schemas/FRSPaymentInformation_Address"
xml:
name: FRSPaymentInformation
description: Container to hold the Payment information for the Ground Freight
Pricing Shipments. Required for Ground Freight Pricing Shipments only.
FRSPaymentInformation_Type:
type: object
maximum: 1
properties:
Code:
description: |
Valid codes:
- 01 = Prepaid
- 02 = FreightCollect
- 03 = ThirdParty
maximum: 1
type: string
minLength: 1
maxLength: 2
Description:
description: Specifies the description for Ground Freight Pricing payment type.
maximum: 1
type: string
minLength: 1
maxLength: 50
required:
- Code
description: Container to hold the Ground Freight Pricing payment type information. It is required if the request has Ground Freight Pricing shipment indicator.
FRSPaymentInformation_Address:
type: object
maximum: 1
properties:
PostalCode:
description: The postal code for the Ground Freight Pricing payment information
address.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: The country or territory code for the Ground Freight Pricing
payment information address.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
required:
- CountryCode
description: 'Container to hold the information for the FreightCollect and PrepaidThirdParty
Address. Note: The Address is required only when the billing option is Freight
collect or ThirdParty.'
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.
type: string
maximum: 1
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 indicates that
allow the 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
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.
maximum: 1
type: string
minLength: 1
maxLength: 19
UnitOfMeasurement:
"$ref": "#/components/schemas/AdjustedHeight_UnitOfMeasurement"
xml:
name: AdjustedHeight
description: Container for the adjusted height. Required if AdjustedHeightIndicator
is present.
AdjustedHeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Code associated with Unit of Measurement for the Adjusted height.
Valid value: 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: 2
maxLength: 2
Description:
description: Description for UnitOfMeasurement for the adjusted height.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: UnitOfMeasurement
description: Container for UnitOfMeasurement for the adjusted height.
FreightDensityInfo_HandlingUnits:
type: object
maximum: 1
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: |
Handling Unit Code for Density based rating. Valid values:
- SKD = Skid
- CBY = Carboy
- PLT = Pallet
- TOT = Totes
- LOO = Loose
- OTH = 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:
- Code
properties:
Code:
description: Code for UnitOfMeasurement for the line item dimension. Valid value is IN
maximum: 1
type: string
minLength: 2
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.
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_DGSignatoryInfo:
type: object
maximum: 1
properties:
Name:
description: "Name of the person signing the declaration. \n\nNote: The
name of person or department he/she is employed with, are both acceptable."
maximum: 1
type: string
minLength: 35
maxLength: 35
Title:
description: |-
Title of the person signing the declaration.
Note: The title of the person or department he/she is employed with, are both acceptable.
maximum: 1
type: string
minLength: 35
maxLength: 35
Place:
description: The city of the Signatory.
maximum: 1
type: string
minLength: 35
maxLength: 35
Date:
description: Date of signing the declaration form. Valid format is YYYYMMDD.
maximum: 1
type: string
minLength: 8
maxLength: 8
ShipperDeclaration:
description: "Valid values:\n01 = Shipment level\n02 = Package level \n
\ Valid only for the Shipper Declaration paper. If missing or invalid
DGPaperImage will be returned at package level."
maximum: 1
type: string
minLength: 2
maxLength: 2
UploadOnlyIndicator:
description: Dangerous Goods Paper Upload Only Indicator. DG Paper will
not be returned in response if UploadOnlyIndicator present.
maximum: 1
type: string
xml:
name: DGSignatoryInfo
description: DGSignatoryInfo Container DGPaperImage will be returned if DGSignatoryInfo
container present
Shipment_ShipmentRatingOptions:
type: object
maximum: 1
properties:
NegotiatedRatesIndicator:
description: "Negotiated Rates option indicator. If the indicator is present
and the Shipper is authorized then Negotiated Rates should be returned
in the response. Negotiated Rates are of two types Account Based Rates
(ABR) and Web Discount Rates. Negotiated Rates are only returned for qualified
Shipper Account Numbers. \n\nEligibility is determined using the combination
of UserId and the Shipper's Shipper Account Number. If the user is qualified,
both Published rates and Negotiated rates are returned to the user. If
the UserId and Shipper Account \n\nNumber are not qualified for Negotiated
rates, a warning message is returned that indicates ineligibility and
only the Published rates are returned in the response. As per discount
eligibility of user, negotiated rates in the response may contain ABR
or Web discount rates."
maximum: 1
type: string
FRSShipmentIndicator:
description: Ground Freight Pricing Rates option indicator. If the Ground
Freight Pricing Shipment indicator is enabled and Shipper number is authorized
then Ground Freight Pricing rates should be returned in the response. The
Shipper account number must be qualified to receive Ground Freight Pricing
Density Based Shipment rates. Only the Shipper account number taken from
/ShipmentRequest/Shipment/FRSPaymentInformation/AccountNumber is used
when checking qualification for Ground Freight Pricing Density Based rates.
maximum: 1
type: string
RateChartIndicator:
description: RateChartIndicator, if present in request, response will contain
RateChart element.
maximum: 1
type: string
TPFCNegotiatedRatesIndicator:
description: "This indicator applies for a third party (3P) / Freight collect
(FC) shipment only. \n\nFor 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. \n\nIf authorized the 3P/FC negotiated rates
will be applied to the shipment and rates will be returned in response."
maximum: 1
type: string
UserLevelDiscountIndicator:
description: |-
If this indicator is present user level discount will be applied to rates if applicable Conditions checked:
This indicator should be present
Shipper number should not be present
User should be eligible for user level discount
maximum: 1
type: string
xml:
name: ShipmentRatingOptions
description: ShipmentRatingOptions container.
Shipment_ReferenceNumber:
type: object
maximum: 1
properties:
BarCodeIndicator:
description: If the indicator is present then the reference number's value will be bar coded on the label. This is an empty tag, any value inside is ignored. Only one shipment-level or package-level reference number can be bar coded per shipment. In order to barcode a reference number, its value must be no longer than 14 alphanumeric characters or 24 numeric characters and cannot contain spaces.
maximum: 1
type: string
Code:
description: Shipment Reference number type code. The code specifies the Reference name. Refer to the Reference Number Code table. Valid if the origin/destination pair is not US/US or PR/PR and character should be alpha-numeric.
maximum: 1
type: string
minLength: 2
maxLength: 2
Value:
description: Customer supplied reference number. Valid if the origin/destination pair is not US/US or PR/PR
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ReferenceNumber
required:
- Value
description: Reference Number information container. Required for Trade Direct shipments.
Shipment_Service:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Valid values:
- 01 = Next Day Air
- 02 = 2nd Day Air
- 03 = Ground
- 07 = Express
- 08 = Expedited
- 11 = UPS Standard
- 12 = 3 Day Select
- 13 = Next Day Air Saver
- 14 = UPS Next Day Air® Early
- 17 = UPS Worldwide Economy DDU
- 54 = Express Plus
- 59 = 2nd Day Air A.M.
- 65 = UPS Saver
- M2 = First Class Mail
- M3 = Priority Mail
- M4 = Expedited MaiI Innovations
- M5 = Priority Mail Innovations
- M6 = Economy Mail Innovations
- M7 = MaiI Innovations (MI) Returns
- 70 = UPS Access Point™ Economy
- 71 = UPS Worldwide Express Freight Midday
- 72 = UPS Worldwide Economy DDP
- 74 = UPS Express®12:00
- 75 = UPS Heavy Goods
- 82 = UPS Today Standard
- 83 = UPS Today Dedicated Courier
- 84 = UPS Today Intercity
- 85 = UPS Today Express
- 86 = UPS Today Express Saver
- 96 = UPS Worldwide Express Freight.
- C6 = Roadie XD AM (Morning delivery)
- C7 = Roadie XD PM (Afternoon delivery)
- C8 = Roadie XD (Anytime delivery)
- T0 = Master
- T1 = LTL
Note: Only service code 03 is used for Ground Freight Pricing shipments The following Services are not available to return shipment: 13, 59, 82, 83, 84, 85, 86, C6, C7, C8
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: Description of the service code. Examples are Next Day Air,
Worldwide Express, and Ground.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: Service
description: UPS service type.
Shipment_InvoiceLineTotal:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Invoice Line Total currency type.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Invoice Line Total amount for the entire shipment. Valid values are from 1 to 99999999
maximum: 1
type: string
minLength: 1
maxLength: 11
xml:
name: InvoiceLineTotal
description: Container to hold InvoiceLineTotal Information. Required for forward
shipments whose origin is the US and destination is Puerto Rico or Canada.
Not available for any other shipments. FOR OTHER DESTINATIONS the InvoiceLineTotal
in the International Forms Container must be used.
Shipment_ShipmentIndicationType:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Valid values:
- '01' - Hold for Pickup at UPS Access Point aka Direct to Retail (D2R)
- '02' - UPS Access Point™ Delivery aka Retail to Retail (R2R) If '01' code is present indicates shipment will be send to Retail location where it is held to consignee to claim.
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: Description for the code.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: ShipmentIndicationType
description: "Container for Shipment Indication Type. Required to indicate whether shipment is \"Hold For Pickup At UPS Access Point\" for use by approved shippers to identify a UPS Access Point location as an alternate delivery option during shipment preparation or \"UPS Access Point™ Delivery\", ship parcels directly to a UPS Access Point location for collection by the receiver."
Shipment_ShipmentServiceOptions:
type: object
maximum: 1
properties:
SaturdayDeliveryIndicator:
description: Saturday delivery indicator. The presence indicates Saturday
delivery is requested and the absence indicates Saturday delivery is not
requested. This is an empty tag, any value inside is ignored.
maximum: 1
type: string
SaturdayPickupIndicator:
description: Saturday pickup indicator. The presence indicates Saturday
pickup is requested and the absence indicates Saturday pickup is not requested. This
is an empty tag, any value inside is ignored.
maximum: 1
type: string
COD:
"$ref": "#/components/schemas/ShipmentServiceOptions_COD"
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 Type \"01 - Hold For Pickup At UPS Access Point\" and \"02 - UPS Access Point™ Delivery\"."
maximum: 1
type: string
Notification:
type: array
maximum: 3
items:
"$ref": "#/components/schemas/ShipmentServiceOptions_Notification"
LabelDelivery:
"$ref": "#/components/schemas/ShipmentServiceOptions_LabelDelivery"
InternationalForms:
"$ref": "#/components/schemas/ShipmentServiceOptions_InternationalForms"
DeliveryConfirmation:
"$ref": "#/components/schemas/ShipmentServiceOptions_DeliveryConfirmation"
ReturnOfDocumentIndicator:
description: The flag indicates the ReturnOfDocument accessorial has been
requested. Valid for Poland to Poland forward shipment only.
maximum: 1
type: string
ImportControlIndicator:
description: Indicates that the Shipment is an ImportControl shipment.
maximum: 1
type: string
LabelMethod:
"$ref": "#/components/schemas/ShipmentServiceOptions_LabelMethod"
CommercialInvoiceRemovalIndicator:
description: CommercialInvoiceRemovalIndicator allows a shipper to dictate
UPS to remove the Commercial Invoice from the user's shipment before the
shipment is delivered to the ultimate consignee.
maximum: 1
type: string
UPScarbonneutralIndicator:
description: UPS carbon offsets indicator presence at shipment level is
required to create carbon offsets Shipments.
maximum: 1
type: string
PreAlertNotification:
type: array
items:
"$ref": "#/components/schemas/ShipmentServiceOptions_PreAlertNotification"
ExchangeForwardIndicator:
description: Exchange forward indicator presence at shipment level is required
to create exchange forward Shipments. In the label routing Instruction
text will be defaulted to "EXCHANGE-LIKE ITEM ONLY".
maximum: 1
type: string
HoldForPickupIndicator:
description: Hold For Pickup indicator. The empty tag means indicator is
present. This accessorial is only valid for UPS Worldwide Express Freight
and UPS Worldwide Express Freight Midday Shipment.
maximum: 1
type: string
DropoffAtUPSFacilityIndicator:
description: Drop off At UPS Facility indicator. The empty tag means indicator
is present. This accessorial is only valid for UPS Worldwide Express
Freight and UPS Worldwide Express Freight Midday Shipment.
maximum: 1
type: string
LiftGateForPickUpIndicator:
description: "Lift Gate For Pick Up indicator. The empty tag means indicator
is present. Lift Gate for Pickup is not allowed with Drop Off At UPS
Facility for a UPS Worldwide Express Freight and UPS Worldwide Express
Freight Midday shipment. \n\nWhen both Hold for Pickup and Drop Off At
Facility are selected, neither of the Lift Gate accessorial (Pick Up or
Delivery) are allowed for a UPS Worldwide Express Freight and UPS Worldwide
Express Freight Midday shipment. \n\nThis accessorial is only valid for
UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday
Shipment."
maximum: 1
type: string
LiftGateForDeliveryIndicator:
description: "Lift Gate For Delivery indicator. The empty tag means indicator
is present. Lift Gate for Delivery is not allowed with Hold For Pickup
for a UPS Worldwide Express Freight and UPS Worldwide Express Freight
Midday shipment. \n\nWhen both Hold for Pickup and Drop Off At UPS Facility
are selected, neither of the Lift Gate accessorial (Pick Up or Delivery)
are allowed for a UPS Worldwide Express Freight and UPS Worldwide Express
Freight Midday shipment. \n\nThis accessorial is only valid for UPS Worldwide
Express Freight and UPS Worldwide Express Freight Midday Shipment."
maximum: 1
type: string
SDLShipmentIndicator:
description: The presence of the tag SDLShipmentIndicator indicates Shipment
is SDL. SDLShipmentIndicator presence means EEI form/ EEI Filing option
required.
maximum: 1
type: string
EPRAReleaseCode:
description: "Package Release code allows the consignee or claimant to pick-up a package at a UPS Access Point™. The shipper must provide the Package Release Code to the consignee so that they can provide the code to the UPS Access Point personnel as another item for authentication before the package is released to them. Package Release Code is only valid with ShipmentIndicationType 01 - Hold for Pickup at UPS Access Point™. The release code must be between length 4 and 6 and only contain numbers."
maximum: 1
type: string
minLength: 4
maxLength: 6
RestrictedArticles:
"$ref": "#/components/schemas/ShipmentServiceOptions_RestrictedArticles"
InsideDelivery:
description: |-
Inside delivery accessory. Valid values:
01 - White Glove,
02 - Room of Choice,
03 - Installation,
04 - Over Threshold Fee.
Default is Room of Choice. Shippers account needs to have a valid contract for Heavy Goods Service.
maximum: 1
type: string
minLength: 2
maxLength: 2
ItemDisposal:
description: Presence/Absence indicator. True if present; false otherwise.
Any value 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
VerifiedDelivery:
"$ref": "#/components/schemas/ShipmentServiceOptions_VerifiedDelivery"
xml:
name: ShipmentServiceOptions
description: Container for Shipment Service Options.
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/COD_CODAmount"
xml:
name: COD
description: COD container Indicates COD is requested. Shipment COD is only
available for EU origin countries or territories and for shippers account
type Daily Pickup and Drop Shipping. Not available to shipment with return
service.
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 monetary value.
maximum: 1
type: string
minLength: 5
maxLength: 5
xml:
name: CODAmount
description: COD Amount container.
ShipmentServiceOptions_AccessPointCOD:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Access Point COD Currency Code.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Access Point COD Monetary Value.
maximum: 1
type: string
minLength: 1
maxLength: 8
xml:
name: AccessPointCOD
description: "Access Point COD indicates 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. \nNot valid with (Shipment) COD. \nNot available to shipment with
return service."
ShipmentServiceOptions_Notification:
type: object
maximum: 1
required:
- NotificationCode
- EMail
properties:
NotificationCode:
description: |-
The type of notification requested.
Note:
- QVN Exception notification and return notification are not applicable to GFP.
- QV In-transit and Return Notifications are only valid for ImportControl and Return shipment.
- QV In-transit Notification is allowed for return shipments only.
- QV Ship Notification is allowed for forward moving shipments only.
Valid values:
- 5 - QV In-transit Notification
- 6 - QV Ship Notification
- 7 - QV Exception Notification
- 8 - QV Delivery Notification
- 2 - Return Notification or Label Creation Notification
- 012 - Alternate Delivery Location Notification
- 013 - UAP Shipper Notification.
maximum: 1
type: string
minLength: 1
maxLength: 1
EMail:
"$ref": "#/components/schemas/Notification_EMail"
VoiceMessage:
"$ref": "#/components/schemas/Notification_VoiceMessage"
TextMessage:
"$ref": "#/components/schemas/Notification_TextMessage"
Locale:
"$ref": "#/components/schemas/Notification_Locale"
xml:
name: Notification
description: 'Container for the Quantum View Notification (QVN) is valid for
all shipments including Return service, Import Control and Returns Flexible
Access. Valid return service types are: ERL, PRL, PNM, RS1, or RS3. The
shipment level notification is valid for forward and return international
shipments as well as for domestic shipments (for US and PR).'
Notification_EMail:
type: object
maximum: 1
required:
- EMailAddress
properties:
EMailAddress:
description: Email address where the notification is sent. Up to five email addresses are allowed for each type of Quantum View TM shipment notification. Up to two email address for return notification.
maximum: 5
type: array
items:
type: string
minLength: 1
maxLength: 50
UndeliverableEMailAddress:
description: The address where an undeliverable eMail message is sent if the eMail with the notification is undeliverable. There can be only one UndeliverableEMailAddress for each shipment with Quantum View Shipment Notifications.
maximum: 1
type: string
minLength: 1
maxLength: 50
FromEMailAddress:
description: "The e-mail address specifies the Reply To E-mail address. The \"From\" field of the message header contains pkginfo@ups.com. Valid for Return Notification only."
maximum: 1
type: string
minLength: 1
maxLength: 50
FromName:
description: The name the email will appear to be from. Defaults to the Shipper Name. The FromName must occur only once for each shipment with Quantum View Shipment Notifications.
maximum: 1
type: string
minLength: 1
maxLength: 35
Memo:
description: User defined text that will be included in the eMail. The Memo must occur only once for each shipment with Quantum View Shipment Notifications.
maximum: 1
type: string
minLength: 1
maxLength: 150
xml:
name: EMail
description: Container for Email Information.
Notification_VoiceMessage:
type: object
maximum: 1
required:
- PhoneNumber
properties:
PhoneNumber:
description: Phone number for receiving Voice Alternate Delivery Location notification and UAP Shipper notification.
maximum: 1
type: string
minLength: 1
maxLength: 15
xml:
name: VoiceMessage
description: VoiceMessage container is used for specifying phone number for
receiving voice Alternate Delivery Location notification and UAP Shipper notification. Valid
only for Alternate Delivery Location notification and UAP Shipper notification.
VoiceMessage phone number or TextMessage phone number or email address is
required for ADL notification and UAP Shipper notification.
Notification_TextMessage:
type: object
maximum: 1
required:
- PhoneNumber
properties:
PhoneNumber:
description: Phone number for receiving Text Alternate Delivery Location notification and UAP Shipper notification.
maximum: 1
type: string
minLength: 1
maxLength: 15
xml:
name: TextMessage
description: TextMessage container is used for specifying phone number for receiving
text Alternate Delivery Location notification and UAP Shipper notification. Valid
only for Alternate Delivery Location notification and UAP Shipper notification.
VoiceMessage phone number or TextMessage phone number or email address is
required for ADL notification and UAP Shipper notification.
Notification_Locale:
type: object
maximum: 1
required:
- Language
- Dialect
properties:
Language:
description: Refer to Language/Dialect Combinations in the Appendix for
valid pairs.
maximum: 1
type: string
minLength: 3
maxLength: 3
Dialect:
description: Refer to Language/Dialect Combinations in the Appendix for
valid pairs.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Locale
description: This container is used for providing Language and dialect details
for Alternate Delivery Location notifications and UAP Shipper notifications. Valid
only for Alternate Delivery Location notification and UAP Shipper notification.
ShipmentServiceOptions_LabelDelivery:
type: object
properties:
EMail:
"$ref": "#/components/schemas/LabelDelivery_EMail"
LabelLinksIndicator:
description: Indicates the Label and Receipt URLs are to be returned in
the XML response.
maximum: 1
type: string
xml:
name: LabelDelivery
maximum: 1
description: Container for the Label Delivery accessorial. Note - LabelDelivery
is not applicable for GFP and Mail Innovations Forward shipment. Required
for shipments with either Electronic Return Label Return Service or ImportControl
Electronic LabelMethod type. Optional for shipments with Print Return Label
Return Service or ImportControl Print LabelMethod type or Forward movement. If
this container is present for shipments with either Electronic Return Label
Return Service or ImportControl Electronic LabelMethod type, either of the
LabelLinksIndicator or EMail container should be provided. For shipments with
Print Return Label Return Service or ImportControl Print LabelMethod type
or Forward movement, only LabelLinksIndicator is valid option for LabelDelivery
container.
LabelDelivery_EMail:
type: object
maximum: 1
required:
- EMailAddress
properties:
EMailAddress:
description: The destination eMail address for the Label Delivery.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: EMail
description: Container for the email message.
ShipmentServiceOptions_InternationalForms:
type: object
maximum: 1
required:
- FormType
- Product
properties:
FormType:
description: |
Indicates the name of the International Form requested.
Valid values:
- 01 - Invoice
- 03 - CO
- 04 - USMCA
- 05 - Partial Invoice
- 06 - Packinglist
- 07 - Customer Generated Forms
- 08 – Air Freight Packing List
- 09 - CN22 Form
- 10 – UPS Premium Care Form
- 11 - EEI
For shipment with return service, 05 or 10 are the only valid values.
Note: 01 and 05 are mutually exclusive and 05 are only valid for return shipments only.
maximum: 6
type: array
items:
type: string
minLength: 2
maxLength: 2
UserCreatedForm:
"$ref": "#/components/schemas/InternationalForms_UserCreatedForm"
UPSPremiumCareForm:
"$ref": "#/components/schemas/InternationalForms_UPSPremiumCareForm"
CN22Form:
"$ref": "#/components/schemas/InternationalForms_CN22Form"
AdditionalDocumentIndicator:
description: "Presence of the indicator means user will supply additional
document, such as EEI, USMCA or CO. This indicator should be set when
the shipper intends to utilize UPS paperless invoice functionality AND
the shipper has SELF-PREPARED other International Forms (EEI, CO, USMCA)
to accompany the shipment. \nIt is evaluated only when: \n1. Account is
paperless enabled. \n2. Movement requires an invoice.\n3. Destination
country or territory accepts paperless invoice. \n4. Invoice data is supplied
by the client and the data passes validation."
maximum: 1
type: string
FormGroupIdName:
description: Contains description text which identifies the group of International
forms. This element does not appear on the forms.
maximum: 1
type: string
minLength: 1
maxLength: 50
EEIFilingOption:
"$ref": "#/components/schemas/InternationalForms_EEIFilingOption"
Contacts:
"$ref": "#/components/schemas/InternationalForms_Contacts"
Product:
type: array
maximum: 50
items:
"$ref": "#/components/schemas/InternationalForms_Product"
InvoiceNumber:
description: Commercial Invoice number assigned by the exporter. Applies
to Invoice and Partial Invoice forms only. Required for Invoice forms
and optional for Partial Invoice.
maximum: 1
type: string
minLength: 1
maxLength: 35
InvoiceDate:
description: Date when the Invoice is created. Ideally this is the same
as the ship date. Applies to Invoice and Partial Invoice forms only.
Required for Invoice forms and optional for Partial Invoice. Required
for Invoice form for forward shipments. For shipment with return service,
the user input will be ignored, and the field will be blank on the invoice.
Format is yyyyMMdd.
maximum: 1
type: string
minLength: 8
maxLength: 8
PurchaseOrderNumber:
description: The customer's order reference number. Applies to Invoice
and Partial Invoice forms only.
maximum: 1
type: string
minLength: 1
maxLength: 35
TermsOfShipment:
description: "Indicates the rights to the seller from the buyer. Also, it
refers to Terms of Sale. Applies to Invoice and Partial Invoice forms
only. \n\nValid values: \nCFR: Cost and Freight \nCIF: Cost Insurance
and Freight \nCIP: Carriage and Insurance Paid \nCPT: Carriage Paid To
\nDAF: Delivered at Frontier \nDDP: Delivery Duty Paid \nDAP: Delivery
at Place \nDEQ: Delivered Ex Quay \nDES: Delivered Ex Ship \nEXW: Ex
Works \nFAS: Free Alongside Ship \nFCA: Free Carrier \nFOB: Free On Board"
maximum: 1
type: string
minLength: 3
maxLength: 3
ReasonForExport:
description: |-
A reason to export the current international shipment.
Valid values: SALE, GIFT, SAMPLE, RETURN, REPAIR, INTERCOMPANYDATA, Any other reason. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and Optional for Partial Invoice. Required for EU Inbound shipments.
maximum: 1
type: string
minLength: 1
maxLength: 20
Comments:
description: Any extra information about the current shipment. Applies
to Invoice and Partial Invoice forms only.
maximum: 1
type: string
minLength: 1
maxLength: 150
DeclarationStatement:
description: 'This is the legal explanation, used by Customs, for the delivering
of this shipment. It must be identical to the set of declarations actually
used by Customs. Examples of declarations that might be entered in this
field are: I hereby certify that the goods covered by this shipment qualify
as originating goods for purposes of preferential tariff treatment under
the USMCA. I hereby certify that the information on this invoice is true
and correct and the contents and value of this shipment is as stated above. EEA
statement: The exporter of the products covered by this document declares
that except where otherwise clearly indicated these products are of EEA
preferential origin. Applies to Invoice and Partial Invoice forms only.
On the invoice for return shipment, the verbiage is as follows (user input
is ignored): The exporter of the products covered by this document declares
that except where otherwise clearly indicated these products are of EEA
preferential origin'
maximum: 1
type: string
minLength: 1
maxLength: 550
Discount:
"$ref": "#/components/schemas/InternationalForms_Discount"
FreightCharges:
"$ref": "#/components/schemas/InternationalForms_FreightCharges"
InsuranceCharges:
"$ref": "#/components/schemas/InternationalForms_InsuranceCharges"
OtherCharges:
"$ref": "#/components/schemas/InternationalForms_OtherCharges"
CurrencyCode:
description: Currency code for all the monetary values of the Invoice form. Applies
to Invoice and Partial Invoice forms only.
maximum: 1
type: string
minLength: 3
maxLength: 3
BlanketPeriod:
"$ref": "#/components/schemas/InternationalForms_BlanketPeriod"
ExportDate:
description: The date the goods will be exiting the country or territory. Applies
to CO and EEI forms only. Required for CO and EEI forms. Format is yyyyMMdd.
maximum: 1
type: string
minLength: 1
maxLength: 35
ExportingCarrier:
description: |
The name of the carrier that is exporting the shipment. The vessels flag number should also be entered, if the carrier is a vessel.
If value is empty, it will be set to default value as 'UPS' for EEI forms. Applies to CO and EEI forms only. Required for CO forms.
maximum: 1
type: string
minLength: 1
maxLength: 35
CarrierID:
description: The four-character Standard Carrier Alpha Code (SCAC) for vessel,
rail, and truck shipments. For air shipment, enter the two or three character
International Air Transport Association (IATA) code. Applies to EEI forms
only. No Validations.
maximum: 1
type: string
minLength: 1
maxLength: 17
InBondCode:
description: 'The two-character In Bond Code. Applies to EEI forms only.
Required for EEI forms. Valid values for EEI are: 70: Not in bond; 67:
IE from a FTZ; 68: T&E from a FTZ.'
maximum: 1
type: string
minLength: 2
maxLength: 2
EntryNumber:
description: 'The Import Entry Number when the export transaction is used
as proof of export for import transactions (examples: In Bond, Temporary
Import Bond or Drawbacks). Applies to EEI forms only. Conditionally Required
for EEI forms when In bond code value is other than 70 (Not In Bond)'
maximum: 1
type: string
minLength: 1
maxLength: 25
PointOfOrigin:
description: 'Contains one of the following: The two-digit U.S. Postal
Service abbreviation for the state from which the goods were shipped to
the port of export. The state that is the source for the good with the
highest value. The state of consolidation. The Foreign Trade Zone number
of the zone from where the exports are leaving. If the goods were shipped
from Puerto Rico, enter PR. Applies to EEI forms only. Required for EEI.'
maximum: 1
type: string
minLength: 1
maxLength: 5
PointOfOriginType:
description: 'Valid values are : S (for state postal code abbreviation)
, F : FTZ Identifier Applies EEI forms only. Required for EEI form.'
maximum: 1
type: string
minLength: 1
maxLength: 1
ModeOfTransport:
description: 'Mode of transport by which the goods are exported. Valid values:
Air, AirContainerized, Auto, FixedTransportInstallations, Mail, PassengerHandcarried,
Pedestrian, Rail, Rail, Containerized, RoadOther, SeaBarge, SeaContainerized,
SeaNoncontainerized, Truck, TruckContainerized. Applies to EEI forms
only. Required for EEI. Only allowed values can be entered. Only 10
Characters can appear on the form. Anything greater than 10 characters
will be truncated on the form.'
maximum: 1
type: string
minLength: 1
maxLength: 35
PortOfExport:
description: 'Should be one of the following-Overland: The U.S. Customs
port where the carrier crosses the U.S. border, Vessel and Air: The U.S.
Customs port where the goods are loaded on the carrier to be exported
from the U.S., Postal: The U.S. Postal Office from where the goods are
mailed. Applies to EEI forms only. No validation is performed.'
maximum: 1
type: string
minLength: 1
maxLength: 35
PortOfUnloading:
description: The country or territory and the port where the goods will
be unloaded from the exporting carrier. For vessel and air shipments only. Applies
to EEI forms only. No validation is performed.
maximum: 1
type: string
minLength: 1
maxLength: 35
LoadingPier:
description: Pier where goods are loaded. For vessel shipments only. Applies
to EEI forms only. No validation is performed.
maximum: 1
type: string
minLength: 1
maxLength: 35
PartiesToTransaction:
description: |
Information about parties to transaction. Use Related, if the parties to the transaction are related. A related party is an export from a U.S. businessperson or business to a foreign business or from a U.S. business to a foreign person or business where the person has at least 10 percent of the voting shares of the business during the fiscal year. If unincorporated, then an equivalent interest in the business. Applies to EEI forms only.
Valid values:
- R - Related
- N - Non-related.
Parties to transaction is required if EEIFilingOption Code is 3 and if valid UPSFiled POA Code present in request.
Default will be set to N - Non-related if invalid code present with length of one.
maximum: 1
type: string
minLength: 1
maxLength: 1
RoutedExportTransactionIndicator:
description: If Present, indicates that it is a routed export transaction.
A routed export transaction is one, where the foreign principal party
in interest authorizes a U.S. forwarding (or other) agent to export the
merchandise outside the U.S. Applies to EEI forms only.
maximum: 1
type: string
ContainerizedIndicator:
description: If present indicates that the goods are containerized. This
applies to vessel shipments only. Applies to EEI forms only.
maximum: 1
type: string
OverridePaperlessIndicator:
description: The application will automatically provide a copy of the invoice
or USMCA with each response regardless of whether the user has enabled
Paperless account. The user now has the option to print or ignore the
copy provided.
maximum: 1
type: string
ShipperMemo:
description: Text for the shipper to add additional information. Forward
shipment only.
maximum: 1
type: string
minLength: 1
maxLength: 300
HazardousMaterialsIndicator:
description: This is an empty tag. Presence of the indicator for EEI form
means shipment contains hazardous material.
maximum: 1
type: string
xml:
name: InternationalForms
description: International Forms information. This is applicable to Trade Direct SMALLPACKAGE International Child
movements and not applicable to Trade Direct Master or Trade Direct LTL Child movements.
InternationalForms_UserCreatedForm:
type: object
maximum: 13
required:
- DocumentID
properties:
DocumentID:
description: DocumentID represents a document uploaded to Forms History.
maximum: 13
type: array
items:
type: string
minLength: 26
maxLength: 26
xml:
name: UserCreatedForm
description: Data container for DocumentID(s). Required if Form Type is 07.
InternationalForms_UPSPremiumCareForm:
type: object
maximum: 1
required:
- NumOfCopies
- PrintType
- PageSize
- ShipmentDate
- LanguageForUPSPremiumCare
properties:
ShipmentDate:
description: 'Shipment Date associated with UPS Premium Care Shipment. Valid
Format: yyyyMMdd'
maximum: 1
type: string
PageSize:
description: "Size of UPS Premium Care Form. Valid values: \n01 = A4 Size\n02
= Letter Size"
maximum: 1
type: string
minLength: 2
maxLength: 2
PrintType:
description: "Format of UPS Premium Care Form. Valid values: \n01 = PNG\n02
= PDF"
maximum: 1
type: string
minLength: 2
maxLength: 2
NumOfCopies:
description: Number of Copies of UPS Premium Care Form. Valid value is
02.
maximum: 1
type: string
minLength: 2
maxLength: 2
LanguageForUPSPremiumCare:
"$ref": "#/components/schemas/UPSPremiumCareForm_LanguageForUPSPremiumCare"
xml:
name: UPSPremiumCareForm
description: UPS Premium Care Form is required if UPS Premium Care Indicator
is present on a package. Valid only for Canada to Canada movements.
UPSPremiumCareForm_LanguageForUPSPremiumCare:
type: object
maximum: 2
required:
- Language
properties:
Language:
description: "Languages for UPS Premium Care Form. Two languages are required
for UPS Premium Care Form. Valid values: \neng = US English\nfra = Canadian
French"
maximum: 2
type: array
items:
type: string
minLength: 3
maxLength: 3
xml:
name: LanguageForUPSPremiumCare
description: Container to hold languages in which UPS Premium Care Form is required.
InternationalForms_CN22Form:
type: object
maximum: 1
required:
- LabelPrintType
- CN22Type
- LabelSize
- PrintsPerPage
- CN22Content
properties:
LabelSize:
description: "Provide the valid values: \n6 = 4X6\n1 = 8.5X11\n Required
if the CN22 form container is present."
maximum: 1
type: string
minLength: 2
maxLength: 2
PrintsPerPage:
description: Number of label per page. Currently 1 per page is supported. Required
if the CN22 form container is present.
maximum: 1
type: string
minLength: 1
maxLength: 1
LabelPrintType:
description: |-
Valid Values are pdf, png, gif, zpl, star, epl2 and spl.
Required if the CN22 form container is present.
maximum: 1
type: string
minLength: 1
maxLength: 4
CN22Type:
description: "Valid values: \n1 = GIFT\n2 = DOCUMENTS\n3 = COMMERCIAL SAMPLE\n4
= OTHER Required if the CN22 form container is present."
maximum: 1
type: string
minLength: 1
maxLength: 1
CN22OtherDescription:
description: Required if CN22Type is OTHER. Required if the CN22 form container
is present.
maximum: 1
type: string
minLength: 20
maxLength: 20
FoldHereText:
description: String will replace default "Fold Here" text displayed on the
label.
maximum: 1
type: string
minLength: 35
maxLength: 35
CN22Content:
type: array
maximum: 3
items:
"$ref": "#/components/schemas/CN22Form_CN22Content"
xml:
name: CN22Form
description: Container for the CN22 form. Required if the customer wants to
use the UPS generated CN22.
CN22Form_CN22Content:
type: object
maximum: 1
required:
- CN22ContentCurrencyCode
- CN22ContentTotalValue
- CN22ContentDescription
- CN22ContentWeight
- CN22ContentQuantity
properties:
CN22ContentQuantity:
description: Total number of items associated with this content. Required
if the CN22 form container is present.
maximum: 1
type: string
CN22ContentDescription:
description: |-
Detailed description of the content.
If the combined MI package and CN22 label is requested, only the first 30 characters will appear on the combined label. Required if the CN22 form container is present.
maximum: 1
type: string
minLength: 1
maxLength: 105
CN22ContentWeight:
"$ref": "#/components/schemas/CN22Content_CN22ContentWeight"
CN22ContentTotalValue:
description: Total value of the items associated with this content. Required
if the CN22 form container is present.
maximum: 1
type: string
minLength: 9
maxLength: 9
CN22ContentCurrencyCode:
description: Currently only USD is supported. Required if the CN22 form
container is present.
maximum: 1
type: string
minLength: 3
maxLength: 3
CN22ContentCountryOfOrigin:
description: Country or Territory of Origin from where the CN22 contents
originated.
maximum: 1
type: string
minLength: 2
maxLength: 2
CN22ContentTariffNumber:
description: The tariff number associated with the CN22 contents.
maximum: 1
type: string
minLength: 40
maxLength: 40
DDSReferenceNumber:
"$ref": "#/components/schemas/CN22Content_CN22DDSReferenceNumber"
xml:
name: CN22Content
description: "Container for CN22 content. Required if the CN22 form container
is present. \nNote: The maximum number of goods printed on the CN22 form when
a combined MI package and CN22 form label is requested is 30."
CN22Content_CN22DDSReferenceNumber:
type: object
maximum: 1
properties:
Number:
description: holds a list of DDS Reference Numbers
maximum: 5
type: string
CN22Content_CN22ContentWeight:
type: object
required:
- UnitOfMeasurement
- Weight
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/CN22ContentWeight_UnitOfMeasurement"
Weight:
description: Total weight of the content. Pounds and Ounces are allowed
up to 2 decimals. Required if the CN22 form container is present.
maximum: 1
type: string
minLength: 7
maxLength: 7
xml:
name: CN22ContentWeight
maximum: 1
description: Container for CN22 content weight.
CN22ContentWeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: Required if weight is provided, valid values are lbs. and ozs. Required if weight is provided.
maximum: 1
type: string
minLength: 1
maxLength: 3
Description:
description: Short description for UnitOfMeasurement.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: UnitOfMeasurement
description: Container for UOM.
InternationalForms_EEIFilingOption:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: "Required for EEI Form. Applicable for EEI form.\nValid values:
\n1 - Shipper filed,\n2 - AES Direct, \n3 - UPS filed."
maximum: 1
type: string
minLength: 1
maxLength: 1
EMailAddress:
description: Email Address where the notification is sent. Valid for UPS
filed (option 3), Shipper filed (option 1- A , 1-C) Applicable for EEI
form.
maximum: 1
type: string
minLength: 1
maxLength: 50
Description:
description: Optional Description of Filing Code. Applicable for EEI form.
maximum: 1
type: string
minLength: 1
maxLength: 20
UPSFiled:
"$ref": "#/components/schemas/EEIFilingOption_UPSFiled"
ShipperFiled:
"$ref": "#/components/schemas/EEIFilingOption_ShipperFiled"
xml:
name: EEIFilingOption
description: EEI Filing option. Applicable for EEI form and is required.
EEIFilingOption_UPSFiled:
type: object
required:
- POA
properties:
POA:
"$ref": "#/components/schemas/UPSFiled_POA"
xml:
name: UPSFiled
description: Indicates the EEI UPS Filed option. (option 3) Applicable for
EEI form.
maximum: 1
UPSFiled_POA:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: Indicates the EEI UPS Filed POA filing option. Applicable
for EEI form. Valid values are 1- One Time POA; 2- Blanket POA.
maximum: 1
type: string
minLength: 1
maxLength: 1
Description:
description: Description for POA Code. Applicable for EEI form.
maximum: 1
type: string
minLength: 1
maxLength: 20
xml:
name: POA
description: Container for POA. Applicable for EEI form.
EEIFilingOption_ShipperFiled:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: 'Indicates the EEI Shipper sub option. Applicable for EEI
form and is required. Valid value is: A- requires the ITN; B- requires
the Exemption Legend; C- requires the post departure filing citation.'
maximum: 1
type: string
minLength: 1
maxLength: 1
Description:
description: Description of ShipperFiled Code. Applicable for EEI form.
maximum: 1
type: string
minLength: 1
maxLength: 20
PreDepartureITNNumber:
description: Input for Shipper Filed option A and AES Direct. The format
is available from AESDirect website. Valid and Required for Shipper Filed
option A. EEI form only.
maximum: 1
type: string
minLength: 17
maxLength: 17
ExemptionLegend:
description: Input for Shipper Filed option B. 30.2(d)(2), 30.26(a), 30.36,
30.37(a), 30.37(b), 30.37(c), 30.37(d), 30.37(e), 30.37(f), 30.37(h),
30.37(i), 30.30(j), 30.37(k), 30.37(i), 30.37(j), 30.37(k), 30.37(l),
30.37(m), 30.37(n), 30.37(o), 30.37(p), 30.37(q), 30.37(r), 30.37(s),
30.37(t), 30.37(u), 30.37(x), 30.37(y)(1), 30.37(y)(2), 30.37(y)(3), 30.37(y)(4),
30.37(y)(5), 30.37(y)(6), 30.39, 30.40(a), 30.40(b), 30.40(c), 30.40(d),
30.8(b) Valid and Required for Shipper Filed option B. EEI form only.
maximum: 1
type: string
minLength: 20
maxLength: 20
EEIShipmentReferenceNumber:
description: Shipment Reference Number for use during interaction with AES.
Valid for EEI form for Shipper Filed option 'C' and AES Direct Filed.
maximum: 1
type: string
minLength: 2
maxLength: 17
xml:
name: ShipperFiled
description: Indicates the EEI Shipper Filed option or AES Direct. (Option 1
or 2). Applicable for EEI form.
InternationalForms_Contacts:
type: object
properties:
ForwardAgent:
"$ref": "#/components/schemas/Contacts_ForwardAgent"
UltimateConsignee:
"$ref": "#/components/schemas/Contacts_UltimateConsignee"
IntermediateConsignee:
"$ref": "#/components/schemas/Contacts_IntermediateConsignee"
Producer:
"$ref": "#/components/schemas/Contacts_Producer"
SoldTo:
"$ref": "#/components/schemas/Contacts_SoldTo"
xml:
name: Contacts
description: Holds the contact information of various parties. Applicable for
EEI and USMCA only. Required for USMCA and EEI. Ultimate consignee contact
information is required for EEI. Producer contact information is required
for USMCA
maximum: 1
Contacts_ForwardAgent:
type: object
maximum: 1
required:
- CompanyName
- Address
- TaxIdentificationNumber
properties:
CompanyName:
description: Company Name or the Individual name of the Forwarding agent. Applicable
for EEI form only.
maximum: 1
type: string
minLength: 1
maxLength: 35
TaxIdentificationNumber:
description: "Tax ID of the Forwarding agent.\nValid Values: (Below values
are applicable for EEIFilingOption Code =3)\n94-308351500 \n13-168669100
\ \n Applicable for EEI form only."
maximum: 1
type: string
minLength: 1
maxLength: 15
Address:
"$ref": "#/components/schemas/ForwardAgent_Address"
xml:
name: ForwardAgent
description: The forwarding agent is the company or person acting as agent in
the trans-shipping of freight to the destination country or territory. Applicable
for EEI form only.
ForwardAgent_Address:
type: object
maximum: 1
required:
- AddressLine
- City
- CountryCode
properties:
AddressLine:
description: Address line of the Forwarding agent. Applicable for EEI form only.
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: City of the Forwarding agent. Applicable for EEI form only.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: |
State of the Forwarding agent. Applicable for EEI form only. Required for US, Canada, and Vietnam (VN).
- For US or Canada, the value must be a valid US state or Canadian province code.
- For Vietnam (VN), the value must be a valid province code (for example, VN-44).
- If the country or territory is Ireland, the StateProvinceCode must contain the county.
maximum: 1
type: string
minLength: 1
maxLength: 5
Town:
description: Town of the Forwarding Agent. Applicable for EEI form only.
maximum: 1
type: string
minLength: 1
maxLength: 30
PostalCode:
description: Postal code of the Forwarding agent. Applicable for EEI form only. Required for certain countries or territories. The length of the postal code depends on the country or territory code
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: Country or Territory code of the Forwarding agent. Applicable for EEI form only.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
description: Address information of the Forwarding agent. Applicable for EEI
form only.
Contacts_UltimateConsignee:
type: object
maximum: 1
required:
- CompanyName
- Address
properties:
CompanyName:
description: Company Name or the Individual name of the Ultimate consignee. Applicable
for EEI form only.
maximum: 1
type: string
minLength: 1
maxLength: 35
Address:
"$ref": "#/components/schemas/UltimateConsignee_Address"
UltimateConsigneeType:
"$ref": "#/components/schemas/UltimateConsignee_UltimateConsigneeType"
xml:
name: UltimateConsignee
description: The ultimate consignee is the person or company who receives the
goods for end-use or the person or company listed on the export license. This
is the end-user of the goods. Applicable for EEI form only.
UltimateConsignee_Address:
type: object
maximum: 1
required:
- AddressLine
- City
- CountryCode
properties:
AddressLine:
description: Address line of the Ultimate consignee. Applicable for EEI form only.
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: City of the Ultimate consignee. Applicable for EEI form only.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: |
State of the Ultimate consignee. Applicable for EEI form only. Required for US, Canada, and Vietnam (VN).
The length of the postal code depends on the country or territory code.
- For US or Canada, the value must be a valid US state or Canadian province code.
- For Vietnam (VN), the value must be a valid province code (for example, VN-44).
- If the country or territory is Ireland, the StateProvinceCode must contain the county.
maximum: 1
type: string
minLength: 1
maxLength: 5
Town:
description: Town of the Ultimate consignee. Applicable for EEI form only.
maximum: 1
type: string
minLength: 1
maxLength: 30
PostalCode:
description: Postal code of the Ultimate consignee. Applicable for EEI form only. Required for certain countries or territories. The length of the postal code depends on the country or territory code.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: Country or Territory code of the Ultimate consignee. Applicable for EEI form only.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
description: Address information of the Ultimate consignee. Applicable for
EEI form only.
UltimateConsignee_UltimateConsigneeType:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: "Ultimate Consignee Type Code. Applicable for EEI form only.\n\nValid
values: \nD = Direct Consumer \nG = Government Entity\nR = Reseller\nO
= Other/Unknown"
maximum: 1
type: string
minLength: 1
maxLength: 1
Description:
description: Ultimate Consignee Type Description. Applicable for EEI form
only.
maximum: 1
type: string
minLength: 1
maxLength: 20
xml:
name: UltimateConsigneeType
description: Container for providing UltimateConsignee Type. Applicable for
EEI form only.
Contacts_IntermediateConsignee:
type: object
maximum: 1
required:
- CompanyName
- Address
properties:
CompanyName:
description: Company Name or the Individual name of the Intermediate consignee. Applicable
for EEI form only.
maximum: 1
type: string
minLength: 1
maxLength: 35
Address:
"$ref": "#/components/schemas/IntermediateConsignee_Address"
xml:
name: IntermediateConsignee
description: The intermediate consignee is the person or company in the importing
country or territory that makes final delivery to the ultimate consignee. Applicable
for EEI form only.
IntermediateConsignee_Address:
type: object
maximum: 1
required:
- AddressLine
- City
- CountryCode
properties:
AddressLine:
description: Address line of the Intermediate Consignee. Applicable for EEI form only.
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: City of the Intermediate Consignee. Applicable for EEI form only.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: |
State of the Intermediate Consignee. Applicable for EEI form only. Required for US, Canada, and Vietnam (VN).
- For US or Canada, the value must be a valid US state or Canadian province code.
- For Vietnam (VN), the value must be a valid province code (for example, VN-44).
- If the country or territory is Ireland, the StateProvinceCode must contain the county.
maximum: 1
type: string
minLength: 1
maxLength: 5
Town:
description: Town of the Intermediate consignee. Applicable for EEI form only.
maximum: 1
type: string
minLength: 1
maxLength: 30
PostalCode:
description: Postal code of the Intermediate Consignee. Applicable for EEI form only. Required for certain countries or territories. The length of the postal code depends on the country or territory code.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: Country or Territory code of the Intermediate Consignee. Applicable for EEI form only.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
description: Address information of the Intermediate Consignee. Applicable
for EEI form only.
Contacts_Producer:
type: object
maximum: 1
properties:
Option:
description: "The text associated with the code will be printed in the producer
section instead of producer contact information. \nUse attached List if
more than one producer's good is included on the Certificate, attach a
list of additional producers, including the legal name, address (including
country or territory), and legal tax identification number, cross-referenced
to the goods described in the Description of Goods field. Applies to
USMCA. \nValid values: \n01 - AVAILABLE TO CUSTOMS UPON REQUEST\n02
- SAME AS EXPORTER\n03 - ATTACHED LIST\n04 - UNKNOWN"
maximum: 1
type: string
minLength: 2
maxLength: 2
CompanyName:
description: 'Company Name or the Individual name of the Producer. Applies
to USMCA. Only applicable when producer option is empty or not present.
Conditionally required for: USMCA, when Producer option is not specified.'
maximum: 1
type: string
minLength: 1
maxLength: 35
TaxIdentificationNumber:
description: Tax ID of the Producer. Applies to USMCA. Only applicable
when producer option is empty or not present
maximum: 1
type: string
minLength: 1
maxLength: 15
Address:
"$ref": "#/components/schemas/Producer_Address"
AttentionName:
description: Contact name at the Producer location. Applies to USMCA.
maximum: 1
type: string
minLength: 1
maxLength: 35
Phone:
"$ref": "#/components/schemas/Producer_Phone"
EMailAddress:
description: Producer email address. Applies to USMCA.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: Producer
description: "Information of the producer. The USMCA Certificate of Origin must
be completed, signed, and dated by the exporter. \nWhen the Certificate is
completed by the producer for use by the exporter, it must be completed, signed,
and dated by the producer. The date must be the date the Certificate was completed
and signed. Applies to USMCA. Required for USMCA forms."
Producer_Address:
type: object
maximum: 1
required:
- AddressLine
- City
- CountryCode
properties:
AddressLine:
description: Address line of the Producer.
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: "City of the Producer. Applies to USMCA. Conditionally required for: USMCA, when Producer option is not specified."
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: |
State of the Producer. Applies to USMCA. Required for US, Canada, and Vietnam (VN).
- For US or Canada, the value must be a valid US state or Canadian province code.
- For Vietnam (VN), the value must be a valid province code (for example, VN-44).
- If the country or territory is Ireland, the StateProvinceCode must contain the county.
maximum: 1
type: string
minLength: 1
maxLength: 5
Town:
description: Town of the Producer.
maximum: 1
type: string
minLength: 1
maxLength: 30
PostalCode:
description: Postal code of the Producer. Applies to USMCA. Required for certain countries or territories. The length of the postal code depends on the country or territory code.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: Country or Territory code of the Producer. Applies to USMCA.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
description: 'Address information of the Producer. Applies to USMCA. Only
applicable if producer option is empty or not present. Conditionally required
for: USMCA, when Producer option is not specified.'
Producer_Phone:
type: object
maximum: 1
required:
- Number
properties:
Number:
description: The locations phone number of the Producer. Applies to USMCA.
maximum: 1
type: string
minLength: 1
maxLength: 15
Extension:
description: The locations phone extension of the Producer. Applies to USMCA.
maximum: 1
type: string
minLength: 1
maxLength: 4
xml:
name: Phone
description: Phone number information of Producer. Applies to USMCA.
Contacts_SoldTo:
type: object
maximum: 1
required:
- AttentionName
- Address
- Name
properties:
Name:
description: Company Name.
maximum: 1
type: string
minLength: 1
maxLength: 35
AttentionName:
description: Sold to contact name.
maximum: 1
type: string
minLength: 1
maxLength: 35
TaxIdentificationNumber:
deprecated: true
description: SoldTo Tax Identification Number. This element has been deprecated, replacement can be found in the GlobalTaxInformation container.
maximum: 1
type: string
minLength: 1
maxLength: 15
Phone:
"$ref": "#/components/schemas/SoldTo_Phone"
Option:
description: "The text associated with the code will be printed in the sold to section of the USMCA form. The values indicate the following: 01 – Unknown. Applies to USMCA form. Possible Values are 01 and 02."
maximum: 1
type: string
minLength: 2
maxLength: 2
Address:
"$ref": "#/components/schemas/SoldTo_Address"
EMailAddress:
description: SoldTo email address.
maximum: 1
type: string
minLength: 1
maxLength: 50
AccountNumber:
description: SoldTo AccountNumber
maximum: 1
type: string
minLength: 1
maxLength: 6
xml:
name: SoldTo
description: SoldTo Container. The Sold To party's country code must be the
same as the Ship To party's country code with the exception of Canada and
satellite countries. Applies to Invoice and USMCA Forms. Required if Invoice
or USMCA (International Form) is requested.
SoldTo_Phone:
type: object
maximum: 1
required:
- Number
properties:
Number:
description: Sold To contacts phone number.
maximum: 1
type: string
minLength: 1
maxLength: 15
Extension:
description: Sold To contacts phone extension.
maximum: 1
type: string
minLength: 1
maxLength: 4
xml:
name: Phone
description: Phone Container.
SoldTo_Address:
type: object
maximum: 1
required:
- AddressLine
- City
- CountryCode
properties:
AddressLine:
description: SoldTo location's street address. Applies to USMCA.
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
City:
description: SoldTo location's city.
maximum: 1
type: string
minLength: 1
maxLength: 30
StateProvinceCode:
description: |
SoldTo location's state or province code. Required for US, Canada, and Vietnam (VN).
- For US or Canada, the value must be a valid US state or Canadian province code.
- For Vietnam (VN), the value must be a valid province code (for example, VN-44).
- If the country or territory is Ireland, the StateProvinceCode must contain the county.
maximum: 1
type: string
minLength: 1
maxLength: 5
Town:
description: SoldTo location's town code.
maximum: 1
type: string
minLength: 1
maxLength: 30
PostalCode:
description: SoldTo location's postal code.
maximum: 1
type: string
minLength: 1
maxLength: 9
CountryCode:
description: SoldTo location's country or territory code.
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Address
description: Sold To Address Container. Applies to USMCA.
InternationalForms_Product:
type: object
maximum: 1
required:
- Description
properties:
Description:
description: Description of the product. Applies to all International Forms.
Optional for Partial Invoice. Must be present at least once and can occur
for a maximum of 3 times.
maximum: 3
type: array
items:
type: string
minLength: 1
maxLength: 35
Unit:
"$ref": "#/components/schemas/Product_Unit"
CommodityCode:
description: '6-to-15-alphanumeric commodity code. Customs uses this code
to determine what duties should be assessed on the commodity. Applies
to Invoice, Partial Invoice and USMCA. Required for USMCA and optional
for Partial Invoice. Should be at least 6 alphanumeric. For USMCA:
For each good described in Description of Goods field, identify the H.S.
tariff classification to six digits. If the good is subject to a specific
rule of origin in Annex 401 that requires eight digits, identify to eight
digits, using the H.S. tariff classification of the country or territory
into whose territory the good is imported.'
maximum: 1
type: string
minLength: 6
maxLength: 15
PartNumber:
description: The part number or reference number for the product contained
in the invoice line, as indicated on the customs invoice. Applies to
Invoice and Partial Invoice. Required for Invoice forms and optional for
Partial Invoice.
maximum: 1
type: string
minLength: 1
maxLength: 35
OriginCountryCode:
description: The country or territory in which the good was manufactured,
produced or grown. For detailed information on country or territory of
origin, certificate of origin, rules of origin, and any related matters,
please refer to the U.S. Customs and Border Protection Web site at www.customs.gov
or contact your country or territory's Customs authority.
maximum: 1
type: string
minLength: 2
maxLength: 2
JointProductionIndicator:
description: If present, JNT will be used as the origin of country or territory
code on the USMCA form and the Product/Origincountry or territoryCode
tag will be ignored. Applies to USMCA only.
maximum: 1
type: string
NetCostCode:
description: |
For each good described in the Description of Goods field, where the good is subject to a regional value content (RVC) requirement, indicate NC if the RVC is calculated according to the net cost method; otherwise, indicate NO. If the RVC is calculated over a period of time then indicate "NC with begin/end date" by passing code "ND" Applies to USMCA only. Required for USMCA. Valid values:
- NC
- ND
- NO
maximum: 1
type: string
minLength: 2
maxLength: 2
NetCostDateRange:
"$ref": "#/components/schemas/Product_NetCostDateRange"
PreferenceCriteria:
description: "Indicates the criterion (A through F) for each good described
in the Description of Goods field if applicable. \n\nThe rules of origin
are contained in Chapter Four and Annex 401. \n\nAdditional rules are
described in Annex 703.2 (certain agricultural goods), Annex 300-B, Appendix
6 (certain textile goods) and Annex 308.1 (certain automatic data processing
goods and their parts). Applies to USMCA only."
maximum: 1
type: string
minLength: 1
maxLength: 1
ProducerInfo:
description: "Indicate the following: Yes - If shipper is the producer
of the good. If not, state 02, 03, and 04 depending on whether this certificate
was based upon: \nNo [1] - Knowledge of whether the good qualifies as
an originating good. \nNo [2] - Reliance on the producers written representation
(other than a Certificate of Origin) that the good qualifies as an originating
good. \nNo [3] - A completed and signed Certificate for the good voluntarily
provided to the exporter by the producer. Applicable for USMCA and
is required. Valid values: Yes, No [1], No [2], and No [3]."
maximum: 1
type: string
minLength: 3
maxLength: 5
MarksAndNumbers:
description: Any special marks, codes, and numbers that may appear on package. Applies
to CO Only.
maximum: 1
type: string
minLength: 1
maxLength: 35
NumberOfPackagesPerCommodity:
description: The total number of packages, cartons, or containers for the
commodity. Applicable for CO and is required. Should be numeric. Valid
characters are 0 -9.
maximum: 1
type: string
minLength: 1
maxLength: 3
ProductWeight:
"$ref": "#/components/schemas/Product_ProductWeight"
VehicleID:
description: 'Includes the following information for used self-propelled
vehicles as defined in Customs regulations 19 CFR 192.1: The unique Vehicle
Identification Number (VIN) in the proper format. Or The Product Identification
Number (PIN) for those used self-propelled vehicles for which there are
no VINs. Or the Vehicle Title Number. Applies to EEI forms only.'
maximum: 1
type: string
minLength: 1
maxLength: 25
ScheduleB:
"$ref": "#/components/schemas/Product_ScheduleB"
ExportType:
description: 'Code indicating Domestic: Exports that have been produced,
manufactured, or grown in the United States or Puerto Rico. This includes
imported merchandise which has been enhanced in value or changed from
the form in which imported by further manufacture or processing in the
United States or Puerto Rico. Foreign: Merchandise that has entered the
United States and is being exported again in the same condition as when
imported. Applies to EEI forms only. Required for EEI form. Valid values: D:
Domestic; F: Foreign.'
maximum: 1
type: string
minLength: 1
maxLength: 1
SEDTotalValue:
description: |
This amount will always be USD. Applies to EEI forms only. Required for EEI form. Valid characters are 0-9 and \'.\' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including \'.\' and can hold up to 2 decimal places.
Note: This value is calculated based on the Product/Unit/Value and /Product/Unit/Number (Number of Units * Price per Unit). If the total value is incorrect it will be replaced by the actual calculated total value.
maximum: 1
type: string
minLength: 1
maxLength: 15
TaxesPaid:
description: "Invoice Commodity Level Tax Collected Code for each shipment commodity line.Taxes paid Indicator is only applicable for shipments to Singapore. [TaxesPaid = 0 - No on Report], [TaxesPaid = 1 -Yes on Report], [TaxesPaid = empty - null on Report], [If TaxesPaid is not passed in input request = null on Report]"
type: string
ProductIdentifierExemptIndicator:
description: If the exemption indicator is set to true, the Product Identifiers are optional and not required. Valid values are true/false. Conditionally Required for EU Inbound shipments.
type: boolean
default: false
ProductIdentifier:
description: The Product Identifier array contains the following pair of fields
1) Product ID
2) Product ID Type Code.
Required if ProductIdentifierExemptIndicator is false. Conditionally Required for EU Inbound shipments.
type: array
maximum: 6
items:
"$ref": "#/components/schemas/InternationalForms_ProductIdentifier"
ExcludeFromForm:
"$ref": "#/components/schemas/Product_ExcludeFromForm"
PackingListInfo:
"$ref": "#/components/schemas/Product_PackingListInfo"
EEIInformation:
"$ref": "#/components/schemas/Product_EEIInformation"
DDSReferenceNumber:
"$ref": "#/components/schemas/Product_DDSReferenceNumber"
xml:
name: Product
description: "Contains the commodity/product information. Applies to EEI, Invoice,
Partial Invoice, CO and USMCA. When any International form is requested,
at least one Product must be present. \n\nMaximum number of products allowed
for different forms are:\n\n50: Package Packing List\n\n100: Commercial Invoice,
USMCA, CO, EEI\n\n1000: Air Freight packing list\n\nNote: For Partial Invoice
this container is optional."
Product_Unit:
type: object
maximum: 1
required:
- Number
- UnitOfMeasurement
- Value
properties:
Number:
description: Total quantity of each commodity to be shipped, measured in
the units specified in the Unit of Measure field. Required for Invoice
forms and optional for Partial Invoice. Must be numeric. Valid characters
are 0-9.
maximum: 1
type: string
minLength: 1
maxLength: 7
UnitOfMeasurement:
"$ref": "#/components/schemas/Unit_UnitOfMeasurement"
Value:
description: 'Monetary amount used to specify the worth or price of the
commodity. Amount should be greater than zero. Applies to Invoice and
Partial Invoice form. Required for Invoice forms and optional for Partial
Invoice. Amount should be greater than zero. Valid characters are 0-9
and. (Decimal point). Limit to 6 digits after the decimal. The maximum
length of the field is 19 including ''.'' and can hold up to 6 decimal
places.(#####.######, ######.#####, #######.####, ########.###, #########.##,##########.#,############).
The value of this product and the other products should be such that
the invoice line total which is the sum of ( number*values) of all products
should not exceed 9999999999999999.99'
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: Unit
description: Container tag for the Unit information of each product. (also called
as commodity) Required for Invoice forms and optional for Partial Invoice.
Unit_UnitOfMeasurement:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Code for the Unit of measurement of the commodity units. Required for Invoice forms and optional for Partial Invoice.
Refer to Product Unit of Measure Codes in the Appendix for valid values.
maximum: 1
type: string
minLength: 1
maxLength: 3
Description:
description: The Unit of Measure if OTH (Other) is entered as the UnitOfMeasurement code. Applies to Invoice and Partial Invoice forms. Conditionally Required for the Invoice and Partial Invoice form if OTH is entered as the units UnitOfMeasurement Code.
maximum: 1
type: string
minLength: 1
maxLength: 3
xml:
name: UnitOfMeasurement
description: Container tag for the Unit of measurement for the commodity. Required
for Invoice forms and optional for Partial Invoice.
InternationalForms_ProductIdentifier:
type: object
properties:
ProductID:
description: A generic field that can contain any type of product identifier used to specify a commodity/product. Every Product ID field must have a corresponding Product ID Type Code field to specify the type of product identifier it contains. This field can hold any one of the defined Product Identifiers - Merchant Product Identifier, Manufacturer Product Identifier and Standardized Product Identifier. Conditionally Required for EU Inbound shipments.
type: string
maxLength: 100
ProductIDTypeCode:
description: A code that specifies the type of product identifier in the Product ID field. Conditionally Required for EU Inbound shipments.
Valid values
0100 = Merchant Product Identifier
0200 = Manufacturer Product Identifier
0300 = Standardized Product Identifier.
type: string
minLength: 4
maxLength: 4
description: Container for Product Identifier information.
Product_NetCostDateRange:
type: object
maximum: 1
required:
- EndDate
- BeginDate
properties:
BeginDate:
description: 'If the RVC is calculated over a period of time, it should
be identified by the begin date (yyyyMMdd) of that period. (Reference:
Articles 402.1, 402.5). Applies to USMCA only. Format is yyyyMMdd.'
maximum: 1
type: string
minLength: 8
maxLength: 8
EndDate:
description: 'If the RVC is calculated over a period of time, it should
be identified by the End date (yyyyMMdd) of that period. (Reference: Articles
402.1, 402.5). Applies to USMCA only. Format is yyyyMMdd.'
maximum: 1
type: string
minLength: 8
maxLength: 8
xml:
name: NetCostDateRange
description: Date Range for regional value content (RVC). Applies to USMCA
CO only.
Product_ProductWeight:
type: object
required:
- UnitOfMeasurement
- Weight
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/ProductWeight_UnitOfMeasurement"
Weight:
description: "Weight of Product. Applies to CO and EEI forms only. 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: ProductWeight
maximum: 1
description: The shipping weight, including containers, for each commodity with
a separate Harmonized Tariff Code / Schedule B Number. This weight does not
include carrier equipment. Applies to CO and EEI forms only. Required for
CO and EEI forms.
ProductWeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Code for unit of Measurement of weight. Applies to CO and EEI forms only. Valid values:
- KGS
- LBS
maximum: 1
type: string
minLength: 1
maxLength: 3
Description:
description: Description of the Unit of Measure.
maximum: 1
type: string
minLength: 1
maxLength: 20
xml:
name: UnitOfMeasurement
description: Container tag for the Unit of Measurement of weight. Applies to
CO and EEI forms only.
Product_ScheduleB:
type: object
maximum: 1
required:
- Number
- UnitOfMeasurement
properties:
Number:
description: 'A unique 10-digit commodity classification code for the item
being exported. (To classify a commodity access the following Web page:
http://www.census.gov/foreign-trade/schedules/b/#search). Applies to
EEI forms only. Has to be 10 characters.'
maximum: 1
type: string
minLength: 10
maxLength: 10
Quantity:
description: The count of how many Schedule B units of the current good
are in the shipment (EEI only). For example, if the Schedule B unit of
measure is dozens and eight dozen, is being shipped, indicate 8 in this
field. Applies to EEI forms only. Conditionally required for EEI forms
if ScheduleB UnitOfMeasurement is not X. Should be Numeric. Valid characters
are 0 -9.
maximum: 2
type: array
items:
type: string
minLength: 1
maxLength: 10
UnitOfMeasurement:
type: array
maximum: 2
items:
"$ref": "#/components/schemas/ScheduleB_UnitOfMeasurement"
xml:
name: ScheduleB
description: Container tag for the schedule B information of a commodity. Applies
to EEI forms only. Required for EEI form
ScheduleB_UnitOfMeasurement:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
The unit of measure indicated on the Export License. Enter an X if there is no unit of measure in the Schedule B Unit field. Applies to EEI forms only. Required for the EEI form.
Refer to ScheduleB Unit of Measure Codes in the Appendix for valid values.
maximum: 1
type: string
minLength: 1
maxLength: 3
Description:
description: Description of the Unit of Measure.
maximum: 1
type: string
minLength: 1
maxLength: 20
xml:
name: UnitOfMeasurement
description: The unit of measure indicated on the Export License. Applies to
EEI forms only.
Product_ExcludeFromForm:
type: object
required:
- FormType
properties:
FormType:
description: Indicates the name of the International form requested to NOT have product information. Possible Values are 04 – USMCA. Please note that if this is used and you DO NOT have the corresponding form type requested this will be IGNORED.
type: array
items:
type: string
minLength: 1
maxLength: 2
xml:
name: ExcludeFromForm
description: Container tag for determining whether or not to exclude product
information from a particular form. If this container is not present we assume
that the DEFAULT is selected which is "none" and all products will appear
on all forms.
maximum: 1
Product_PackingListInfo:
type: object
required:
- PackageAssociated
properties:
PackageAssociated:
type: array
maximum: 20
items:
"$ref": "#/components/schemas/PackingListInfo_PackageAssociated"
xml:
name: PackingListInfo
description: Data Container holding package related information. Required for
packaging list, Air Freight Packing list and multi-piece Economy shipments.
maximum: 1
PackingListInfo_PackageAssociated:
type: object
maximum: 1
required:
- PackageNumber
- ProductAmount
properties:
PackageNumber:
description: Package number the product should be allocated to ont he packing
list. Required for packaging list and Air Freight Packing list.
maximum: 1
type: string
ProductAmount:
description: Amount of Product associated with a package. Required for
packaging list and Air Freight Packing list.
maximum: 1
type: string
ProductNote:
description: Product Note.
type: string
xml:
name: PackageAssociated
description: |-
Data Container holding package/product related information that will break up the product into each package on the packing list. Total product amount must equal the product unit value above. Required for packaging list and Air Freight Packing list. Packaging list max allowed : 20
Air Freight Packaging list max allowed: 200
Product_DDSReferenceNumber:
type: object
maximum: 1
properties:
Number:
description: holds a list of DDS Reference Numbers
maximum: 5
type: string
Product_EEIInformation:
type: object
maximum: 1
properties:
ExportInformation:
description: 'Required for EEI form id it is a SDL product. Valid values:
LC, LV, SS,MS, GS, DP, HR, UG, IC, SC, DD, HH, SR, TE,TL, IS, CR, GP,
RJ, TP, IP, IR, DB, CH, RS, OS Applies to EEI form only. Required if
EEIFilingOption code 3 specified for EEI form.'
maximum: 1
type: string
minLength: 2
maxLength: 2
License:
"$ref": "#/components/schemas/EEIInformation_License"
DDTCInformation:
"$ref": "#/components/schemas/EEIInformation_DDTCInformation"
xml:
name: EEIInformation
description: Required for EEI form. Applies to EEI form only.
EEIInformation_License:
type: object
maximum: 1
properties:
Number:
description: |-
Represents any one of the following values: export license number, exception code, CFR citation, KPC Number, ACM Number. Applies to EEI form only.
Refer to EEI License Types and Exemptions in the Appendix for valid values and formats.
maximum: 1
type: string
minLength: 7
maxLength: 13
Code:
description: "The standard license code published by US government. \nRefer
to EEI License Codes in the Appendix for valid values. Applies to EEI
form only. It is required for EEIFilingOption code 3. It is optionally
required for all other filing types; however, it is used to categorize
each product as SDL or non-SDL. It is also used to identify which piece
of information is applicable."
maximum: 1
type: string
minLength: 3
maxLength: 3
LicenseLineValue:
description: |-
The export monetary amount allowed per license. Required for a licensable product when the EEI form is selected.
Format: Whole numbers only. Applies to EEI form only. Required if EEIFilingOption code 1A (only for SDL shipments) or 3.
maximum: 1
type: string
minLength: 1
maxLength: 10
ECCNNumber:
description: 'Product ECCN Number issued by BIS (Bureau of Industry and
Security). If the license number is a commerce license, ECCN must be provided.
The format is #A### or EAR99 Applies to EEI forms only. It is required
for EEIFilingOption code 3. ECCN is required one of the following License
Exception Codes is entered: CIV, CTP, ENC, GBS, KMI, LVS, TSR'
maximum: 1
type: string
minLength: 5
maxLength: 5
xml:
name: License
description: Licence information for SDL commodity. Applies to EEI form only.
EEIInformation_DDTCInformation:
type: object
maximum: 1
properties:
ITARExemptionNumber:
description: "The specific citation (exemption number) under the International
Traffic in Arms Regulations (ITAR) from the Code of Federal Register (see
22 CFR 120-130) that exempts the shipment from the requirements for a
license or other written authorization from the Directorate of Trade Controls
(DDTC). \nRefer to EEI License Codes in the Appendix for valid values.
\ Applies to EEI Form only. This field is applicable for EEIFiling option
1A and 3."
maximum: 1
type: string
minLength: 3
maxLength: 10
USMLCategoryCode:
description: Digit numeric code (e.g. 01-18, 20 or 21). Indicates the U.S.
Munitions List (USML) category article, service or related technical data
as it applies to the article reported. Applies to EEI form only. It is
required for EEIFilingOption code 3.
maximum: 1
type: string
minLength: 2
maxLength: 2
EligiblePartyIndicator:
description: Presence/Absent indicator. Certification by the U.S. exporter
that the exporter is an eligible party to participate in the defense trade.
maximum: 1
type: string
RegistrationNumber:
description: It is a unique registration code assigned to the registrant.
The DDTC registration code consist of a letter prefix, M (assigned to
a manufacturer and/or exporter) or K (assigned to a broker), followed
by four or five digits (e.g. K-1234 or M12345). It is required for EEIFilingOption
code 3.
maximum: 1
type: string
minLength: 6
maxLength: 6
Quantity:
description: Export Quantity. Applies to EEI form only. It is required
for EEIFilingOption code 3. Only positive integer value is valid.
maximum: 1
type: string
minLength: 1
maxLength: 7
UnitOfMeasurement:
"$ref": "#/components/schemas/DDTCInformation_UnitOfMeasurement"
SignificantMilitaryEquipmentIndicator:
description: Presence/ Absence Indicator. Applies to EEI form only.
maximum: 1
type: string
ACMNumber:
description: Approved Community Member Number (ACM). It is required to be
provided along with ITARExemptionNumber for some License code (SGB and
SAU). The ACM# for the United Kingdom (License code SGB) must begin with
UK followed by 9 numbers. The ACM# for Australia (License Code SAU) must
begin with DTT followed by 8 numbers. Applies to EEI form only. It is
required for EEIFilingOption code 1A and 3.
maximum: 1
type: string
minLength: 11
maxLength: 11
xml:
name: DDTCInformation
description: Department of State/ Directorate of Defense Trade Control Information.
This element is a container for additional information that is applicable
to SDL products. It will only be evaluated if the provided license code is
an SDL code. Applies to EEI Form only.
DDTCInformation_UnitOfMeasurement:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: "Required for EEI form. Unit of measurement code. The two or three (3) alpha unit of measurement for the article being shipped. For example: BAG/BG - bags Applies to EEI form only. It is required for EEIFilingOption code 1A and 3."
type: string
Description:
description: Description for Unit of Measurement. Applies to EEI form only.
type: string
xml:
name: UnitOfMeasurement
description: Container for unit of measurement. Applies to EEI form only. It
is required for EEIFilingOption code 3.
InternationalForms_Discount:
type: object
maximum: 1
required:
- MonetaryValue
properties:
MonetaryValue:
description: "The discount to be subtracted from the sum of the total value on the invoice. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Valid characters are 0-9 and '.' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including '.' and can hold up to 2 decimal places. This value should be greater than or equal to zero or less than or equal to the value of all goods listed on the invoice."
maximum: 1
type: string
minLength: 1
maxLength: 15
xml:
name: Discount
description: Container tag that holds the discount. Applies to Invoice and
Partial Invoice forms only.
InternationalForms_FreightCharges:
type: object
maximum: 1
required:
- MonetaryValue
properties:
MonetaryValue:
description: "Cost to transport the shipment. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Valid characters are 0-9 and '.' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including '.' and can hold up to 2 decimal places."
maximum: 1
type: string
minLength: 1
maxLength: 15
xml:
name: FreightCharges
description: Container tag that holds the Freight Charges. Applies to Invoice
and Partial Invoice forms only.
InternationalForms_InsuranceCharges:
type: object
maximum: 1
required:
- MonetaryValue
properties:
MonetaryValue:
description: The amount the shipper or receiver pays to cover the cost of
replacing the shipment if it is lost or damaged. Applies to Invoice and
Partial Invoice forms only. Required for Invoice forms and optional for
Partial Invoice. Valid characters are 0-9 and '.' (Decimal point). Limit
to 2 digit after the decimal. The maximum length of the field is 15 including
'.' and can hold up to 2 decimal places.
maximum: 1
type: string
minLength: 1
maxLength: 15
xml:
name: InsuranceCharges
description: Container tag that holds the Insurance Charges. Applies to Invoice
and Partial Invoice forms only.
InternationalForms_OtherCharges:
type: object
maximum: 1
required:
- Description
- MonetaryValue
properties:
MonetaryValue:
description: "The Monetary value of Other Charges. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Valid characters are 0-9 and '.' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including '.' and can hold up to 2 decimal places."
maximum: 1
type: string
minLength: 1
maxLength: 15
Description:
description: Description of what the other charges are for. Applies to
Invoice and Partial Invoice forms only. Required for Complete Invoice
and Optional for Partial Invoice forms.
maximum: 1
type: string
minLength: 1
maxLength: 10
xml:
name: OtherCharges
description: Container tag that holds the information of amount that covers
additional charges not already listed on the invoice. Applies to Invoice
and Partial Invoice forms only.
InternationalForms_BlanketPeriod:
type: object
maximum: 1
required:
- EndDate
- BeginDate
properties:
BeginDate:
description: Begin date of the blanket period. It is the date upon which
the Certificate becomes applicable to the good covered by the blanket
Certificate (it may be prior to the date of signing this Certificate). Applies
to USMCA form only. Required for USMCA. Format is yyyyMMdd. This
is not valid for a paperless shipment.
maximum: 1
type: string
minLength: 8
maxLength: 8
EndDate:
description: End Date of the blanket period. It is the date upon which the
blanket period expires. Applies to USMCA form only. Required for USMCA
CO. Format is yyyyMMdd. This is not valid for a paperless shipment.
maximum: 1
type: string
minLength: 8
maxLength: 8
xml:
name: BlanketPeriod
description: This field should be entered if the USMCA Certificate covers multiple
shipments of identical goods as described in the Description of Goods field
that are imported into a USMCA country or territory for a specified period
of up to one year (the blanket period). The importation of a good for which
preferential treatment is claimed based on this certificate must occur between
these dates. Applies to USMCA form only. Required for USMCA. This
is not valid for a paperless shipment.
ShipmentServiceOptions_DeliveryConfirmation:
type: object
maximum: 1
required:
- DCISType
properties:
DCISType:
description: "Type of delivery confirmation. Valid values: \n1 - Delivery
Confirmation Signature Required\n2 - Delivery Confirmation Adult Signature
Required. Valid for forward shipments only."
maximum: 1
type: string
minLength: 1
maxLength: 1
DCISNumber:
description: DCIS Number.
maximum: 1
type: string
minLength: 1
maxLength: 11
xml:
name: DeliveryConfirmation
description: |-
Delivery Confirmation container. Valid for forward shipments only.
Refer to Delivery Confirmation Origin-Destination Pairs in the Appendix for a list of valid values.
ShipmentServiceOptions_LabelMethod:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |-
Valid LabelMethod types are:
01 = ImportControl Print and Mail
02 = 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: LabelMethod description.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: LabelMethod
description: Type of ImportControl Label. This container is applicable only
for ImportControl shipments. This container is applicable only for ImportControl
shipments.
ShipmentServiceOptions_PreAlertNotification:
type: object
properties:
EMailMessage:
"$ref": "#/components/schemas/PreAlertNotification_EMailMessage"
VoiceMessage:
"$ref": "#/components/schemas/PreAlertNotification_VoiceMessage"
TextMessage:
"$ref": "#/components/schemas/PreAlertNotification_TextMessage"
Locale:
"$ref": "#/components/schemas/PreAlertNotification_Locale"
xml:
name: PreAlertNotification
required:
- Locale
description: This container is used for providing Pre-Alert Notifications to
the consignee for UPS Exchange movements and Pack & Collect shipments.
PreAlertNotification_EMailMessage:
type: object
maximum: 1
required:
- EMailAddress
properties:
EMailAddress:
description: EMailAddress where PreAlertNotification is sent.
maximum: 1
type: string
minLength: 1
maxLength: 50
UndeliverableEMailAddress:
description: This is used for notification when EMailAddress for PreAlertNotification
is undeliverable.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: EMailMessage
description: This container is used for Populating EMailMessage details for
PreAlertNotification.
PreAlertNotification_VoiceMessage:
type: object
maximum: 1
required:
- PhoneNumber
properties:
PhoneNumber:
description: |
Phone number for receiving Voice PreAlertNotification. Valid values are 0 – 9.
If the country or territory of the message recipient is US, PR, CA, and VI, the layout is:
1, area code, 7 digit phone number or
1, area code, 7 digit phone number, 4 digit extension number.
For other countries or territories, the layout is country or territory code, area code, 7 digit number.
maximum: 1
type: string
minLength: 1
maxLength: 15
xml:
name: VoiceMessage
description: VoiceMessage container is used for specifying phone number for
receiving voice PreAlertNotification.
PreAlertNotification_TextMessage:
type: object
maximum: 1
required:
- PhoneNumber
properties:
PhoneNumber:
description: |
Phone number for receiving Voice PreAlertNotification. Valid values are 0 – 9.
If the country or territory of the message recipient is US, PR, CA, and VI, the layout is:
1, area code, 7 digit phone number or
1, area code, 7 digit phone number, 4 digit extension number.
For other countries or territories, the layout is country or territory code, area code, 7 digit number.
maximum: 1
type: string
minLength: 1
maxLength: 15
xml:
name: TextMessage
description: TextMessage container is used for specifying phone number for receiving
text preAlertNotification.
PreAlertNotification_Locale:
type: object
maximum: 1
required:
- Language
- Dialect
properties:
Language:
description: Refer to Language/Dialect Combinations in the Appendix for
valid pairs.
maximum: 1
type: string
minLength: 1
maxLength: 3
Dialect:
description: Refer to Language/Dialect Combinations in the Appendix for
valid pairs.
maximum: 1
type: string
minLength: 1
maxLength: 2
xml:
name: Locale
description: This container is used for providing Language and dialect details
for PreAlertNotification.
ShipmentServiceOptions_RestrictedArticles:
type: object
maximum: 1
properties:
DiagnosticSpecimensIndicator:
description: This field is a flag to indicate if the package has Biological
substances. True if present; false otherwise. Shippers account needs
to have a valid contract for Biological Substances. Lane check will happen
based on postal code/ city.
maximum: 1
type: string
AlcoholicBeveragesIndicator:
description: Presence/Absence Indicator. True if present; false otherwise.
Any value is ignored. If present, indicates that the package contains
Alcoholic Beverages Shippers account needs to have a valid contract for
Alcohol.
maximum: 1
type: string
PerishablesIndicator:
description: Presence/Absence Indicator. True if present; false otherwise.
Any value is ignored. If present, indicates that the package contains
Perishable items. Shippers account needs to have a valid contract for
Perishables.
maximum: 1
type: string
PlantsIndicator:
description: Presence/Absence Indicator. True if present; false otherwise.
Any value is ignored. If present, indicates that the package contains
Plants Shippers account needs to have a valid contract for Plants.
maximum: 1
type: string
SeedsIndicator:
description: Presence/Absence Indicator. True if present; false otherwise.
Any value is ignored. If present, indicates that the package contains
Seeds. Shippers account needs to have a valid contract for Seeds.
maximum: 1
type: string
SpecialExceptionsIndicator:
description: Presence/Absence Indicator. True if present; false otherwise.
Any value is ignored. If present, indicates that the package contains
Special Exception items. Shippers account needs to have a valid contract
for Special Exceptions.
maximum: 1
type: string
TobaccoIndicator:
description: Presence/Absence Indicator. True if present; false otherwise.
Any value is ignored. If present, indicates that the package contains
Tobacco Shippers account needs to have a valid contract for Tobacco.
maximum: 1
type: string
ECigarettesIndicator:
description: Presence/Absence Indicator. True if present; false otherwise. Any
value is ignored. If present, indicates that the package contains
Ecigarettes Shippers account needs to have a valid contract for
Ecigarettes.
maximum: 1
type: string
xml:
name: RestrictedArticles
description: Restricted Articles container.
ShipmentServiceOptions_VerifiedDelivery:
type: object
maximum: 1
required:
- SecurePINType
- TokenValue
- RecipientEmail
properties:
SecurePINType:
description: Specifies the type of Secure PIN. Valid value is 2, which represents VDS (Shipper Generated PIN). This field is required.
required: SecurePINType
maximum: 1
type: string
minLength: 1
maxLength: 1
TokenValue:
description: This field is required and must contain a 32-character hexadecimal string, using only the characters 0-9 and A-F (case-insensitive).
maximum: 1
type: string
minLength: 32
maxLength: 32
RecipientEmail:
description: Specifies the recipient's email address for delivery notifications. This field is required.
maximum: 1
type: string
minLength: 1
maxLength: 50
RecipientPhone:
description: Recipient phone number for notifications. Valid characters are digits (0-9) only. This field is optional.
maximum: 1
type: string
minLength: 1
maxLength: 15
xml:
name: VerifiedDelivery
description: Protected Delivery container required for Secure Pin Delivery. Protected Delivery will offer shippers extra security to ensure their packages are delivered to the intended recipient.
Shipment_Package:
type: object
maximum: 1
properties:
Description:
description: Merchandise description of package. Required for shipment
with return service.
maximum: 1
type: string
minLength: 1
maxLength: 35
PalletDescription:
description: Description of articles & special marks. Applicable for Air
Freight only
maximum: 1
type: string
minLength: 1
maxLength: 150
NumOfPieces:
description: Number of Pieces. Applicable for Air Freight only
maximum: 1
type: string
minLength: 1
maxLength: 5
UnitPrice:
description: "Unit price of the commodity. Applicable for Air Freight only Limit to 2 digit after the decimal. The maximum length of the field is 12 including '.' and can hold up to 2 decimal place. (e.g. 999999999.99)"
maximum: 1
type: string
minLength: 1
maxLength: 12
Packaging:
"$ref": "#/components/schemas/Package_Packaging"
Dimensions:
"$ref": "#/components/schemas/Package_Dimensions"
DimWeight:
"$ref": "#/components/schemas/Package_DimWeight"
PackageWeight:
"$ref": "#/components/schemas/Package_PackageWeight"
LargePackageIndicator:
description: |-
Presence of the indicator mentions that the package is Large Package.
This is an empty tag, any value inside is ignored.
maximum: 1
type: string
OversizeIndicator:
description: Presence/Absence Indicator. Any value is ignored. If present, indicates that the package is over size. Applicable for UPS Worldwide Economy DDU service.
maximum: 1
type: string
MinimumBillableWeightIndicator:
description: Presence/Absence Indicator. Any value is ignored. If present, indicates that the package is qualified for minimum billable weight. Applicable for UPS Worldwide Economy DDU service.
maximum: 1
type: string
ReferenceNumber:
type: array
maximum: 5
items:
"$ref": "#/components/schemas/Package_ReferenceNumber"
AdditionalHandlingIndicator:
description: Additional Handling Required. The presence indicates additional
handling is required, the absence indicates no additional handling is
required. Additional Handling indicator indicates it's a non-corrugated
package.
maximum: 1
type: string
SimpleRate:
"$ref": "#/components/schemas/Package_SimpleRate"
UPSPremier:
"$ref": "#/components/schemas/Package_UPSPremier"
PackageServiceOptions:
"$ref": "#/components/schemas/Package_PackageServiceOptions"
Commodity:
"$ref": "#/components/schemas/Package_Commodity"
HazMatPackageInformation:
"$ref": "#/components/schemas/Package_HazMatPackageInformation"
xml:
name: Package
required:
- Packaging
description: Package Information container. For Return Shipments up to
20 packages are allowed. US/PR origin return movements are limited
to only one package. For Mail Innovations and Simple Rate shipments only one
package is allowed.
Shipment_TradeDirect:
type: object
required:
- CurrencyCode
- ShipmentType
properties:
Master:
$ref: '#/components/schemas/TradeDirect_Master'
Child:
$ref: '#/components/schemas/TradeDirect_Child'
GeneralDescriptionOfGoods:
description: General description of the goods being shipped. It is required for master shipment.
pattern: ^(?!\s*$)[a-zA-Z0-9 ]+$
type: string
ShipmentType:
description: |
Consolidated shipment types.
Valid values:
- TRADEDIRECTAIR = TradeDirect Air - consolidation, custom clearance, deconsolidation and delivery to multiple addresses
within destination country, with Airport-to-door or door-to-door.
- TRADEDIRECTOCEAN = TradeDirect Ocean - consolidation, ocean transportation, customs clearance, deconsolidation and delivery
to multiple addresses within a destination country, with port-to-door and door-to-door service from shipper to consignee. Available from more than 70 ports.
- TRADEDIRECTCROSSBORDER = TradeDirect CrossBoarder - consolidation, customs clearance, deconsolidation and delivery to multiple addresses
within the destination country, with door-to-door service across North American borders.
enum: ["TRADEDIRECTAIR", "TRADEDIRECTOCEAN", "TRADEDIRECTCROSSBORDER"]
type: string
CurrencyCode:
description: The currency code for the shipment as per ISO 4217.
type: string
pattern: ^(?!\s*$)[A-Z]{3}$
xml:
name: TradeDirect
maximum: 1
description: A UPS product that enables customers to ship directly from a manufacturer to end consumers in a different country.
TradeDirect_Master:
type: object
maximum: 1
required:
- UomType
properties:
SoldToSameAsShipTo:
description: If Present indicates the Sold to and Ship To are the same.
maximum: 1
type: string
SoldTo:
$ref: '#/components/schemas/Master_SoldTo'
Pickup:
$ref: '#/components/schemas/Master_Pickup'
TradeComplianceDetails:
$ref: '#/components/schemas/Master_TradeComplianceDetails'
UomType:
description: |
The type of measurement used for the shipment. Imperial(lbs, in) & Metric(kgs, cm)
Valid values are:
- Imperial = This system of measurement uses units such as pounds (lbs) for weight and inches (in) for length.
- Metric = This system of measurement uses units such as kilograms (kgs) for weight and centimeters (cm) for length.
type: string
example: Imperial
enum : ["Imperial", "Metric"]
NotificationBeforeDelivery:
$ref: '#/components/schemas/TradeDirect_NotificationBeforeDelivery'
xml:
name: Master
description: A collection of small package and LTL/TL shipments that are transported by UPS from the customer to the destination CFS.
Master_SoldTo:
type: object
maximum: 1
required:
- Address
- Name
- EmailAddress
properties:
Name:
description: Master Sold To Company Name.
maximum: 1
type: string
minLength: 1
maxLength: 35
pattern: ^(?!\s*$).{1,35}$
AttentionName:
description: Master Sold to Contact Name.
maximum: 1
type: string
minLength: 1
maxLength: 35
pattern: ^.{0,35}$
TaxIdentificationNumber:
deprecated: true
description: Master Sold To Tax Identification Number. This element has been deprecated, replacement can be found in the GlobalTaxInformation container.
maximum: 1
type: string
minLength: 1
maxLength: 15
Phone:
$ref: '#/components/schemas/TradeDirect_Phone'
Option:
description: "The text associated with the code will be printed in the sold to section of the USMCA form. The values indicate the following: 01 – Unknown. Applies to USMCA form. Possible Values are 01 and 02."
maximum: 1
type: string
minLength: 2
maxLength: 2
Address:
$ref: '#/components/schemas/TradeDirect_Address'
EmailAddress:
description: Master Sold To Email Address.
maximum: 1
type: string
minLength: 1
maxLength: 50
AccountNumber:
description: Master Sold To Account Number.
maximum: 1
type: string
minLength: 1
maxLength: 6
xml:
name: SoldTo
description: 'Contains the address and contact details of the shipments.'
Master_Pickup:
type: object
maximum: 1
required:
- Name
- Address
- EMailAddress
properties:
Name:
description: Master Pickup Company Name.
maximum: 1
type: string
minLength: 1
maxLength: 35
pattern: ^(?!\s*$).{1,35}$
AttentionName:
description: Master Pickup Contact Name.
maximum: 1
type: string
minLength: 1
maxLength: 35
pattern: ^.{0,35}$
Phone:
$ref: '#/components/schemas/TradeDirect_Phone'
Address:
$ref: '#/components/schemas/TradeDirect_Address'
EMailAddress:
description: Master Pickup Email Address
type: string
minLength: 1
maxLength: 50
xml:
name: Pickup
description: 'Contains the address and contact details of the shipments.'
TradeDirect_Phone:
type: object
maximum: 1
required:
- Number
properties:
Number:
description: The phone number of the contact.
type: string
minimum: 0
maximum: 99999999999999
Extension:
description: The phone extension of the contact.
type: string
minimum: 0
maximum: 9999
xml:
name: Phone
description: 'Contains the phone details including the phone number and extension.'
TradeDirect_Address:
type: object
maximum: 1
required:
- AddressLine
- City
- CountryCode
properties:
AddressLine:
description: Primary address line includes street number and street name (when applicable).
maximum: 3
type: string
pattern: ^(?!\s*$).{1,35}$
example: 123 South Main St
City:
description: The name of the city for the address.
type: string
pattern: ^(?!\s*$).{1,35}$
example: Atlanta
StateProvinceCode:
description: |
The code for the state or province for the address. Required for US, Canada, and Vietnam (VN).
- For US or Canada, the value must be a valid US state or Canadian province code.
- For Vietnam (VN), the value must be a valid province code (for example, VN-44).
- If the country or territory is Ireland, the StateProvinceCode must contain the county.
type: string
pattern: ^[a-zA-Z]{2,5}$
example: GA
PostalCode:
description: The postal code for the address.
type: string
pattern: ^(?!.*\s.*\s)(?!.*-.*-)[A-Za-z0-9\s-]{2,10}$
example: 30022-1323
CountryCode:
description: The code for the country for the address
type: string
pattern: ^[A-Z]{2}$
example: US
xml:
name: Address
description: 'Contains the address details including street address, city, state or province code, postal code, and country code.'
Master_TradeComplianceDetails:
type: object
maximum: 1
properties:
TermsOfShipment:
description: |
The terms of sale for the invoice.
Valid values:
- CFR = Cost and Freight
- CIF = Cost Insurance and Freight
- CIP = Carriage and Insurance Paid
- CPT = Carriage Paid To
- DAF = Delivered at Frontier
- DAP = Delivered at Place
- DAT = Delivered at Terminal
- DDP = Delivery Duty Paid
- DDU = Delivery Duty Unpaid
- DEQ = Delivered Ex Quay
- DES = Delivered Ex Ship
- EXW = Ex Works
- FAS = Free Alongside Ship
- FCA = Free Carrier
- FOB = Free On Board
type: string
enum: ["CFR","CIF","CIP","CPT","DAF","DAP","DAT","DDP","DDU","DEQ","DES","EXW","FAS","FCA","FOB",]
example: FOB
ReasonForExport:
description: The reason for export to go on the invoice.
type: string
maxLength: 75
Comments:
description: Additional comments to be included on the invoice.
type: string
maxLength: 150
DeclarationStatement:
description: |
The type of declaration statement. Can be invoice or USMCA.
Valid values:
- Invoice = Invoice declaration
- USMCA = USMCA declaration
type: string
enum: ["Invoice", "USMCA"]
xml:
name: TradeComplianceDetails
description: 'Contains trade compliance details for the master shipment, such as invoice terms, export reasons, and declaration statements. It also includes additional comments or instructions for customs clearance.'
TradeDirect_Child:
type: object
maximum: 1
required:
- Product
- Type
- USI
- LtlPackage
properties:
USI:
description: 'The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments.'
type: string
pattern: ^(?:[0-9]{10}|[0-9]{9}T)$
example: 578299028T
HazMatIndicator:
description: Indicates the Presence/Absence of HazMat on the shipment.
maximum: 1
type: string
Type:
description: |
The type of shipment.
Valid values:
- LTL
- SMALLPACKAGE
- MI
type: string
enum: ["LTL", "SMALLPACKAGE", "MI"]
Product:
$ref: '#/components/schemas/Child_Product'
LtlPackage:
$ref: '#/components/schemas/Child_LTL_Package'
LtlCharges:
$ref: '#/components/schemas/Child_LTL_Charges'
xml:
name: Child
description: A small package or LTL/TL shipment associated with a Trade Direct Master.
Child_Product:
type: object
maximum: 100
required:
- UnitPrice
- Description
- NumberOfUnits
- UnitOfMeasure
- ProductNumber
- CountryOriginCode
properties:
Description:
description: Description of the product being shipped.
type: string
pattern: ^(?!\s*$)[a-zA-Z0-9 ]{1,100}$
example: ALPHA BRAIN INSTANT PEACH
UnitPrice:
description: Price per unit of the product being shipped.
type: string
example: 2
minimum: 0.01
NumberOfUnits:
description: Number of units of the product being shipped.
type: string
example: 3
minimum: 1
ProductNumber:
description: Product number of the product being shipped.
type: string
example: IDID767640
pattern: ^(?!\s*$)[a-zA-Z0-9 ]{1,20}$
CountryOriginCode:
description: Country code of the product being shipped.
type: string
pattern: ^[A-Z]{2}$
UnitOfMeasure:
description: |
Unit of Measure for the product being shipped.
Valid values are :
- BA = Barrel
- BE = Bundle
- BG = Bag
- BH = Bunch
- BOX = Box
- BT = Bolt
- LB = Pound
- LBS = Pounds
- L = Liter
- M = Meter
- NMB = Number
- PA = Packet
- BU = Butt
- CI = Canister
- CM = Centimeter
- CON = Container
- CR = Crate
- CS = Case
- CT = Carton
- CY = Cylinder
- DOZ = Dozen
- EA = Each
- EN = Envelope
- FT = Feet
- KG = Kilogram
- KGS = Kilograms
- PAL = Pallet
- PC = Piece
- PCS = Pieces
- PF = Proof Liters
- OTH = Other
- PKG = Package
- PR = Pair
- PRS = Pairs
- RL = Roll
- SET = Set
- SME = Square Meters
- SYD = Square Yards
- TU = Tube
- YD = Yard
type: string
enum: [ "BA", "BE", "BG", "BH", "BOX", "BT", "LB", "LBS", "L", "M", "NMB", "PA", "BU", "CI", "CM", "CON", "CR", "CS", "CT", "CY", "DOZ", "EA", "EN", "FT", "KG", "KGS", "PAL", "PC", "PCS", "PF", "OTH", "PKG", "PR", "PRS", "RL", "SET", "SME", "SYD", "TU", "YD" ]
CommodityCode:
description: '6-to-15-alphanumeric commodity code. Customs uses this code
to determine what duties should be assessed on the commodity. Applies
to Invoice, Partial Invoice and USMCA. Required for USMCA and optional
for Partial Invoice. Should be at least 6 alphanumeric. For USMCA:
For each good described in Description of Goods field, identify the H.S.
tariff classification to six digits. If the good is subject to a specific
rule of origin in Annex 401 that requires eight digits, identify to eight
digits, using the H.S. tariff classification of the country or territory
into whose territory the good is imported.'
maximum: 1
type: string
minLength: 6
maxLength: 15
JointProductionIndicator:
description: If present, JNT will be used as the origin of country or territory
code on the USMCA form and the Product/Origincountry or territoryCode
tag will be ignored. Applies to USMCA only.
maximum: 1
type: string
NetCostCode:
description: |
For each good described in the Description of Goods field, where the good is subject to a regional value content (RVC) requirement, indicate NC if the RVC is calculated according to the net cost method; otherwise, indicate NO. If the RVC is calculated over a period of time then indicate "NC with begin/end date" by passing code "ND" Applies to USMCA only. Required for USMCA. Valid values:
- NC
- ND
- NO
maximum: 1
type: string
minLength: 2
maxLength: 2
NetCostDateRange:
"$ref": "#/components/schemas/Product_NetCostDateRange"
PreferenceCriteria:
description: "Indicates the criterion (A through F) for each good described
in the Description of Goods field if applicable. \n\nThe rules of origin
are contained in Chapter Four and Annex 401. \n\nAdditional rules are
described in Annex 703.2 (certain agricultural goods), Annex 300-B, Appendix
6 (certain textile goods) and Annex 308.1 (certain automatic data processing
goods and their parts). Applies to USMCA only."
maximum: 1
type: string
minLength: 1
maxLength: 1
ProducerInfo:
description: "Indicate the following: Yes - If shipper is the producer
of the good. If not, state 02, 03, and 04 depending on whether this certificate
was based upon: \nNo [1] - Knowledge of whether the good qualifies as
an originating good. \nNo [2] - Reliance on the producers written representation
(other than a Certificate of Origin) that the good qualifies as an originating
good. \nNo [3] - A completed and signed Certificate for the good voluntarily
provided to the exporter by the producer. Applicable for USMCA and
is required. Valid values: Yes, No [1], No [2], and No [3]."
maximum: 1
type: string
minLength: 3
maxLength: 5
MarksAndNumbers:
description: Any special marks, codes, and numbers that may appear on package. Applies
to CO Only.
maximum: 1
type: string
minLength: 1
maxLength: 35
NumberOfPackagesPerCommodity:
description: The total number of packages, cartons, or containers for the
commodity. Applicable for CO and is required. Should be numeric. Valid
characters are 0 -9.
maximum: 1
type: string
minLength: 1
maxLength: 3
ProductWeight:
"$ref": "#/components/schemas/Product_ProductWeight"
VehicleID:
description: 'Includes the following information for used self-propelled
vehicles as defined in Customs regulations 19 CFR 192.1: The unique Vehicle
Identification Number (VIN) in the proper format. Or The Product Identification
Number (PIN) for those used self-propelled vehicles for which there are
no VINs. Or the Vehicle Title Number. Applies to EEI forms only.'
maximum: 1
type: string
minLength: 1
maxLength: 25
ScheduleB:
"$ref": "#/components/schemas/Product_ScheduleB"
ExportType:
description: 'Code indicating Domestic: Exports that have been produced,
manufactured, or grown in the United States or Puerto Rico. This includes
imported merchandise which has been enhanced in value or changed from
the form in which imported by further manufacture or processing in the
United States or Puerto Rico. Foreign: Merchandise that has entered the
United States and is being exported again in the same condition as when
imported. Applies to EEI forms only. Required for EEI form. Valid values: D:
Domestic; F: Foreign.'
maximum: 1
type: string
minLength: 1
maxLength: 1
SEDTotalValue:
description: |
This amount will always be USD. Applies to EEI forms only. Required for EEI form. Valid characters are 0-9 and \'.\' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including \'.\' and can hold up to 2 decimal places.
Note: This value is calculated based on the Product/Unit/Value and /Product/Unit/Number (Number of Units * Price per Unit). If the total value is incorrect it will be replaced by the actual calculated total value.
maximum: 1
type: string
minLength: 1
maxLength: 15
TaxesPaid:
description: "Invoice Commodity Level Tax Collected Code for each shipment commodity line.Taxes paid Indicator is only applicable for shipments to Singapore. [TaxesPaid = 0 - No on Report], [TaxesPaid = 1 -Yes on Report], [TaxesPaid = empty - null on Report], [If TaxesPaid is not passed in input request = null on Report]"
type: string
ExcludeFromForm:
"$ref": "#/components/schemas/Product_ExcludeFromForm"
PackingListInfo:
"$ref": "#/components/schemas/Product_PackingListInfo"
EEIInformation:
"$ref": "#/components/schemas/Product_EEIInformation"
xml:
name: Product
description: This variable represents the product details. It is used to provide information about the product being shipped.
Child_LTL_Package:
type: object
maximum: 200
minimum: 1
required:
- NumberOfIdenticalUnits
- HandlingUnits
properties:
NumberOfIdenticalUnits:
description: Number of identical units in the package/ltl.
type: string
example: 1
minimum: 1
maximum: 200
HandlingUnits:
$ref: '#/components/schemas/LTL_Handling_Units'
ReferenceNumber:
$ref: '#/components/schemas/LTL_Reference_Number'
xml:
name: LtlPackage
description: 'LTL package information. Applicable only for LTL child.'
LTL_Handling_Units:
type: object
maximum: 1
required:
- Quantity
- Type
- FreightClass
- Dimensions
- PackageWeight
properties:
Quantity:
description: Quantity of handling units.
type: string
example: 1
minimum: 1
maximum: 999999999
Type:
description: Type of handling unit.
type: string
example: BOXES
enum: [ "BAGS", "BOXES", "CARTONS", "CRATES", "DRUMS", "PALLET_SKIDS", "ROLLS", "TUBES" ]
FreightClass:
description: |
Freight class of the handling unit.
Valid values are:
- 50 = over 50 lbs - Fits on standard shrink-wrapped 4X4 pallet, very durable
- 55 = 35-50 pounds - Bricks, cement, mortar, hardwood flooring
- 60 = 30-35 pounds - Car accessories & car parts
- 65 = 22.5-30 pounds - Car accessories & car parts, bottled beverages, books in boxes
- 70 = 15 to 22.5 pounds - Car accessories & car parts, food items, automobile engines
- 77.5 = 13.5 to 15 pounds - Tires, bathroom fixtures
- 85 = 12-13.5 pounds - Crated machinery, cast iron stoves
- 92.5 = 10.5-12 pounds - Computers, monitors, refrigerators
- 100 = 9-10.5 pounds - Boat covers, car covers, canvas, wine cases, caskets
- 110 = 8-9 pounds - Cabinets, framed artwork, table saw
- 125 = 7-8 pounds - Small Household appliances
- 150 = 6-7 pounds - Auto sheet metal parts, bookcases
- 175 = 5-6 pounds - Clothing, couches stuffed furniture
- 200 = 4-5 pounds - Auto sheet metal parts, aircraft parts, aluminum table, packaged mattresses
- 250 = 3-4 pounds - Bamboo furniture, mattress and box spring, plasma TV
- 300 = 2-3 pounds - Wood cabinets, tables, chairs setup, model boats
- 400 = 1-2 pounds - Deer antlers
- 500 = Less than 1 lbs - Bags of gold dust, ping pong balls
type: string
example: 150
enum: [ "50", "55", "60", "65", "70", "77.5", "85", "92.5", "100", "110", "125", "150", "175", "200", "250", "300", "400", "500" ]
Dimensions:
$ref: '#/components/schemas/LTL_Dimensions'
PackageWeight:
$ref: '#/components/schemas/LTL_Package_Weight_Type'
xml:
name: HandlingUnits
description: 'Used to provide information about the handling units in the package/ltl.'
LTL_Reference_Number:
type: object
maximum: 3
required:
- Value
- Code
properties:
Code:
description: |
Reference number code supplied by customer.
Valid values are:
- PO = Purchase Order Number
- REF = Reference Number
- INV = Invoice Number
type: string
example: PO
enum: [ "PO", "REF", "INV" ]
Value:
description: Reference number supplied by customer.
type: string
example: REF834950
xml:
name: ReferenceNumber
description: LTL Reference number.
LTL_Dimensions:
type: object
maximum: 1
required:
- Length
- Width
- UnitOfMeasurement
- Height
properties:
Length:
description: Length of the package/ltl.
type: string
example: 48
minimum: 0.01
maximum: 99.99
Width:
description: Width of the package/ltl.
type: string
example: 40
minimum: 0.01
maximum: 99.99
Height:
description: Height of the package/ltl.
type: string
example: 36
minimum: 0.01
maximum: 99.99
UnitOfMeasurement:
description: |
The code associated with unit of measurement. The requested code must be valid for the shipper country or territory.
Valid values are :
- IN = Inches
- CM = Centimeters
type: string
example: IN
enum: [ "IN", "CM" ]
xml:
name: Dimensions
description: 'Dimensions for the handling unit.'
LTL_Package_Weight_Type:
type: object
maximum: 1
required:
- Weight
- UnitOfMeasurement
properties:
Weight:
description: Weight of the package/ltl.
type: string
example: 10
minimum: 0.01
maximum: 99999.99
UnitOfMeasurement:
description: |
Unit of measurement of the weight.
Valid values are:
- KGS = Kilograms
- LBS = Pounds
type: string
example: KGS
enum: [ "KGS", "LBS" ]
xml:
name: PackageWeight
description: 'Weight for the handling unit.'
Child_LTL_Charges:
type: object
maximum: 1
properties:
Discount:
description: The monetary value of the discount/rebate charge.
type: string
maximum: 1000000
minimum: 0
pattern: ^[0-9]+(\.[0-9]{1,2})?$
FreightCharges:
description: Freight charges.
type: string
maximum: 1000000
minimum: 0
pattern: ^[0-9]+(\.[0-9]{1,2})?$
InsuranceCharges:
description: The monetary value of the insurance charge.
type: string
maximum: 1000000
minimum: 0
pattern: ^[0-9]+(\.[0-9]{1,2})?$
OtherCharges:
$ref: '#/components/schemas/LTL_Other_Charges'
xml:
name: LtlCharges
description: 'Represents transportation charges for child shipments categorized as "Less than Truck Load" (LTL), including freight, fuel surcharges, and accessorial fees. These charges are calculated based on shipment weight, volume, or distance. Applicable only for LTL child.'
LTL_Other_Charges:
type: object
maximum: 1
required:
- MonetaryValue
- ChargeDescription
properties:
MonetaryValue:
description: 'The amount the shipper or receiver pays to cover the cost associated with the LTL Charges.'
type: string
example: 2
maximum: 1000000
minimum: 0
pattern: ^[0-9]+(\.[0-9]{1,2})?$
ChargeDescription:
description: 'Description of what the other charges are for.'
type: string
example: Miscellaneous charge
pattern: ^(?!\s*$)[a-zA-Z0-9 ]{1,30}$
xml:
name: OtherCharges
description: 'Any other miscellaneous charges.'
TradeDirect_NotificationBeforeDelivery:
type: object
maximum: 1
required:
- EMailAddress
properties:
RequestType:
description: |
The type of notification request.
Valid values are:
- 001 = QV Ship Notification
- 002 = QV Delivery Notification
- 003 = QV Exception Notification
type: string
example: 6
enum: [ "001", "002", "003"]
MediaTypeCode:
description: |
The media type code for the notification.
Valid values are:
- 03 = Email
- 04 = Fax
type: string
example: 03
enum: ["03", "04" ]
Language:
description: The language for the notification.
type: string
example: ENG
pattern: ^[A-Z]{3}$
Dialect:
description: The dialect for the notification.
type: string
example: US
pattern: ^[A-Z0-9]{2}$
ShipFromCompanyName:
description: The name of the company for the ship from address.
type: string
maxLength: 35
CompanyName:
description: The name of the company for the notification.
type: string
maxLength: 35
Phone:
$ref: '#/components/schemas/TradeDirect_Phone'
SubjectLine:
description: Subject line for the notification.
type: string
maxLength: 75
Memo:
description: Memo for the notification.
type: string
maxLength: 150
Name:
description: The name of the contact person for the notification.
type: string
maxLength: 35
EMailAddress:
description: Email address to send notification to.
type: string
example: john@ups.com
minLength: 1
maxLength: 50
pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
AlternateEmailAddress:
description: Alternate email address for the notification.
type: string
example: john@ups.com
maxLength: 50
xml:
name: NotificationBeforeDelivery
description: 'Notification container for the before delivery notification.'
Package_Packaging:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: "Package types. Values are: \n01 = UPS Letter \n02 = Customer
Supplied Package \n03 = Tube \n04 = PAK \n21 = UPS Express Box \n24 =
UPS 25KG Box \n25 = UPS 10KG Box \n30 = Pallet \n2a = Small Express Box
\n2b = Medium Express Box \n2c = Large Express Box \n56 = Flats \n57 =
Parcels \n58 = BPM \n59 = First Class \n60 = Priority \n61 = Machineables
\n62 = Irregulars \n63 = Parcel Post \n64 = BPM Parcel\n 65 = Media Mail
\n66 = BPM Flat \n67 = Standard Flat. \nNote: Only packaging type code
02 is applicable to Ground Freight Pricing.\n Package type 24, or 25
is only allowed for shipment without return service. Packaging type must
be valid for all the following: ShipTo country or territory, ShipFrom
country or territory, a shipment going from ShipTo country or territory
to ShipFrom country or territory, all Accessorials at both the shipment
and package level, and the shipment service type. UPS will not accept
raw wood pallets and please refer the UPS packaging guidelines for pallets
on UPS.com."
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: Description of packaging type. Examples are letter, customer
supplied, express box.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: Packaging
description: Packaging container. Container for Packaging Type.
Package_Dimensions:
type: object
required:
- UnitOfMeasurement
- Length
- Height
- Width
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/Dimensions_UnitOfMeasurement"
Length:
description: Package length. Length must be the longest dimension of the container. Valid values are 0 to 108 IN and 0 to 270 CM.
maximum: 1
type: string
minLength: 1
maxLength: 3
Width:
description: Package width.
maximum: 1
type: string
minLength: 1
maxLength: 3
Height:
description: Package height.
maximum: 1
type: string
minLength: 1
maxLength: 3
xml:
name: Dimensions
maximum: 1
description: 'Dimensions information container. Note: Currently dimensions are
not applicable to Ground Freight Pricing. Length + 2*(Width + Height) must
be less than or equal to 165 IN or 330 CM. Required for Heavy Goods service.
Package Dimension will be ignored for Simple Rate'
Dimensions_UnitOfMeasurement:
type: object
description: UnitOfMeasurement container for dimensions.
properties:
Code:
description: "Package dimensions measurement code. Valid codes: IN = Inches
CM = Centimeters 00 = Metric Units Of Measurement 01 = English Units of
Measurement\tThe unit of measurement must be valid for the Shipper country
or territory. "
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: Description of the package dimensions measurement units.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: DimWeight
maximum: 1
Package_DimWeight:
type: object
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/DimWeight_UnitOfMeasurement"
Weight:
description: Actual package weight. Weight accepted for letters/envelopes.
maximum: 1
type: string
minLength: 6
maxLength: 6
xml:
name: DimWeight
maximum: 1
description: Dimensional weight of shipment. Please visit ups.com for rules
on calculating. There is one implied decimal place (e.g. 115 = 11.5). If
dimensions are provided, dimensional weight is ignored. For US/PR/CA shipments,
dimensional weight is ignored
DimWeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Code representing the unit of measure associated with the package weight.
Valid values:
- LBS = Pounds (default)
- KGS = Kilograms
maximum: 1
type: string
minLength: 1
maxLength: 3
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: Packages weight. Weight accepted for letters/envelopes. Only
average package weight is required for Ground Freight Pricing Shipment.
maximum: 1
type: string
minLength: 1
maxLength: 5
xml:
name: PackageWeight
maximum: 1
description: Container to hold package weight information. Package weight is
a required for Ground Freight Pricing shipments and Heavy Goods service. Package
Weight will be ignored for Simple Rate.
PackageWeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Package weight unit of measurement code.
Valid values:
- LBS = Pounds
- KGS = Kilograms
- OZS = Ounces
Unit of Measurement "OZS" is the only valid UOM for some of the Mail Innovations Forward and Worldwide Economy DDU Shipments.
Please refer to Appendix for more details regarding the valid combination of Mail Innovation Forward Shipment services, Package Type and Unit of Measurement.
maximum: 1
type: string
minLength: 1
maxLength: 3
Description:
description: Description of the unit of measurement for package weight.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: UnitOfMeasurement
description: Container to hold UnitOfMeasurement information for package weight.
Package_ReferenceNumber:
type: object
maximum: 1
properties:
BarCodeIndicator:
description: "If the indicator is present then the reference numbers value
will be bar coded on the label.\n\nThis is an empty tag, any value inside
is ignored.\n Only one shipment-level or package-level reference number
can be bar coded per shipment. \n\nIn order to barcode a reference number,
its value must be no longer than 14 alphanumeric characters or 24 numeric
characters and cannot contain spaces."
maximum: 1
type: string
Code:
description: "Reference number type code, for the entire shipment. The code
specifies the Reference name. \n\nRefer to the Reference Number Code table.
\ Valid if the origin/destination pair is US/US or PR/PR and character
should be alpha-numeric."
maximum: 1
type: string
minLength: 1
maxLength: 2
Value:
description: Customer supplied reference number. Valid if the origin/destination
pair is US/US or PR/PR.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ReferenceNumber
required:
- Value
description: |-
Package reference number information container. For Mail Innovation shipments, up to 3 reference numbers are supported. If 5 reference numbers are specified (CostCenter, PackageID, and 3 ReferenceNumbers) the 3 desigated by the ReferenceNumber container will not be visible on 4x6 label supported by the API. These additional reference numbers are only be visible on the 4x8 label..
For non-Mail Innovation shipments only the first 2 reference numbers will be visible on labels.
Required for Trade Direct shipments.
Package_SimpleRate:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
SimpleRate code. 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 description of the code above. Currently ignored if provided in the Request. Length is not validated.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: SimpleRate
description: SimpleRate Container
Package_UPSPremier:
type: object
maximum: 1
required:
- Category
- HandlingInstructions
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
SensorID:
description: SensorID is RFID for UPS Premier Silver. SensorID is MeshID
for UPS Premier Gold or UPS Premier Platinum Package.
maximum: 1
type: string
minLength: 1
maxLength: 50
HandlingInstructions:
type: array
items:
"$ref": "#/components/schemas/UPSPremier_HandlingInstructions"
xml:
name: UPSPremier
description: UPS Premier Container.
UPSPremier_HandlingInstructions:
type: object
required:
- Instruction
properties:
Instruction:
description: Handling Instruction for UPS Premier package. Please refer
Apendix UPS Premier Handling Instructions.
type: string
minLength: 3
maxLength: 3
xml:
name: HandlingInstructions
description: Handling Instruction Container.
maximum: 1
Package_PackageServiceOptions:
type: object
properties:
DeliveryConfirmation:
"$ref": "#/components/schemas/PackageServiceOptions_DeliveryConfirmation"
DeclaredValue:
"$ref": "#/components/schemas/PackageServiceOptions_DeclaredValue"
COD:
"$ref": "#/components/schemas/PackageServiceOptions_COD"
AccessPointCOD:
"$ref": "#/components/schemas/PackageServiceOptions_AccessPointCOD"
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
Notification:
"$ref": "#/components/schemas/PackageServiceOptions_Notification"
HazMat:
type: array
maximum: 3
items:
"$ref": "#/components/schemas/PackageServiceOptions_HazMat"
HazMatTypeCode:
description: |-
Field to be used when a shipment contains a HazMat. It will specify the existence of HazMat, and what type. Initially this will be used for UPS Ground saver and Mail Innovations 'USPS Limited Quantities HazMat' Shipments (but may be extended for other types of HazMat in the future).
Valid values are 01.
- USPS Limited Quantities HazMat - 01
maximum: 2
type: string
DryIce:
"$ref": "#/components/schemas/PackageServiceOptions_DryIce"
UPSPremiumCareIndicator:
description: |
An UPSPremiumCareIndicator indicates special handling is required for shipment having controlled substances. Empty Tag means indicator is present.
The UPSPremiumCareIndicator cannot be requested for package with Delivery Confirmation - Adult Signature Required and Delivery Confirmation- Signature Required.
UPSPremiumCareIndicator is valid for following Return services:
- Returns Exchange (available with a contract)
- Print Return Label
- Print and Mail
- Electronic Return Label
- Return Service Three Attempt
The UPSPremiumCareIndicator can be requested with following UPS services:
- UPS Express® Early
- UPS Express
- UPS Express Saver
- UPS Standard
- Valid only for Canada to Canada movements.
maximum: 1
type: string
ProactiveIndicator:
description: Presence/Absence Indicator. Any value is 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 Reponse.
maximum: 1
type: string
PackageIdentifier:
description: Identifies the package containing Dangerous Goods. Required
for Hazmat shipment if SubVersion is greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 5
ClinicalTrialsID:
description: Unique identifier for clinical trials
maximum: 1
type: string
minLength: 20
maxLength: 20
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
Healthcare:
"$ref": "#/components/schemas/PackageServiceOptions_Healthcare"
xml:
name: PackageServiceOptions
maximum: 1
description: Package Service Options container.
PackageServiceOptions_Healthcare:
type: object
description: This container is required when HealthcareIdentifier is present, grouping all healthcare fields for a package. Maximum 25 allowed.
maxItems: 25
properties:
ProgramIdentifier:
description: |
An indicator to identify the healthcare program. Default value is 000.
Valid values:
- 000 = No Program
- 001 = Home Health / Direct to Patient
- 002 = Tissues, Organs, and Lab Specimens
- 003 = Investigative Drug Substance and Drug Product
- 004 = Specialty Drug Product and API
- 006 = Implantable Medical devices
- 007 = Medical Diagnostics Equipment
- 008 = Non-Sterile Pharmaceutical Drug Product and Substance
- 009 = Medical Inst. & Supplies
- 010 = Animal Health Non-Drug
- 011 = Consumer Health Perishable
- 012 = Consumer Health Non Perishable
- 013 = Non-Complex
- 099 = UNCLASSIFIED
maximum: 1
type: string
minLength: 3
maxLength: 3
SubAttribute:
description: Description of Program.
maximum: 1
type: string
minLength: 1
maxLength: 25
UniqueIdentifier:
description: Unique Patient Identifier/Provider Identifier.
maximum: 1
type: string
minLength: 1
maxLength: 25
Text:
description: Field for future use.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: Healthcare
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
DCISNumber:
description: Delivery Confirmation Control number associated with the delivery
confirmation for the package. Valid for forward shipments only.
maximum: 1
type: string
minLength: 1
maxLength: 11
xml:
name: DeliveryConfirmation
description: "Delivery Confirmation container. \nRefer to Delivery Confirmation
Origin-\nDestination Pairs in the Appendix for a list of valid values. Valid
only for forward shipment only."
PackageServiceOptions_DeclaredValue:
type: object
properties:
Type:
"$ref": "#/components/schemas/DeclaredValue_Type"
CurrencyCode:
description: Declared value amount currency type. Defaults to the non-Euro
currency used in the shippers country or territory. Code must represent
a currency that is a valid for Shipper country or territory.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Declared value amount.
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: DeclaredValue
maximum: 1
required:
- CurrencyCode
- MonetaryValue
description: Container for Declared Value.
DeclaredValue_Type:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Declared value type. Valid values:
- 01=EVS
- 02=DVS
Defaults to 01 i.e. EVS if declared value type is not provided. The user cannot specify different type of declared value for the shipment. User can either have shipper declared value (DVS) or declared value (EVS) but not both at package level.
Note: The Shipper Declared Value is applicable for forward shipments when the billing option is freight collect or third party.
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: Declared value Description.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: Type
description: Container for Declared Value Type.
PackageServiceOptions_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/PackageServiceOptions_COD_CODAmount"
xml:
name: COD
description: Container for COD. Indicates COD is requested. Package level COD
is available for shipment without return service from US/PR to US/PR, CA to
CA, and CA to US. CA to US COD is not allowed for package Letter/ Envelope.
COD is not valid for return service movements.
PackageServiceOptions_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. Valid values: 0.01 USD to 50000.00 USD"
maximum: 1
type: string
minLength: 5
maxLength: 5
xml:
name: CODAmount
description: COD Amount container.
PackageServiceOptions_AccessPointCOD:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Access Point COD Currency Code.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Access Point COD Monetary Value.
maximum: 1
type: string
minLength: 1
maxLength: 8
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 COD at package level.
PackageServiceOptions_Notification:
type: object
maximum: 1
required:
- NotificationCode
- EMail
properties:
NotificationCode:
description: "Notification Code. Valid values:\n3 - Receiver Return Notification\n6
- QV Email Notification\n7 - QV Exception Notification\n8 - QV Delivery
Notification \nFor Mail Innovations forward shipments, QV Email Notifications
are allowed for First Class, Priority Mail, and Expedited Mail Innovation
services."
maximum: 1
type: string
minLength: 1
maxLength: 1
EMail:
"$ref": "#/components/schemas/PackageServiceOptions_Notification_EMail"
xml:
name: Notification
description: Receiver Return Notification. Applicable for Shipment with returned
service.
PackageServiceOptions_Notification_EMail:
type: object
maximum: 1
required:
- EMailAddress
properties:
Subject:
description: The eMails subject. Defaults to the UPS Receiver Return Notification plus the shipment ID. Only allowed at the first package.
type: string
maximum: 1
minLength: 1
maxLength: 75
SubjectCode:
description: |
Specifies a reference code and reference number to display in the subject of the Receiver Return Notification.
When the subject code is provided, the subject will contain the following: UPS Receiver Return Notification.
The reference code (the reference code will be mapped to the corresponding ANSI value) Plus the reference number.
The valid subject codes are:
- 01 - Shipment Reference Number 1,
- 02 - Shipment Reference Number 2,
- 03 - package Reference Number 1,
- 04 - package Reference Number 2,
- 05 - package Reference Number 3,
- 06 - package Reference Number 4,
- 07 - package Reference Number 5,
- 08 - Subject Text (Return Notification only).
If the subject code tag is not provided and the subject text is provided, the subject of the notification will be the subject text.
If the subject text is provided, and subject code tag exists, then the subject code value must be 08.
If the subject code is 08, the subject text must exist. If a subject code is provided that refers to a nonexistent reference number, the subject will default to the tracking number. Only allowed at the first package.
type: string
maximum: 1
minLength: 1
maxLength: 2
EMailAddress:
description: The destination email address of the receiver returns notification email.
type: array
maximum: 5
items:
type: string
minLength: 1
maxLength: 50
UndeliverableEMailAddress:
description: The e-mail address where an undeliverable email message is sent if the Receiver Return Notification email is undeliverable. Defaults to FromEMailAddress. Only allowed at the first package.
maximum: 1
type: string
minLength: 1
maxLength: 50
FromEMailAddress:
description: "The email address listed in the Reply To field of the message header, includes name and e-mail address of sender. The \"From\" field of the message header contains pkginfo@ups.com. Only allowed at the first package."
maximum: 1
type: string
minLength: 1
maxLength: 50
FromName:
description: The name the receiver return notification will appear to be from. Defaults to the Shipper Name. Only allowed at the first package.
maximum: 1
type: string
minLength: 1
maxLength: 35
Memo:
description: User defined text that will be included in the email. Only allowed at the first package.
maximum: 1
type: string
minLength: 1
maxLength: 150
xml:
name: EMail
description: Container for the e-mail message.
PackageServiceOptions_HazMat:
type: object
maximum: 1
properties:
PackagingTypeQuantity:
description: The number of pieces of the specific commodity. Required if
CommodityRegulatedLevelCode = LQ or FR. Valid values are 1 to 999.
maximum: 1
type: string
minLength: 1
maxLength: 3
RecordIdentifier1:
description: Reserved for future use.
maximum: 1
type: string
RecordIdentifier2:
description: Reserved for future use.
maximum: 1
type: string
RecordIdentifier3:
description: Reserved for future use.
maximum: 1
type: string
SubRiskClass:
description: |
Recommended 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).
maximum: 1
type: string
minLength: 7
maxLength: 7
aDRItemNumber:
description: The type of regulated good for an ADR package where ADR is
for Europe to Europe ground movement.
maximum: 1
type: string
minLength: 10
maxLength: 10
aDRPackingGroupLetter:
description: |
Required if the field applies to the material by regulation. Field input is Arabic numerals, output is Roman numerals. Will be shown in Roman Numerals. Valid values:
- "1" = "I",
- "2" = "II",
- "3" = "III",
- and blank.
maximum: 1
type: string
minLength: 1
maxLength: 1
TechnicalName:
description: The technical name (when required) for the specified commodity.
Recommended if CommodityRegulatedLevelCode = LQ or FR and if the field
applies to the material by regulation.
maximum: 1
type: string
minLength: 200
maxLength: 200
HazardLabelRequired:
description: "Defines the type of label that is required on the package
for the commodity. \n\nNot applicable if CommodityRegulatedLevelCode =
LR or EQ."
maximum: 1
type: string
minLength: 50
maxLength: 50
ClassDivisionNumber:
description: |
This is the hazard class associated to the specified commodity.
Required if CommodityRegulatedLevelCode is 'EQ', 'LQ' or 'FR'
maximum: 1
type: string
minLength: 1
maxLength: 7
ReferenceNumber:
description: Optional reference number. It will be displayed only on label.
maximum: 1
type: string
minLength: 1
maxLength: 15
Quantity:
description: Required if CommodityRegulatedLevelCode = EQ, LQ or FR. The
numerical value of the mass capacity of the regulated good. 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
"." (Decimal point) and can hold up to 1 decimal place.
maximum: 1
type: string
minLength: 1
maxLength: 5
UOM:
description: "Required if CommodityRegulatedLevelCode = LQ, EQ or FR. The
unit of measure used for the mass capacity of the regulated good. \n\nFor
Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce
etc."
maximum: 1
type: string
minLength: 1
maxLength: 10
PackagingType:
description: 'The type of package used to contain the regulated good. (Ex:
Fiberboard Box). Required if CommodityRegulatedLevelCode = LQ or FR. Ex.
FIBERBOARD BOX, WOOD(EN) BOX, PLASTIC JERRICAN, METAL BOX, STEEL DRUM,
OTHER, PLASTIC BOX, PLASTIC DRUM, STYROFOAM BOX, CYLINDERS, ENVIROTAINER,
PLYWOOD BOX, ALUMINUM DRUM, ALUMINUM CYLINDERS, PLASTIC PAIL, PLYWOOD
DRUM, FIBER DRUM, STEEL JERRICAN, ALUMINUM JERRICAN, STEEL BOX, CARTON,
ALUMINUM BOX'
maximum: 1
type: string
minLength: 1
maxLength: 255
IDNumber:
description: "This is the ID number (UN/NA/ID) for the specified commodity.
\nRequired if CommodityRegulatedLevelCode = LR, LQ or FR and if the field
applies to the material by regulation. \nUN/NA/ID Identification Number
assigned to the specified regulated good. (Include the UN/NA/ID as part
of the entry)."
maximum: 1
type: string
minLength: 1
maxLength: 6
ProperShippingName:
description: The Proper Shipping Name assigned by ADR, CFR or IATA. Required
if CommodityRegulatedLevelCode = LR, LQ or FR.
maximum: 1
type: string
minLength: 1
maxLength: 150
AdditionalDescription:
description: |
Additional remarks or special provision information. Recommended 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.
maximum: 1
type: string
minLength: 1
maxLength: 255
PackagingGroupType:
description: |-
This is the packing group category associated to the specified commodity. Recommended if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Must be shown in Roman Numerals.
Valid values:
I
II
III
blank
maximum: 1
type: string
minLength: 1
maxLength: 5
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.
maximum: 1
type: string
minLength: 1
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.
The following are restricted in the phone number period ".", dash "-", plus sign "+" and conventional parentheses "(" and ")", "EXT" or "OPT"
maximum: 1
type: string
minLength: 1
maxLength: 25
EmergencyContact:
description: The emergency information, contact name and/or contract 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.
maximum: 1
type: string
minLength: 1
maxLength: 35
ReportableQuantity:
description: Recommended if CommodityRegulatedLevelCode = LQ or FR and if
the field applies to the material by regulation. If reportable quantity
is met, 'RQ' should be entered.
maximum: 1
type: string
minLength: 1
maxLength: 2
RegulationSet:
description: "The Regulatory set associated with every regulated shipment.
It must be same across the shipment. \nValid values: \nADR = Europe to
Europe Ground Movement \nCFR = HazMat regulated by US Dept. of Transportation
within the U.S. or ground shipments to Canada \nIATA= Worldwide Air movement
\nTDG= Canada to Canada ground movement or Canada to U.S. standard movement.
\ Valid values are ADR, CFR, IATA and TDG.\nFor multiple Chemical Records
per package or multiple packages containing different RegulationSet, RegulationSet
of first Chemical Record would be considered for validating and rating
the entire shipment."
maximum: 1
type: string
minLength: 3
maxLength: 4
TransportationMode:
description: "Not applicable for ADR regulation set. Required for any other
regulation set. Declares that a package was prepared according to ground
passenger aircraft or cargo aircraft only. \nValid values: \nHighway=Highway
\nGround=Ground \nPAX=Passenger Aircraft \nPassenger Aircraft=Passenger
Aircraft \nCAO=Cargo Aircraft Only \nCargo Aircraft Only=Cargo Aircraft
Only Valid entries include: Highway, Ground, PAX, Passenger Aircraft,
CAO and Cargo Aircraft Only."
maximum: 1
type: string
minLength: 3
maxLength: 30
CommodityRegulatedLevelCode:
description: |-
Indicates the type of commodity - Fully Regulated (FR), Limited Quantity (LQ), Excepted Quantity (EQ) or Lightly Regulated (LR). Valid values are LR, FR, LQ and EQ.
Required for subversion 1701 or greater. LR and EQ are validated if subversion is 1701 or greater. FR, LQ will be validated if subversion is 1807 or greater
maximum: 1
type: string
minLength: 2
maxLength: 2
TransportCategory:
description: Transport Category. Valid values are 0 to 4.
maximum: 1
type: string
minLength: 1
maxLength: 1
TunnelRestrictionCode:
description: Defines what is restricted to pass through a tunnel.
maximum: 1
type: string
minLength: 1
maxLength: 10
ChemicalRecordIdentifier:
description: Identifies the Chemical Record. Required if SubVersion is
greater than or equal to 1701.
maximum: 1
type: string
minLength: 1
maxLength: 3
LocalTechnicalName:
description: Technical name in local language.
maximum: 1
type: string
minLength: 1
maxLength: 200
LocalProperShippingName:
description: Proper shipping name in local langauge.
maximum: 1
type: string
minLength: 1
maxLength: 150
xml:
name: HazMat
required:
- ProperShippingName
- 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 = HazMat
regulated by US Dept. of Transportation within the U.S. or ground shipments
to Canada, IATA = Worldwide Air movement, ADR = For EU‑domestic, Standard Service
shipments containing non‑hazmat dry ice, the regulation set must be ADR.
The following values are valid:IATA, CFR, 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.7 Lbs.
maximum: 1
type: string
xml:
name: DryIce
description: Container for Dry Ice. Maximum 1 Dry Ice is allowed. 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: Dry Ice Weight. 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.
type: string
xml:
name: DryIceWeight
maximum: 1
description: Container for Dry Ice weight.
DryIceWeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- 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 The following values are valid : 00, 01, KG, KGS, LBS.
type: string
Description:
description: Description for unit of measurement for Dry Ice Weight.
type: string
xml:
name: UnitOfMeasurement
description: Container for Unit of measurement for Dry Ice Weight.
DryIceWeight_Weight:
description: Dry Ice Weight. 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
Package_Commodity:
type: object
maximum: 1
required:
- FreightClass
properties:
FreightClass:
description: Freight Classification. Freight class partially determines
the freight rate for the article. Required for Ground Freight Pricing
Shipments only.
maximum: 1
type: string
minLength: 10
maxLength: 10
NMFC:
"$ref": "#/components/schemas/Commodity_NMFC"
xml:
name: Commodity
description: Container to hold the Commodity information. It is required if
the Ground Freight Pricing Shipment indicator is present in the request.
Commodity_NMFC:
type: object
maximum: 1
required:
- PrimeCode
properties:
PrimeCode:
description: Specifies the Commodity's NMFC prime code. Required if NMFC
Container is present.
maximum: 1
type: string
minLength: 4
maxLength: 6
SubCode:
description: Specifies the Commodity's NMFC sub code. Needs to be provided
when the SubCode associated with the PrimeCode is other than 00. UPS 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: Container to hold the NMFC codes.
Package_HazMatPackageInformation:
type: object
maximum: 1
properties:
AllPackedInOneIndicator:
description: Presence/Absence Indicator. Any value is ignored. Presence
indicates if multiple, different hazmat/chemicals are contained within
one box in a package When number of Hazmat containers in a package is
more than one, either AllPackedInOneIndicator or OverPackedIndicator is
needed
maximum: 1
type: string
OverPackedIndicator:
description: Presence/Absence Indicator. Any value is ignored. Presence
indicates that one or more hazmat/chemicals are in separate boxes in a
package. When number of Hazmat containers in a package is more than one,
either AllPackedInOneIndicator or OverPackedIndicator is needed
maximum: 1
type: string
QValue:
description: 'When a HazMat shipment specifies AllPackedInOneIndicator and
the regulation set for that shipment is IATA, Ship API must require the
shipment to specify a Q-Value with exactly one of the following values:
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
OuterPackagingType:
description: This field is used for the Outer Hazmat packaging type. Ex.
FIBERBOARD BOX, WOOD(EN) BOX, PLASTIC JERRICAN, METAL BOX, STEEL DRUM,
OTHER, PLASTIC BOX, PLASTIC DRUM, STYROFOAM BOX, CYLINDERS, ENVIROTAINER,
PLYWOOD BOX, ALUMINUM DRUM, ALUMINUM CYLINDERS, PLASTIC PAIL, PLYWOOD
DRUM, FIBER DRUM, STEEL JERRICAN, ALUMINUM JERRICAN, STEEL BOX, CARTON,
ALUMINUM BOX
maximum: 1
type: string
minLength: 1
maxLength: 255
xml:
name: HazMatPackageInformation
description: Required when number of hazmat containers in a package is greater
than 1. It indicates whether all the hazmat materials are kept in a single
box or multiple boxes. Required when number of hazmat container in a package
is greater than 1.
ShipmentRequest_LabelSpecification:
type: object
required:
- LabelImageFormat
- LabelStockSize
properties:
LabelImageFormat:
"$ref": "#/components/schemas/LabelSpecification_LabelImageFormat"
HTTPUserAgent:
description: Browser HTTPUserAgent String. This is the preferred way of
identifying GIF image type to be generated. Required if /ShipmentRequest/LabelSpecificationLabelSpecification/LabelImageFormat/Code
= Gif. Default to Mozilla/4.5 if this field is missing or has invalid
value.
maximum: 1
type: string
minLength: 1
maxLength: 64
LabelStockSize:
"$ref": "#/components/schemas/LabelSpecification_LabelStockSize"
Instruction:
type: array
items:
"$ref": "#/components/schemas/LabelSpecification_Instruction"
CharacterSet:
description: "Language character set expected on label.\nValid values:\ndan
= Danish (Latin-1)\nnld = Dutch (Latin-1)\nfin = Finnish (Latin-1)\nfra
= French (Latin-1)\ndeu = German (Latin-1)\nitl = Italian (Latin-1)\nnor
= Norwegian (Latin-1)\npol = Polish (Latin-2)\npor = Poruguese (Latin-1)\nspa
= Spanish (Latin-1) \nswe = Swedish (Latin-1) \nces = Czech (Latin-2)\nhun
= Hungarian (Latin-2)\nslk = Slovak (Latin-2)\nrus = Russian (Cyrillic)\ntur
= Turkish (Latin-5)\nron = Romanian (Latin-2)\nbul = Bulgarian (Latin-2)\nest
= Estonian (Latin-2)\nell = Greek (Latin-2)\nlav = Latvian (Latin-2)\nlit
= Lithuanian (Latin-2)\neng = English (Latin-1) Default is English (Latin-1)."
maximum: 1
type: string
minLength: 3
maxLength: 3
xml:
name: LabelSpecification
maximum: 1
description: Container used to define the properties required by the user to
print and/or display the UPS shipping label. Required for shipment without
return service or shipments with PRL return service. Required for Electronic
Return Label or Electronic Import Control Label shipments with SubVersion
greater than or equal to 1707.
LabelSpecification_LabelImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: Label print method code determines the format in which Labels
are to be generated. For EPL2 formatted Labels use EPL, for SPL formatted
Labels use SPL, for ZPL formatted Labels use ZPL and for image formats
use GIF. For shipments without return service the valid value is GIF,
ZPL, EPL and SPL. For shipments with PRL return service, the valid values
are EPL, ZPL, SPL and GIF. For UPS Premier Silver shipment only ZPL is
supported.
maximum: 1
type: string
minLength: 1
maxLength: 4
Description:
description: Description of the label image format code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: LabelImageFormat
description: LabelImageFormat Container.
LabelSpecification_LabelStockSize:
type: object
maximum: 1
required:
- Height
- Width
properties:
Height:
description: 'Height of the label image. For IN, use whole inches. For
EPL2, ZPL and SPL Labels. Only valid values are 6 or 8. Note: Label Image
will only scale up to 4 X 6, even when requesting 4 X 8.'
maximum: 1
type: string
minLength: 1
maxLength: 3
Width:
description: 'Width of the label image. For IN, use whole inches. For EPL2,
ZPL and SPL Labels. Valid value is 4. Note: Label Image will only scale
up to 4 X 6, even when requesting 4 X 8.'
maximum: 1
type: string
minLength: 1
maxLength: 3
xml:
name: LabelStockSize
description: Container for the EPL2, ZPL or SPL label size. Valid for EPL2,
ZPL and SPL Labels.
LabelSpecification_Instruction:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: 'For Exchange Forward Shipment, by default Label will have
Exchange Routing instruction Text as EXCHANGE-LIKE ITEM ONLY. If code
value is: 01- EXCHANGE-LIKE ITEM ONLY, 02- EXCHANGE-DRIVER INSTRUCTIONS
INSIDE.'
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: Description of the label Instruction code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: Instruction
description: Routing Instruction Container.
ShipmentRequest_ReceiptSpecification:
type: object
required:
- ImageFormat
properties:
ImageFormat:
"$ref": "#/components/schemas/ReceiptSpecification_ImageFormat"
xml:
name: ReceiptSpecification
description: Container used to allow the user to choose to print a thermal receipt.
maximum: 1
ReceiptSpecification_ImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: 'Print code that determines the receipt format. Valid Codes
are: EPL, SPL, ZPL and HTML.'
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description of the receipt format code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ImageFormat
description: ImageFormat Container.
ShipmentResponse:
type: object
required:
- Response
- ShipmentResults
properties:
Response:
"$ref": "#/components/schemas/ShipmentResponse_Response"
ShipmentResults:
"$ref": "#/components/schemas/ShipmentResponse_ShipmentResults"
xml:
name: ShipmentResponse
description: Shipment Response.
maximum: 1
ShipmentResponse_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"
TransactionReference:
"$ref": "#/components/schemas/Response_TransactionReference"
xml:
name: Response
description: Response container for Shipment response.
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.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ResponseStatus
description: Response status container.
Response_Alert:
type: object
maximum: 1
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_TransactionReference:
type: object
maximum: 1
properties:
CustomerContext:
description: The CustomerContext Information which will be echoed during
response.
maximum: 1
type: string
minLength: 1
maxLength: 512
xml:
name: TransactionReference
description: Transaction Reference Container.
ShipmentResponse_ShipmentResults:
type: object
properties:
Disclaimer:
description: |
Disclaimer would be used to provide more information to shipper regarding the processed shipment. This would be used to notify shipper about possible taxes and duties that might have been added or might apply to the shipment. This field would be returned only if TaxInformationIndicator is present in a 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/ShipmentResults_Disclaimer"
ShipmentCharges:
"$ref": "#/components/schemas/ShipmentResults_ShipmentCharges"
NegotiatedRateCharges:
"$ref": "#/components/schemas/ShipmentResults_NegotiatedRateCharges"
FRSShipmentData:
"$ref": "#/components/schemas/ShipmentResults_FRSShipmentData"
RatingMethod:
description: |-
RatingMethod is to indicate whether the Shipment was rated as shipment level or package level. This information will be returned only if RatingMethodRequestedIndicator is present in the request. Valid values:
01 = Shipment level
02 = Package level
maximum: 1
type: string
minLength: 2
maxLength: 2
BillableWeightCalculationMethod:
description: |-
BillableWeightCalculationMethod is to indicate whether the billable weight calculation method utilized was - the package level or shipment level. This information will be returned only if RatingMethodRequestedIndicator is present in the request. Valid values:
01 = Shipment Billable Weight
02 = Package Billable Weight
maximum: 1
type: string
minLength: 2
maxLength: 2
BillingWeight:
"$ref": "#/components/schemas/ShipmentResults_BillingWeight"
ShipmentIdentificationNumber:
description: Returned UPS shipment ID number.1Z Number of the first package
in the shipment.
maximum: 1
type: string
minLength: 18
maxLength: 18
MIDualReturnShipmentKey:
description: "MIDualReturnShipmentKey is unique key required to process
Mail Innovations Dual Return Shipment. \n\nThe unique identifier (key)
would be returned in response of first phase of Mail Innovations Dual
Return Shipments. \n\nThis unique identifier (key) would be part of request
for second phase of Mail Innovations Dual Return Shipments and would be
played back in response for second phase of Mail Innovations Dual Return
Shipment. If the shipment is a Package return shipment, the package tracking
number will be concatenated with the system time (in the format YYYY-MM-DDHH.MM.SS.NNN)
and followed by service code. \n\nIf the shipment is an MI Returns shipment,
the Mail Manifest ID (MMI) will be concatenated with the system time."
maximum: 1
type: string
minLength: 4
maxLength: 50
BarCodeImage:
description: Bar Code Image will be returned as Base 64 encoded graphic
image. Bar Code Image will be returned if BarCodeImageIndicator or BarCodeAndLabelIndicator
is present.
type: string
maximum: 1
PackageResults:
description: |
Returned Package Information.
**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/ShipmentResults_PackageResults"
ControlLogReceipt:
description: |
Container for the High Value reports when forward shipments have declared value between $999 and $50,000 USD. \nTwo copies of high value report needs to be pointed out.
**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/ShipmentResults_ControlLogReceipt"
Form:
"$ref": "#/components/schemas/ShipmentResults_Form"
CODTurnInPage:
"$ref": "#/components/schemas/ShipmentResults_CODTurnInPage"
HighValueReport:
"$ref": "#/components/schemas/ShipmentResults_HighValueReport"
LabelURL:
description: "URL will point to a page wherein label, receipt and other
documents, if applicable, such as HighValueReport, CustomsInvoice and
ImportControl instructions can be requested. LabelURL is returned only
if the LabelLinksIndicator is requested for following shipments:\nPrint/Electronic
ImportControl shipment\nPrint/Electronic Return shipment. \nForward shipment
except for Mail Innovations Forward."
maximum: 1
type: string
LocalLanguageLabelURL:
description: "URL will point to a page wherein label, receipt and other
documents, if applicable, such as HighValueReport, CustomsInvoice and
ImportControl instructions can be requested. LocalLanguageLabelURL is
returned only if the LabelLinksIndicator is requested for following shipments:\nPrint/Electronic
ImportControl shipment\nPrint/Electronic Return shipment. \nForward shipment
except for Mail Innovations Forward. Not returned if LabelLinksIndicator
is requested with Locale element."
maximum: 1
type: string
ReceiptURL:
description: |-
URL will point to a page wherein label, receipt and other documents, if applicable, such as HighValueReport, CustomsInvoice and ImportControl instructions can be requested. ReceiptURL is returned only if the LabelLinksIndicator is requested for following shipments:
Print/Electronic ImportControl shipment
Print/Electronic Return shipment.
maximum: 1
type: string
LocalLanguageReceiptURL:
description: |-
URL will point to a page wherein label, receipt and other documents, if applicable, such as HighValueReport, CustomsInvoice and ImportControl instructions can be requested. LocalLanguageReceiptURL is returned only if the LabelLinksIndicator is requested for following shipments:
Print/Electronic ImportControl shipment
Print/Electronic Return shipment. Not returned if LabelLinksIndicator is requested with Locale element.
maximum: 1
type: string
DGPaperImage:
description: |
Dangerous Good Paper Image in pdf format. One multipage PDF document will be returned that will contain all required Dangrous Goods shipping paper copies for all Dangerous Goods packages. Only returned when DGSignatoryInfo is present.
**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.
items:
type: string
type: array
MasterCartonID:
description: Master Carton ID. MasterCartonID will be return if MasterCartonIndicator
is present in request.
maximum: 1
type: string
minLength: 1
maxLength: 24
RoarRatedIndicator:
description: Informational only
type: string
GCCN:
description: Global Consolidation Carton Number
type: string
USI:
description: The unique shipment identifier (USI) is used to create Master, LTL and Child shipments. Used for Freight shipments.
type: string
pattern: ^(?:[0-9]{10}|[0-9]{9}T)$
example: 578299028T
Message:
description: A message indicating the status or result of the operation.
type: string
SubProNumber:
description: The sub PRO number associated with the LTL shipment.
type: string
PalletLabel:
"$ref": "#/components/schemas/ShipmentResults_PalletLabel"
BillOfLading:
description: Base64-encoded image data.
type: string
xml:
name: ShipmentResults
maximum: 1
required:
- BillingWeight
description: Shipment Results container.
ShipmentResults_PalletLabel:
type: object
properties:
PalletLabel:
description: Base64-encoded graphic image of Pallet.
type: string
xml:
name: PalletLabel
ShipmentResults_Disclaimer:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: Code representing type of Disclaimer. Refer to Disclaimer
Codes and Messages in the Appendix for various disclaimers that would
be possible for a given shipment.
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: |-
Disclaimer description. This field would be returned only if TaxInformationIndicator is present in a request.
Refer to Disclaimer Codes and Messages in the Appendix for various disclaimers that would be possible for a given shipment.
maximum: 1
type: string
xml:
name: Disclaimer
ShipmentResults_ShipmentCharges:
type: object
maximum: 1
properties:
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
BaseServiceCharge:
"$ref": "#/components/schemas/ShipmentCharges_BaseServiceCharge"
TransportationCharges:
"$ref": "#/components/schemas/ShipmentCharges_TransportationCharges"
ItemizedCharges:
description: |
Itemized Charges are returned only when the Subversion element is present and 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/ShipmentCharges_ItemizedCharges"
ServiceOptionsCharges:
"$ref": "#/components/schemas/ShipmentCharges_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/ShipmentCharges_TaxCharges"
TotalCharges:
"$ref": "#/components/schemas/ShipmentCharges_TotalCharges"
TotalChargesWithTaxes:
"$ref": "#/components/schemas/ShipmentCharges_TotalChargesWithTaxes"
xml:
name: ShipmentCharges
required:
- TotalCharges
- ServiceOptionsCharges
- TransportationCharges
description: Shipment charges Container. Shipment charges info.
ShipmentCharges_BaseServiceCharge:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: BaseServiceCharge currency code type. The currency code used
in the Shipment request is returned.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Base Service Charge value amount. Valid values are from 0
to 99999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: BaseServiceCharge
description: |-
Base Service Charge container.
Transportation charge = BaseServiceCharge + Fuel charge Returned only if Subversion >=1701.
ShipmentCharges_TransportationCharges:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Transportation charges currency code type. The currency code
used in the Shipment request is returned.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Transportation and surcharges value amount. Valid values are
from 0 to 99999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: TransportationCharges
description: Transportation Charges container.
ShipmentCharges_ItemizedCharges:
type: object
maximum: 1
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: Itemized Charges currency code type. The currency code used in the Shipment request is returned.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Itemized Charges value amount. Valid values are from 0 to 99999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
SubType:
description: The sub-type of ItemizedCharges type.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: ItemizedCharges
ShipmentCharges_ServiceOptionsCharges:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Accessorial charges currency code type. The currency code used in the Shipment request is returned.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Accessorial charges value amount. Valid values are from 0 to 99999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: ServiceOptionsCharges
description: Service Option Charges container.
ShipmentCharges_TaxCharges:
type: object
maximum: 1
required:
- Type
- MonetaryValue
properties:
Type:
description: Tax Type code. The code represents the type of Tax applied
to a shipment. Refer to Tax Type Values/Abbreviations in the Appendix
for valid values.
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
ShipmentCharges_TotalCharges:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Total charges currency code type. The currency code used in
the Shipment request is returned.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Total charges value amount. Valid values are from 0 to 99999999999999.99.
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: TotalCharges
description: Total charges container.
ShipmentCharges_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.
ShipmentResults_NegotiatedRateCharges:
type: object
properties:
ItemizedCharges:
description: |
Itemized Charges are returned only when the Subversion element is present and greater than or equal to 1601.
Negotiated itemized charges are only returned for certain contract-only shipments as well as Worldwide Express Freight, Ground Freight Pricing, and Hazmat movements.
**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"
RateModifier:
type: array
items:
"$ref": "#/components/schemas/NegotiatedRateCharges_RateModifier"
TotalChargesWithTaxes:
"$ref": "#/components/schemas/NegotiatedRateCharges_TotalChargesWithTaxes"
xml:
name: NegotiatedRateCharges
description: Negotiated Rates Charge 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_ItemizedCharges:
type: object
maximum: 1
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: Itemized Charges currency code type. The currency code used in the Shipment request is returned.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Itemized Charges value amount. Valid values are from 0 to 99999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
SubType:
description: The sub-type of ItemizedCharges type.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: ItemizedCharges
NegotiatedRateCharges_TaxCharges:
type: object
maximum: 1
required:
- Type
- MonetaryValue
properties:
Type:
description: Tax Type code. The code represents the type of Tax applied
to a shipment. Refer to Tax Type Values/Abbreviations in the Appendix
for valid values.
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
NegotiatedRateCharges_TotalCharge:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Total charges currency code.
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: TotalCharge
description: Total charges container. Account Based Rates info. Total charges
are only returned for ABR eligible shipper account/UserId combinations when
the user includes the NegotiatedRatesIndicator in the request.
NegotiatedRateCharges_RateModifier:
type: object
maximum: 1
required:
- Amount
- ModifierDesc
- ModifierType
properties:
ModifierType:
description: >-
Rate Modifier Type .
Example- "ORM" Applies if SubVersion is 2407 or greater and
supports only for oAuth shipments.
maximum: 1
type: string
minLength: 3
maxLength: 3
ModifierDesc:
description: >-
Rate Modifier Description .
Example- "Origin Modifier" Applies if SubVersion is 2407 or greater
and supports only for oAuth shipments.
maximum: 1
type: string
minLength: 50
maxLength: 50
Amount:
description: >-
Amount .
Example- "-1.00","0.25"
It contains positive or negative values. Applies if SubVersion is
2407 or greater and supports only for oAuth shipments.
maximum: 1
type: string
minLength: 16
maxLength: 16
xml:
name: RateModifier
description: >-
Container for returned Rate Modifier information. Applies if SubVersion
is 2407 or greater and supports only for oAuth shipments.
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.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: TotalChargesWithTaxes monetary value amount. Valid values
are from 0 to 9999999999999999.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. TotalChargesWithTaxes contains total charges including
total taxes applied to a shipment.
ShipmentResults_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: Ground Freight Pricing Shipment data container. Ground Freight
Pricing shipment data is only guaranteed to be returned for Ground Freight
Pricing shipments 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: It indicates the shipment level discount percentage for transportation
charges.
maximum: 1
type: string
minLength: 1
maxLength: 5
NetCharge:
"$ref": "#/components/schemas/TransportationCharges_NetCharge"
xml:
name: TransportationCharges
maximum: 1
description: Transportation charges container. Ground Freight Pricing transportation
charges. These are only returned for Ground Freight Pricing enabled shipper
account number when the user includes the FRSShipmentIndicator in the request.
TransportationCharges_GrossCharge:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Gross charges currency code.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Gross charges monetary value. Valid values are from 0 to 9999999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: GrossCharge
description: Gross Charges container. It indicates the shipment level gross
Ground Freight Pricing transportation charges.
TransportationCharges_DiscountAmount:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Discount Amount currency code.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Discount amount monetary value. Valid values are from 0 to
9999999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: DiscountAmount
description: Discount Amount container. It indicates the shipment level Ground
Freight Pricing discount amount for transportation charges
TransportationCharges_NetCharge:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Net Charge currency code.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Net charges monetary value. Valid values are from 0 to 9999999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: NetCharge
description: Net Charges container. It indicates the shipment level net Ground
Freight Pricing transportation charges.
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 are 0 to 999.9
maximum: 1
type: string
minLength: 1
maxLength: 5
TotalCubicFeet:
description: Total Cubic feet is returned if the Shipper is eligible for
Density based rate. Valid values are 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
maximum: 1
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. Height Adjustment
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.
ShipmentResults_BillingWeight:
type: object
required:
- UnitOfMeasurement
- Weight
properties:
UnitOfMeasurement:
"$ref": "#/components/schemas/BillingWeight_UnitOfMeasurement"
Weight:
description: Billing weight. Higher of the actual shipment weight versus
the shipment dimensional weight. 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: 8
maxLength: 8
xml:
name: BillingWeight
maximum: 1
description: Billing Weight container.
BillingWeight_UnitOfMeasurement:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: 'Code of the billing weight measurement units. Values are:
KGS or LBS.'
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description of the billing weight measurement units.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: UnitOfMeasurement
description: Billing weight unit of measurement code. The unit of measurement
used in Shipment request is returned.
ShipmentResults_PackageResults:
type: object
maximum: 1
required:
- TrackingNumber
properties:
TrackingNumber:
description: "Package 1Z number. \nFor Mail Innovations shipments, please
use the USPSPICNumber when tracking packages (a non-1Z number Mail Manifest
Id is returned)."
maximum: 1
type: string
minLength: 18
maxLength: 18
RateModifier:
description: |
Returned Package Information.
**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/PackageResults_RateModifier"
BaseServiceCharge:
"$ref": "#/components/schemas/PackageResults_BaseServiceCharge"
ServiceOptionsCharges:
"$ref": "#/components/schemas/PackageResults_ServiceOptionsCharges"
ShippingLabel:
"$ref": "#/components/schemas/PackageResults_ShippingLabel"
ShippingReceipt:
"$ref": "#/components/schemas/PackageResults_ShippingReceipt"
USPSPICNumber:
description: USPSPICNumber is USPS Package Identification; it should be
used for tracking Mail Innovations shipments.
maximum: 1
type: string
CN22Number:
description: "USPS defined CN22 ID number format varies based on destination
country or territory. \nNot applicable as of Jan 2015. \nMail Innovations
shipments US to VI, PR, and GU are not considered international."
maximum: 1
type: string
Accessorial:
description: |
The container for Accessorial indicators. This information would be returned 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 Mid-day 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/PackageResults_Accessorial"
SimpleRate:
"$ref": "#/components/schemas/PackageResults_SimpleRate"
Form:
"$ref": "#/components/schemas/PackageResults_Form"
ItemizedCharges:
description: |
Itemized Charges are returned only when the subversion element is present and greater than or equal to 1607. Package level itemized charges are only returned for US domestic movements.
**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/PackageResults_ItemizedCharges"
NegotiatedCharges:
"$ref": "#/components/schemas/PackageResults_NegotiatedCharges"
xml:
name: PackageResults
PackageResults_BaseServiceCharge:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: BaseServiceCharge currency code type. The currency code used
in the Shipment request is returned.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: Base Service Charge value amount. Valid values are from 0
to 99999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: BaseServiceCharge
description: |-
Base Service Charge container.
Transportation charge = BaseServiceCharge + Fuel charge Returned only if Subversion >=1701.
PackageResults_ServiceOptionsCharges:
type: object
maximum: 1
required:
- CurrencyCode
- MonetaryValue
properties:
CurrencyCode:
description: Package accessorial charges currency code type. The currency
code used in the Shipment request is returned.
maximum: 1
type: string
minLength: 3
maxLength: 3
MonetaryValue:
description: |-
Package accessorial charges value amount.
Valid values are from 0 to 99999999999999.99
maximum: 1
type: string
minLength: 1
maxLength: 19
xml:
name: ServiceOptionsCharges
description: Shipment charges info. Shipment charges are only guaranteed to
be returned for shipments whose origin country or territory is US or Puerto
Rico.
PackageResults_ShippingLabel:
type: object
required:
- GraphicImage
- ImageFormat
properties:
ImageFormat:
"$ref": "#/components/schemas/ShippingLabel_ImageFormat"
GraphicImage:
description: Base 64 encoded graphic image.
maximum: 1
type: string
GraphicImagePart:
description: |
Base 64 encoded graphic image. Applicable only for Mail Innovations CN22 Combination Forward Label with more than 3 commodities.
**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.
items:
type: string
type: array
InternationalSignatureGraphicImage:
description: Base 64 encoded graphic image of the Warsaw text and signature
box. EPL2, ZPL and SPL labels. The image will be returned for non-US based
shipments. One image will be given per shipment and it will be in the
first PackageResults container.
maximum: 1
type: string
HTMLImage:
description: Base 64 encoded html browser image rendering software. This
is only returned for gif and png image formats.
maximum: 1
type: string
PDF417:
description: PDF-417 is a two-dimensional barcode, which can store up to
about 1,800 printable ASCII characters or 1,100 binary characters per
symbol. The symbol is rectangular. The image is Base 64 encoded and returned
if the LabelImageFormat code is GIF. Shipment with PRL return service
only.
maximum: 1
type: string
xml:
name: ShippingLabel
maximum: 1
description: "The container for UPS shipping label. Returned for following shipments
-\nForward shipments,\nShipments with PRL returns service, \nElectronic Return
Label or Electronic Import Control Label shipments with SubVersion greater
than or equal to 1707. Shipping label wont be returned if BarCodeImageIndicator
is present."
ShippingLabel_ImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: 'Label image code that the labels are generated. Valid values:
EPL = EPL2 SPL = SPL ZPL = ZPL GIF = gif images PNG = PNG images. Only
EPL, SPL, ZPL and GIF are currently supported. For multi piece COD shipments,
the label image format for the first package will always be a GIF for
any form of label requested.'
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description of the image format.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ImageFormat
description: The container image format.
PackageResults_ShippingReceipt:
type: object
required:
- GraphicImage
- ImageFormat
properties:
ImageFormat:
"$ref": "#/components/schemas/ShippingReceipt_ImageFormat"
GraphicImage:
description: "Base 64 encoded receipt in HTML format.\n\nThe receipt image is only
returned for the first 5 packages."
maximum: 1
type: string
xml:
name: ShippingReceipt
maximum: 1
description: |-
Supported for following shipments -
PRL shipments,
Electronic Return Label or Electronic Import Control Label shipments with SubVersion greater than or equal to 1707.
ShippingReceipt_ImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Code representing the format in which a receipt is delivered. Valid values:
- HTML = HTML format
maximum: 1
type: string
minLength: 1
maxLength: 4
Description:
description: Description of the image format code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ImageFormat
description: Container for a Image Format.
PackageResults_Accessorial:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: Code for Accessorial Indicator.
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description for Accessorial Indicator.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: Accessorial
PackageResults_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
xml:
name: SimpleRate
description: SimpleRate will be returned if Simple Rate present in request
PackageResults_Form:
type: object
maximum: 1
properties:
Code:
description: |
Code that indicates the type of form. Valid values:
- 01 - All Requested International Forms.
maximum: 1
type: string
minLength: 2
maxLength: 2
Description:
description: "Description that indicates the type of form. Possible Values: All Requested International Forms."
maximum: 1
type: string
minLength: 1
maxLength: 35
Image:
"$ref": "#/components/schemas/Form_Image"
FormGroupId:
description: Unique Id for later retrieval of saved version of the completed international forms.
maximum: 1
type: string
minLength: 1
maxLength: 26
FormGroupIdName:
description: Contains description text which identifies the group of International forms. This element is part of both request and response. This element does not appear on the forms.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: Form
description: |-
Container tag for the International forms image. Currently this container would be returned for UPS Premium Care shipments. Form is returned for following shipments -
Forward shipments,
Shipments with PRL ReturnService,
Electronic Return Label or Electronic Import Control Label shipments with SubVersion greater than or equal to 1707. CN22 data for Worlwide economy services will be returned within the PDF417 barcode of the label.
ShipmentResults_Form_Image:
type: object
required:
- GraphicImage
- ImageFormat
properties:
ImageFormat:
"$ref": "#/components/schemas/ShipmentResults_Image_ImageFormat"
GraphicImage:
description: Base 64 encoded International forms image.
maximum: 1
type: string
xml:
name: Image
maximum: 1
description: Container tag for the International forms image.
Form_Image:
type: object
required:
- GraphicImage
- ImageFormat
properties:
ImageFormat:
"$ref": "#/components/schemas/Image_ImageFormat"
GraphicImage:
description: Base 64 encoded International forms image.
maximum: 1
type: string
xml:
name: Image
maximum: 1
description: Container tag for the International forms image.
HighValueReport_Image_ImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Code representing the format in which the High Value Report is generated.
Valid values:
- PDF = pdf.
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description of the High Value Report image format code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ImageFormat
description: Container for the High Value Report image format information for Import Control Shipments.
CODTurnInPage_Image_ImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Format code of the generated COD Turn In Page.
Valid values:
- HTML = HTML format.
Only HTML format is supported for COD Turn In Page.
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description of the form image format code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ImageFormat
description: The container for format of COD Turn In Page.
ShipmentResults_Image_ImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Code representing the format in which the forms are generated. Valid values:
- PDF = pdf
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description of the form image format code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ImageFormat
description: Container tag for the International forms image format information.
Image_ImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: 'Code representing the format in which the forms are generated.
Valid values: PDF = pdf, PNG = png'
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description of the form image format code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ImageFormat
description: Container tag for the International forms image format information.
PackageResults_ItemizedCharges:
type: object
maximum: 1
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: Itemized Charges value amount.
maximum: 1
type: string
minLength: 1
maxLength: 19
SubType:
description: The sub-type of ItemizedCharges type.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: ItemizedCharges
PackageResults_NegotiatedCharges:
type: object
properties:
ItemizedCharges:
description: |
Negotiated Itemized Accessorial and SurCharges.
Negotiated itemized charges are only returned for certain contract-only shipments as well as Worldwide Express Freight, Ground Freight Pricing, and Hazmat movements. Negotiated Itemized Accessorial and Sur Charges are returned only when the subversion element is present and greater than or equal to 1607.
Package level itemized charges are only returned for US domestic movements
**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"
RateModifier:
type: array
items:
"$ref": "#/components/schemas/NegotiatedCharges_RateModifier"
xml:
name: NegotiatedCharges
description: |-
Negotiated Rates Charge Container. These charges are returned when:
1) Subversion is greater than or equal to 1607
2) If negotiated rates were requested for GFP shipments and account number is eligible to receive negotiated rates.
maximum: 1
NegotiatedCharges_ItemizedCharges:
type: object
maximum: 1
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: Itemized Charges value amount.
maximum: 1
type: string
minLength: 1
maxLength: 19
SubType:
description: The sub-type of ItemizedCharges type.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: ItemizedCharges
NegotiatedCharges_RateModifier:
type: object
maximum: 1
required:
- Amount
- ModifierDesc
- ModifierType
properties:
ModifierType:
description: >-
Rate Modifier Type .
Example- "ORM" Applies if SubVersion is 2407 or greater and
supports only for oAuth shipments.
maximum: 1
type: string
minLength: 3
maxLength: 3
ModifierDesc:
description: >-
Rate Modifier Description .
Example- "Origin Modifier" Applies if SubVersion is 2407 or greater
and supports only for oAuth shipments.
maximum: 1
type: string
minLength: 50
maxLength: 50
Amount:
description: >-
Amount .
Example- "-1.00","0.25"
It contains positive or negative values. Applies if SubVersion is
2407 or greater and supports only for oAuth shipments.
maximum: 1
type: string
minLength: 16
maxLength: 16
xml:
name: RateModifier
description: >-
Container for returned Rate Modifier information. Applies if SubVersion
is 2407 or greater and supports only for oAuth shipments.
PackageResults_RateModifier:
type: object
required:
- ModifierType
- ModifierDesc
- CurrencyCode
- Amount
properties:
ModifierType:
description: 'Rate Modifier Type. Example: "ORM". Applies only if SubVersion
is 2205 or greater.'
maximum: 1
type: string
minLength: 3
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
description: Container for returned Rate Modifier information. Applies only
if SubVersion is 2205 or greater.
ShipmentResults_ControlLogReceipt:
type: object
required:
- GraphicImage
- ImageFormat
properties:
ImageFormat:
"$ref": "#/components/schemas/ControlLogReceipt_ImageFormat"
GraphicImage:
description: |-
Base 64 encoded html, EPL2, ZPL or SPL image.
maximum: 1
type: string
xml:
name: ControlLogReceipt
maximum: 1
ControlLogReceipt_ImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Code for the type of Graphic Image for the High Value Report.
Valid values:
- EPL = EPL2 (when user requests label in EPL2 format)
- SPL = SPL (when user requests label in SPL format)
- ZPL = ZPL (when user requests label in ZPL format)
- HTML= HTML (when user requests label in HTML format)
maximum: 1
type: string
minLength: 1
maxLength: 4
Description:
description: Description of the format code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ImageFormat
description: Container for the High Value report format required if parent exist.
ShipmentResults_Form:
type: object
maximum: 1
properties:
Code:
description: |-
Code that indicates the type of form.
Valid values: 01 - All Requested International Forms.
maximum: 1
type: string
minLength: 1
maxLength: 2
Description:
description: "Description that indicates the type of form. Possible Values.
All Requested International Forms."
maximum: 1
type: string
minLength: 1
maxLength: 35
Image:
"$ref": "#/components/schemas/ShipmentResults_Form_Image"
FormGroupId:
description: "Unique Id for later retrieval of saved version of the completed
international forms. Always returned when code = 01. 01 represents international
forms."
maximum: 1
type: string
minLength: 1
maxLength: 26
FormGroupIdName:
description: Contains description text which identifies the group of International
forms. This element is part of both request and response. This element
does not appear on the forms.
maximum: 1
type: string
minLength: 1
maxLength: 50
xml:
name: Form
description: |-
Container tag for the International forms image. Form is returned for following shipments -
Forward shipments,
Shipments with PRL ReturnService,
Electronic Return Label or Electronic Import Control Label shipments with SubVersion greater than or equal to 1707.
ShipmentResults_CODTurnInPage:
type: object
required:
- Image
properties:
Image:
"$ref": "#/components/schemas/CODTurnInPage_Image"
xml:
name: CODTurnInPage
description: The container of the COD Turn In Page.
maximum: 1
CODTurnInPage_Image:
type: object
required:
- GraphicImage
- ImageFormat
properties:
ImageFormat:
"$ref": "#/components/schemas/CODTurnInPage_Image_ImageFormat"
GraphicImage:
description: Base 64 encoded html browser image rendering software
type: string
maximum: 1
xml:
name: Image
maximum: 1
description: The container of the image for COD Turn In Page.
ShipmentResults_HighValueReport:
type: object
required:
- Image
properties:
Image:
"$ref": "#/components/schemas/HighValueReport_Image"
xml:
name: HighValueReport
description: Container for the High Value Report generated for ImportControl
or Return shipments with high package declared value.
maximum: 1
HighValueReport_Image:
type: object
required:
- GraphicImage
- ImageFormat
properties:
ImageFormat:
"$ref": "#/components/schemas/HighValueReport_Image_ImageFormat"
GraphicImage:
description: Base 64 encoded High Value Report image.
type: string
maximum: 1
xml:
name: Image
maximum: 1
description: Container tag for the High Value Report image.
VOIDSHIPMENTRequestWrapper:
xml:
name: VoidShipmentRequest
description: 'N/A '
maximum: 1
type: object
required:
- VoidShipmentRequest
properties:
VoidShipmentRequest:
"$ref": "#/components/schemas/VoidShipmentRequest"
VOIDSHIPMENTResponseWrapper:
xml:
name: VoidShipmentResponse
description: 'N/A '
maximum: 1
type: object
required:
- VoidShipmentResponse
properties:
VoidShipmentResponse:
"$ref": "#/components/schemas/VoidShipmentResponse"
VoidShipmentRequest:
type: object
required:
- Request
- VoidShipment
properties:
Request:
"$ref": "#/components/schemas/VoidShipmentRequest_Request"
VoidShipment:
"$ref": "#/components/schemas/VoidShipmentRequest_VoidShipment"
xml:
name: VoidShipmentRequest
description: Void Shipment Request Container
maximum: 1
VoidShipmentRequest_Request:
type: object
maximum: 1
properties:
RequestOption:
description: Optional processing. No options Not used. Left for future
uses
type: string
TransactionReference:
"$ref": "#/components/schemas/VoidRequest_TransactionReference"
xml:
name: Request
description: Request Container
VoidRequest_TransactionReference:
type: object
maximum: 1
properties:
CustomerContext:
description: The CustomerContext Information which will be echoed during
response.
maximum: 1
type: string
minLength: 1
maxLength: 512
xml:
name: TransactionReference
description: TransactionReference identifies transactions between client and
server.
VoidShipmentRequest_VoidShipment:
type: object
maximum: 20
properties:
ShippingHistoryUserKey:
description: Unique key to tag shipments in shipping history. It could be
MyUPS registration Number or any unique identifier.
maximum: 1
type: string
minLength: 10
maxLength: 10
ShipmentIdentificationNumber:
description: The shipment's identification number Alpha-numeric. Must pass
1Z rules. Must be upper case.
maximum: 1
type: string
minLength: 18
maxLength: 18
TrackingNumber:
description: "The package's identification number Alpha-numeric. Must pass
1Z rules. Must be upper case.\n\nPackage level Void is not applicable for return service."
type: array
items:
maximum: 20
type: string
minLength: 18
maxLength: 18
xml:
name: VoidShipment
required:
- ShipmentIdentificationNumber
description: The container for the Ship Void Request.
minLength: 1
maxLength: 1
VoidShipmentResponse:
type: object
required:
- Response
- SummaryResult
properties:
Response:
"$ref": "#/components/schemas/VoidShipmentResponse_Response"
SummaryResult:
"$ref": "#/components/schemas/VoidShipmentResponse_SummaryResult"
PackageLevelResults:
description: |
Contains the Package Level Results.
**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/VoidShipmentResponse_PackageLevelResults"
xml:
name: VoidShipmentResponse
description: Void Response Container.
maximum: 1
VoidShipmentResponse_Response:
type: object
required:
- ResponseStatus
properties:
ResponseStatus:
"$ref": "#/components/schemas/VoidResponse_ResponseStatus"
Alert:
"$ref": "#/components/schemas/Response_Alert"
TransactionReference:
"$ref": "#/components/schemas/VoidResponse_TransactionReference"
xml:
name: Response
description: Response Container.
maximum: 1
VoidResponse_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
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ResponseStatus
description: Response Status Container.
VoidResponse_TransactionReference:
type: object
maximum: 1
properties:
CustomerContext:
description: The CustomerContext Information which will be echoed during
response.
maximum: 1
type: string
minLength: 1
maxLength: 512
xml:
name: TransactionReference
description: Transaction Reference Container.
VoidShipmentResponse_SummaryResult:
type: object
required:
- Status
properties:
Status:
"$ref": "#/components/schemas/SummaryResult_Status"
xml:
name: SummaryResult
description: Container for the Summary Result
maximum: 1
SummaryResult_Status:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: Code for the status of the Summary Result
maximum: 1
type: string
minLength: 1
maxLength: 1
Description:
description: Description of the status of the Summary Result
maximum: 1
type: string
minLength: 1
maxLength: 15
xml:
name: Status
description: Container for the status of the Summary Result
VoidShipmentResponse_PackageLevelResults:
type: object
maximum: 1
required:
- Status
- TrackingNumber
properties:
TrackingNumber:
description: The package's identification number
maximum: 1
type: string
minLength: 18
maxLength: 18
Status:
"$ref": "#/components/schemas/PackageLevelResults_Status"
xml:
name: PackageLevelResults
PackageLevelResults_Status:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: The Package Level void status code. A numeric value that describes
the status code. 1 = Voided or Already Voided; 0 = Not Voided
maximum: 1
type: string
minLength: 1
maxLength: 1
Description:
description: A text description of the status code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: Status
description: Contains the status code tags.
minLength: 1
maxLength: 1
LABELRECOVERYRequestWrapper:
xml:
name: LabelRecoveryRequest
description: 'N/A '
maximum: 1
type: object
required:
- LabelRecoveryRequest
properties:
LabelRecoveryRequest:
"$ref": "#/components/schemas/LabelRecoveryRequest"
LABELRECOVERYResponseWrapper:
xml:
name: LabelRecoveryResponse
description: 'N/A '
maximum: 1
type: object
required:
- LabelRecoveryResponse
properties:
LabelRecoveryResponse:
"$ref": "#/components/schemas/LabelRecoveryResponse"
LabelRecoveryRequest:
type: object
required:
- Request
- TrackingNumbers
- ReferenceValues
properties:
Request:
"$ref": "#/components/schemas/LabelRecoveryRequest_Request"
LabelSpecification:
"$ref": "#/components/schemas/LabelRecoveryRequest_LabelSpecification"
Translate:
"$ref": "#/components/schemas/LabelRecoveryRequest_Translate"
LabelDelivery:
"$ref": "#/components/schemas/LabelRecoveryRequest_LabelDelivery"
TrackingNumber:
description: |-
Small Package Tracking Number. Required if Mail Innovations Tracking Number or ReferenceNumber/Value and ShipperNumber is not provided. If only TrackingNumber is provided, the request will be treated as Small Package Shipment. Label Recovery will return label for Small Package Tracking Number.
If both, TrackingNumber and MailInnovationsTrackingNumber are provided, the request will be treated as Dual Mail Innovations Return Shipment. Label Recovery will return two labels one each for - Small Package Tracking Number and Mail Innovations Return Tracking Number.
maximum: 1
type: string
minLength: 1
maxLength: 18
TrackingNumbers:
description: 'List of Roadie (1R) tracking numbers associated with the label recovery request. Each tracking number must start with "1R" or "1r" and must be either 16 characters (offline) or 28 characters (online) in length.'
maximum: 1
type: array
items:
type: string
minLength: 1
maxLength: 20
MailInnovationsTrackingNumber:
description: "Mail Innovations Tracking Number. Required if Tracking Number
or ReferenceNumber/Value is not populated. \nIf only MailInnovationsTrackingNumber
is provided, the request will be treated as Single Mail Innovations Return
Shipment. Label Recovery will return label for Mail Innovations Return
Tracking Number.\nIf both, TrackingNumber and MailInnovationsTrackingNumber
are provided, the request will be treated as Dual Mail Innovations Return
Shipment. Label Recovery will return two labels one each for - Small Package
Tracking Number and Mail Innovations Return Tracking Number."
maximum: 1
type: string
minLength: 1
maxLength: 34
ReferenceValues:
"$ref": "#/components/schemas/LabelRecoveryRequest_ReferenceValues"
Locale:
description: "Represents 5 character ISO Locale that allows the user to
request Reference Number Code on Label, Label instructions, Receipt instructions
(if available for given tracking number) and High Value Report (if available
for given tracking number) in desired language. \nLocale is specified
by the combination of language code and country or territory code - 2
character language code and 2 character country code seperated by an underscore
('_') character. Example - de_DE. Please refer to Appendix for supported
values for Locale. Either Translate container or Locale element can be
present in a given request. Both can't be requested together in same request."
maximum: 1
type: string
minLength: 5
maxLength: 5
UPSPremiumCareForm:
"$ref": "#/components/schemas/LabelRecoveryRequest_UPSPremiumCareForm"
xml:
name: LabelRecoveryRequest
maximum: 1
description: Request for obtaining the Label for the return shipment.
LabelRecoveryRequest_Request:
type: object
maximum: 1
properties:
SubVersion:
description: |-
When UPS introduces new elements in the response that are not associated with new request elements, Subversion is used. This ensures backward compatibility.
To get such elements you need to have the right Subversion. The value of the subversion is explained in the Response element Description. To support Roadie labels, the API version in the URL must be v2603.
Format: YYMM = Year and month of the release.
Example: 1701 = 2017 January Supported values: 1701, 1707, 1903, 2603
type: string
RequestOption:
description: Request option is no longer used.
type: string
TransactionReference:
"$ref": "#/components/schemas/LRRequest_TransactionReference"
xml:
name: Request
description: Request Container.
LRRequest_TransactionReference:
type: object
maximum: 1
properties:
CustomerContext:
description: The CustomerContext Information which will be echoed during
response
maximum: 1
type: string
minLength: 5
maxLength: 512
xml:
name: TransactionReference
description: Container that identifies transactions between client and server.
LabelRecoveryRequest_LabelSpecification:
type: object
maximum: 1
properties:
HTTPUserAgent:
description: Browser HTTPUserAgent String. This is the preferred way of
identifying GIF image type to be generated. Required if /
LabelSpecification/LabelImageFormat/Code = Gif. Default to Mozilla/4.5
if this field is missing or has invalid value.
maximum: 1
type: string
minLength: 1
maxLength: 64
LabelImageFormat:
"$ref": "#/components/schemas/LabelRecovery_LabelSpecification_LabelImageFormat"
LabelStockSize:
"$ref": "#/components/schemas/LabelRecovery_LabelSpecification_LabelStockSize"
xml:
name: LabelSpecification
description: Container that is used to define the properties required by the
user to print and/ or display the UPS shipping label. Required for the shipment
without return service, or shipment with PRL return service.
LabelRecovery_LabelSpecification_LabelImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
File type that the label is to be generated in. Valid values are:
- GIF -- label is in HTML format.
- PDF -- label is in PDF format.
- ZPL -- Thermal label in ZPL format.
- EPL -- Thermal label in EPL2 format.
- SPL -- Thermal label in SPL format.
Default is GIF.
Roadie shipments only support GIF, PNG, and ZPL formats.
maximum: 1
type: string
minLength: 4
maxLength: 4
Description:
description: Description of the label image format code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: LabelImageFormat
description: The file format of the label and receipt. Defaults to HTML format if this node does not exist.
LabelRecovery_LabelSpecification_LabelStockSize:
type: object
maximum: 1
required:
- Height
- Width
properties:
Height:
description: |
Height of the Label. Only valid values are 6 or 8.
Note: Label Image will only scale up to 4 X 6, even when requesting 4 X 8.
maximum: 1
type: string
minLength: 1
maxLength: 3
Width:
description: |
Width of the Label. Valid value is 4.
Note: Label Image will only scale up to 4 X 6, even when requesting 4 X 8.
maximum: 1
type: string
minLength: 1
maxLength: 3
xml:
name: LabelStockSize
description: Container to hold Label Height and Width information. Applicable if Label Image Code is ZPL, EPL and SPL. Ignored for other Label Image Code types.
LabelRecoveryRequest_Translate:
type: object
maximum: 1
required:
- DialectCode
- LanguageCode
- Code
properties:
LanguageCode:
description: |
The Language code. The language codes are three letter language codes. Supported languages are:
- eng - English
- spa - Spanish
- ita - Italian
- fra - French
- deu - German
- por -Portuguese
- nld – Dutch
- dan - Danish
- fin - Finnish
- swe – Swedish
- nor – Norwegian
maximum: 1
type: string
minLength: 2
maxLength: 3
DialectCode:
description: |
Valid dialect codes are:
- CA - Canada
- GB - Great Britain
- US - United States
- 97 – Not Applicable
maximum: 1
type: string
minLength: 2
maxLength: 2
Code:
description: "Used to specify what will be translated. \nValid code: \n01
= label direction instructions and receipt"
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: Translate
description: "Translate container allows the user to specify the language he/she
would like a specific portion of response to return. \nThe language is specified
by the combination of language code and dialect code. \nValid combinations
are: LanguageCode + DialectCode. Either Translate container or Locale element
can be present in a given request. Both can't be requested together in same
request.\nCombinations: \neng GB = Queen's English \nSpa 97 = Castilian Spanish
\nita 97 = Italian \nfra 97 = France French \nfra CA = Canadian French \ndeu
97 = German \npor 97 = Portugal Portuguese \nnld 97 = Dutch \ndan 97 = Danish
\nfin 97 = Finnish \nswe 97 = Swedish \neng CA = Canadian English \nEng US
= US English \nDefault language is Queen's English \n\nIf the Ship from country
or territory is Canada, the Language defaults to Canadian English. \n\nIf
the ship from country or territory is US, the language defaults to US English.\n\nIf
shipping from some other country or territory, the language defaults to Queens
English."
LabelRecoveryRequest_LabelDelivery:
type: object
maximum: 1
properties:
LabelLinkIndicator:
description: |-
Indicates the Label Recovery and Receipt Recovery URL links are to be returned in the XML Response. Valid for following shipment -
Print/Electronic Return Label
Print/Electronic Import Control Label
Forward shipment except for Mail Innovations Forward
maximum: 1
type: string
ResendEMailIndicator:
description: Not Used. If this tag is present, resend the Label Delivery
notification email.
maximum: 1
type: string
xml:
name: LabelDelivery
description: Container for the Label Delivery accessorial. One Label Delivery
per shipment.
LabelRecoveryRequest_ReferenceValues:
type: object
required:
- ReferenceNumber
- ShipperNumber
properties:
ReferenceNumber:
"$ref": "#/components/schemas/ReferenceValues_ReferenceNumber"
ShipperNumber:
description: Required if ReferenceNumber/Value is populated. Shipper's six digit account number. Must be six alphanumeric characters. Must be associated with the Internet account used to login.
maximum: 1
type: string
minLength: 6
maxLength: 6
xml:
name: ReferenceValues
maximum: 1
description: Container that holds reference number and shipper number If tracking
number is not present use reference Number. This is mandatory for only Roadie shipments.
ReferenceValues_ReferenceNumber:
type: object
maximum: 1
required:
- Value
properties:
Value:
description: Required if TrackingNumber or Mail Innovations Tracking Number
is not populated. Customer supplied reference number. Supports up to 2
customer supplied combinations of Reference code- value combinations.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ReferenceNumber
description: Container for reference number
LabelRecoveryRequest_UPSPremiumCareForm:
type: object
maximum: 1
required:
- PrintType
- PageSize
properties:
PageSize:
description: "Size of UPS Premium Care Form. Valid values: \n01 = A4 Size\n02
= Letter Size"
maximum: 1
type: string
minLength: 2
maxLength: 2
PrintType:
description: "Format of UPS Premium Care Form. Valid values: \n01 = PNG\n02
= PDF"
maximum: 1
type: string
minLength: 2
maxLength: 2
xml:
name: UPSPremiumCareForm
description: "UPS Premium Care Form container. Default is PDF when container
is not provided. \n Valid only for Canada to Canada movements. UPS Premium
Care Form will be returned in both US English and Canadian French language."
LabelRecoveryResponse:
type: object
required:
- Response
- LabelResults
properties:
Response:
"$ref": "#/components/schemas/LabelRecoveryResponse_Response"
ShipmentIdentificationNumber:
description: Tracking number of the leading package in the shipment
maximum: 1
type: string
minLength: 18
maxLength: 18
LabelResults:
items:
"$ref": "#/components/schemas/LabelRecoveryResponse_LabelResults"
type: array
CODTurnInPage:
"$ref": "#/components/schemas/LabelRecoveryResponse_CODTurnInPage"
Form:
"$ref": "#/components/schemas/LabelRecoveryResponse_Form"
HighValueReport:
"$ref": "#/components/schemas/LabelRecoveryResponse_HighValueReport"
TrackingCandidate:
type: array
items:
"$ref": "#/components/schemas/LabelRecoveryResponse_TrackingCandidate"
xml:
name: LabelRecoveryResponse
maximum: 1
description: Response for the Label recovery request Validates the date range
and label being present. Also if the shipment is return or not
LabelRecoveryResponse_Response:
type: object
required:
- ResponseStatus
properties:
ResponseStatus:
"$ref": "#/components/schemas/LRResponse_ResponseStatus"
Alert:
type: array
items:
"$ref": "#/components/schemas/Response_Alert"
TransactionReference:
"$ref": "#/components/schemas/LRResponse_TransactionReference"
xml:
name: Response
description: Response Container
maximum: 1
LRResponse_ResponseStatus:
type: object
maximum: 1
required:
- Description
- Code
properties:
Code:
description: Identifies the success status of the transaction. 1= Success
maximum: 1
type: string
minLength: 1
maxLength: 1
Description:
description: Describes Response Status Code. Returns the text "Success"
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ResponseStatus
description: Response Status container
LRResponse_TransactionReference:
type: object
maximum: 1
properties:
CustomerContext:
description: The CustomerContext Information which will be echoed during
response
maximum: 1
type: string
minLength: 1
maxLength: 512
xml:
name: TransactionReference
description: Transaction Reference Container
LabelRecoveryResponse_LabelResults:
type: object
maximum: 1
properties:
TrackingNumber:
description: Package Tracking number. Package 1Z number. Returned only
if TrackingNumber or Combination of Reference Number and Shipper Number
present in request.
maximum: 1
type: string
minLength: 18
maxLength: 18
LabelImage:
"$ref": "#/components/schemas/LabelResults_LabelImage"
MailInnovationsTrackingNumber:
description: Mail Innovations Tracking Number. Applicable for Single Mail
Innovations Returns and Dual Mail Innovations Returns shipment. Returned
only if MailInnovationsTrackingNumber is provided in request.
maximum: 1
type: string
minLength: 1
maxLength: 34
MailInnovationsLabelImage:
"$ref": "#/components/schemas/LabelResults_MailInnovationsLabelImage"
Receipt:
"$ref": "#/components/schemas/LabelResults_Receipt"
Form:
"$ref": "#/components/schemas/LabelResults_Form"
xml:
name: LabelResults
description: Container that stores the label results. Information containing
the results of the user's Label Recovery Request.
LabelResults_LabelImage:
type: object
required:
- GraphicImage
- LabelImageFormat
properties:
LabelImageFormat:
"$ref": "#/components/schemas/LabelImage_LabelImageFormat"
GraphicImage:
description: Base 64 encoded graphic image.
maximum: 1
type: string
HTMLImage:
description: Base 64 encoded html browser image rendering software. This
is only returned for GIF image formats.
maximum: 1
type: string
PDF417:
description: "PDF-417 is a two-dimensional barcode, which can store up to
about 1,800 printable ASCII characters or 1,100 binary characters per
symbol. The symbol is rectangular. \n\nThe PDF417 image will be returned
when the shipment is trans-border and the service option is one of the
following: Standard Express, Saver Express Plus. The image is Base 64
encoded and only returned for GIF image format."
maximum: 1
type: string
InternationalSignatureGraphicImage:
description: Base 64 encoded graphic image of the Warsaw text and signature
box.
maximum: 1
type: string
URL:
description: |-
This is only returned if the label link is requested to be returned and only at the first package result Applicable for following types of shipments:
Print/Electronic Return Label
Print/Electronic Import Control Label
Forward shipment except for Mail Innovations Forward
maximum: 1
type: string
xml:
name: LabelImage
maximum: 1
description: The elements needed to render a label on a printer or in a browser.
Specifies the format in which GraphicImage is represented. If LabelImageFormat
is GIF, LabelImage contains GraphicImage and HTMLImage. Otherwise, it contains
only GraphicImage. If LabelImageFormat is PDF, LabelImage is only returned
at the first package result. If entered in the request, the response mirrors,
else the default values are returned. Returned only if TrackingNumber or
Combination of Reference Number and Shipper Number present in request.
LabelImage_LabelImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: The format of a label image byte stream. Code type that the label image is to be generated in. Valid value returned is GIF or PDF
maximum: 1
type: string
minLength: 4
maxLength: 4
xml:
name: LabelImageFormat
description: The format of a label image byte stream.
LabelResults_MailInnovationsLabelImage:
type: object
required:
- GraphicImage
- LabelImageFormat
properties:
LabelImageFormat:
"$ref": "#/components/schemas/MailInnovationsLabelImage_LabelImageFormat"
GraphicImage:
description: Base 64 encoded graphic image.
maximum: 1
type: string
HTMLImage:
description: Base 64 encoded html browser image rendering software. This
is only returned for GIF image formats.
maximum: 1
type: string
PDF417:
description: 'PDF-417 is a two-dimensional barcode, which can store up to
about 1,800 printable ASCII characters or 1,100 binary characters per
symbol. The symbol is rectangular. The PDF417 image will be returned when
the shipment is trans-border and the service option is one of the following:
Standard, Express Saver or Express Plus. The image is Base 64 encoded
and only returned for GIF image format'
maximum: 1
type: string
InternationalSignatureGraphicImage:
description: Base 64 encoded graphic image of the Warsaw text and signature
box. EPL2, ZPL and SPL labels. The image will be returned for non-US
based shipments. One image will be given per shipment and it will be in
the first PackageResults container.
maximum: 1
type: string
URL:
description: |-
This is only returned if the label link is requested to be returned and only at the first package result Applicable for following types of shipments:
Print/Electronic Return Label
maximum: 1
type: string
xml:
name: MailInnovationsLabelImage
maximum: 1
description: |-
Container to hold Mail Innovations shipments label. The elements needed to render a label on a printer or in a browser. Specifies the format in which GraphicImage is represented. If LabelImageFormat is GIF, LabelImage contains GraphicImage and HTMLImage. Otherwise, it contains only GraphicImage. Applicable for Single Mail Innovations Returns and Dual Mail Innovations Returns shipment. Returned only if MailInnovationsTrackingNumber is provided in request.
If LabelImageFormat requested was PDF and TrackingNumber was present along with MailInnovationsTrackingNumber in the request, only LabelImage container is returned. MailInnovationsLabelImage will not be returned. In that case, the labels for Small Package Tracking Number and Mail Innovations Tracking Number will be stitched in single PDF file.
MailInnovationsLabelImage_LabelImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: Code type that the label image is to be generated in. Valid
value returned is gif, pdf, zpl. Spl, epl2
maximum: 1
type: string
minLength: 4
maxLength: 4
xml:
name: LabelImageFormat
description: The format of a label image byte stream.
LabelResults_Receipt:
type: object
maximum: 1
properties:
HTMLImage:
description: Base 64 encoded html browser image.
maximum: 1
type: string
Image:
"$ref": "#/components/schemas/Receipt_Image"
URL:
description: |-
Receipt's url Applicable for following types of shipments:
Print/Electronic Return Label
Print/Electronic Import Control Label
maximum: 1
type: string
xml:
name: Receipt
description: Container for the HTML receipt and the receipt link.
Receipt_Image:
type: object
required:
- GraphicImage
- ImageFormat
properties:
ImageFormat:
"$ref": "#/components/schemas/Receipt_Image_ImageFormat"
GraphicImage:
description: Base 64 encoded graphic image
maximum: 1
type: string
xml:
name: Image
maximum: 1
description: Container for the receipt in the format other than HTML.
Receipt_Image_ImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: |
Code representing the format in which a receipt is returned. Valid values:
- HTML = HTML format
- PDF = pdf
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description of the form image format code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ImageFormat
description: Container for the format of the receipt.
LabelResults_Form:
type: object
required:
- Image
properties:
Image:
"$ref": "#/components/schemas/LRForm_Image"
xml:
name: Form
description: Container tag for the International Forms. Currently, represents
UPS Premium Care Form for Electronic Returns Label and Electronic Import Control
Label. UPS Premium Care Form for Forward shipment if Subverion is 1903 or
greater Applicable for Electronic Return Label and Electronic Import Control
Label shipments only. Applies only for Canada domestic shipments. Returned
for request with SubVersion greater than or equal to 1707. UPS Premium Care
Form for Forward shipment if Subverion is 1903 or greater
maximum: 1
LRForm_Image:
type: object
required:
- GraphicImage
- ImageFormat
properties:
ImageFormat:
"$ref": "#/components/schemas/Image_ImageFormat"
GraphicImage:
description: Base 64 encoded International Forms image.
maximum: 1
type: string
xml:
name: Image
maximum: 1
description: Container tag for the International Forms image.
LabelRecoveryResponse_CODTurnInPage:
type: object
required:
- Image
properties:
Image:
"$ref": "#/components/schemas/LRCODTurnInPage_Image"
xml:
name: CODTurnInPage
description: Container for COD Turnin Page.
maximum: 1
LRCODTurnInPage_Image:
type: object
required:
- GraphicImage
- ImageFormat
properties:
ImageFormat:
"$ref": "#/components/schemas/LR_CODTurnInPage_Image_ImageFormat"
GraphicImage:
description: Base64 Encoded COD Turnin Page image.
maximum: 1
type: string
xml:
name: Image
maximum: 1
description: Container for COD Turnin Page Image.
LR_CODTurnInPage_Image_ImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: Image format code. Values are 01=HTML
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description for code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ImageFormat
description: Container for the format of image.
LabelRecoveryResponse_Form:
type: object
required:
- Image
properties:
Image:
"$ref": "#/components/schemas/LabelRecovery_Form_Image"
xml:
name: Form
description: Container tag for the International Forms. Currently, represents
Commercial Invoice for Electronic Returns Label and Electronic Import Control
Label. Applicable for Electronic Return Label and Electronic Import Control
Label shipments only. Returned for request with SubVersion greater than or
equal to 1707.
maximum: 1
LabelRecovery_Form_Image:
type: object
required:
- GraphicImage
- ImageFormat
properties:
ImageFormat:
"$ref": "#/components/schemas/LabelRecovery_Image_ImageFormat"
GraphicImage:
description: Base 64 encoded International Forms image.
maximum: 1
type: string
xml:
name: Image
maximum: 1
description: Container tag for the International Forms image.
LabelRecovery_Image_ImageFormat:
type: object
maximum: 1
required:
- Code
properties:
Code:
description: "Code representing the format in which the Forms are generated. Valid values: PDF = pdf"
maximum: 1
type: string
minLength: 3
maxLength: 3
Description:
description: Description of the form image format code.
maximum: 1
type: string
minLength: 1
maxLength: 35
xml:
name: ImageFormat
description: Container tag for the International forms image format information.
LabelRecoveryResponse_HighValueReport:
type: object
required:
- Image
properties:
Image:
"$ref": "#/components/schemas/HighValueReport_Image"
xml:
name: HighValueReport
description: Container tag for the High Value Report for Electronic Returns
Label and Electronic Import Control Label. Applicable for Electronic Return
Label and Electronic Import Control Label shipments only. Returned for request
with SubVersion greater than or equal to 1707.
maximum: 1
LabelRecoveryResponse_TrackingCandidate:
type: object
maximum: 1
required:
- TrackingNumber
properties:
TrackingNumber:
description: Packaging Tracking Number Only supported for the web small
package shipment so only supported 18 digit
maximum: 1
type: string
minLength: 18
maxLength: 18
DestinationPostalCode:
description: Destination postal code candidate
maximum: 1
type: string
minLength: 1
maxLength: 9
DestinationCountryCode:
description: Destination country or territory code candidate, like US =
USA, CA = Canada Must be valid ups country or territory code. This is required, if MasterEUConsolidationIndicator is "1".
maximum: 1
type: string
minLength: 2
maxLength: 2
PickupDateRange:
"$ref": "#/components/schemas/TrackingCandidate_PickupDateRange"
xml:
name: TrackingCandidate
description: Information containing the results of the users Label Recovery
Request. Returned in the event the Shipper Number and Reference Number are
supplied in the request.
TrackingCandidate_PickupDateRange:
type: object
maximum: 1
required:
- EndDate
- BeginDate
properties:
BeginDate:
description: 'The beginning of the date range for the candidate. Format:
YYYYMMDD Service is only supported for 30 days'
maximum: 1
type: string
minLength: 8
maxLength: 8
EndDate:
description: 'The end of the date range for the candidate. Format: YYYYMMDD'
maximum: 1
type: string
minLength: 8
maxLength: 8
xml:
name: PickupDateRange
description: A range of time the package was picked up.
GlobalTaxInformation_AgentTaxIdentificationNumber:
description: Container to specify the GlobalTax ID
maximum: 1
properties:
AgentRole:
description: 'When the value passed to the AgentRole parameter is 30,
the value passed to the IDNumberTypeCode parameter must be 1002, 1005 or 0005.
(SHIP_FROM=20, CONSIGNEE=30)'
type: string
TaxIdentificationNumber:
items:
$ref: >-
#/components/schemas/AgentTaxIdentificationNumber_TaxIdentificationNumber
maximum: 8
type: array
required:
- AgentRole
type: object
xml:
name: AgentTaxIdentificationNumber
GlobalTaxInformation_DestinationCountryShipmentValue:
description: "The value for destination_Country_ShipmentValue which satisfies Tax-ID Threshold Code is \_‘01’=Yes,\_‘02’=No,‘NA’= ‘Not Applicable’\_"
maximum: 1
type: string
GlobalTaxInformation_OriginCountryShipmentValue:
description: "The value for origin_country_shipment_value which satisfies Tax-ID Threshold Code is ‘01’=Yes,\_‘02’=No,\_‘NA’= ‘Not Applicable’"
maximum: 1
type: string
GlobalTaxInformation_ShipperTypeValue:
description: "The value for idNumber_Consumer_TypeCode which satisfies Tax-ID Threshold Code is \_‘01’=Business,\_‘02’=Consumer/Individual, \_‘NA’= ‘Not Applicable’"
maximum: 1
type: string
AgentTaxIdentificationNumber_TaxIdentificationNumber:
description: "The value for flexibility and future extensibility of these Identification\_Numberrequirements,the\_recommendation\_is\_to\_support\_up\_to\_eight\_Identification\_Numbers\_per\_shipment\_party/role."
maximum: 1
properties:
IdentificationNumber:
description: >-
The code or number that a shipper or consignee has registered with a
particular country’s authority for doing business, or for
identification purposes.
type: string
IDNumberCustomerRole:
description: >-
A business or individual identification type description (Future
Use).specifies the relationship of the customer/ID Number to the
shipment 05 =importer Address, 06=Exporter Address ,
18=DeliverTo/Consignee/Reciever Address, 37= Shipper Address.
type: string
IDNumberEncryptionIndicator:
description: >-
to determine if decryption is required. 0 = Identification number is
not
Encrypted
1 = Identification number is
Encrypted
type: string
IDNumberIssuingCntryCd:
description: >-
The ISO-defined country code of the country where the Identification
Number was issued, when applicable (as per business requirements).
Needed for certain types of Identification Numbers (e.g., Passport
Number).
Sample Values: 'ID' = Indonesia,
'VN' = Vietnam,
'DE' = Germany
type: string
IDNumberPurposeCode:
description: >-
Code that specifies the purpose of the Identification Number. For
all tax ID that are not EORI = ‘01’
Valid values:
00/ Spaces = Unknown
01= Customs/Brokerage (Default)
02= Customs/Brokerage EORI
99= Other
type: string
IDNumberRequestingCntryCd:
description: >-
The ISO-defined country code of the country whose regulatory agency
is requesting the Identification Number.
Typically for Import, the Consignee ID is requested by the Ship To
country
For export, the Shipper ID is requested by the Ship From country.
Required when a country (e.g., Origin country, Destination country)
is requesting an ID Number for a shipment.
type: string
IDNumberTypeCode:
description: >-
Valid Values are:
0000 = Unknown
IDNumberTypeCode equal to ‘0000’ (unknown) is to be used when an ‘ID
Number Type’ is not applicable, or when the front-end/client system
cannot determine the type of IdentificationNumber (for any reason).
0001 = Exporter Tax ID Number
0002 = Importer Tax ID Number or
EORI Number – When
IdentificationNumberPurposeCode
= 02
0005 = Personal Tax ID Number
1001 = Other / Free Form
1002 = Company/Business Tax ID Number
1003 = National ID Number
1004 = Passport Number
1005 = Personal ID Number
1006 = Phone Number
type: string
IncludeIDNumberOnShippingBrokerageDocs:
description: >-
field to determine if the Identification Number should be excluded
from Shipping/Brokerage documents (not be passed to Document
Services) ‘00’ -> Do Not include 01-> Include.
type: string
required:
- IDNumberTypeCode
- IdentificationNumber
- IDNumberEncryptionIndicator
- IDNumberPurposeCode
- IDNumberCustomerRole
type: object
xml:
name: TaxIdentificationNumber
Shipment_GlobalTaxInformation:
description: Container used to define the properties required for GlobalTaxID.
maximum: 1
properties:
OriginCountryShipmentValue:
description: >-
The value for origin_country_shipment_value which satisfies Tax-ID
Threshold Code is ‘01’=Yes, ‘02’=No, ‘NA’= ‘Not Applicable’
type: string
DestinationCountryShipmentValue:
description: "The value for destination_Country_ShipmentValue which satisfies Tax-ID Threshold Code is \_‘01’=Yes,\_‘02’=No,‘NA’= ‘Not"
type: string
ShipperTypeValue:
description: "The value for idNumber_Consumer_TypeCode which satisfies Tax-ID Threshold Code is \_‘01’=Business,\_‘02’=Consumer/Individual,\_\_\_\_\_\_‘NA’= ‘Not Applicable’"
type: string
ConsigneeTypeValue:
description: Consignee Type. 01 = Business 02 = Consumer NA = Not Applicable
maximum: 1
type: string
minLength: 2
maxLength: 2
AgentTaxIdentificationNumber:
type: array
items:
$ref: >-
#/components/schemas/GlobalTaxInformation_AgentTaxIdentificationNumber
maximum: 4
type: object
xml:
name: GlobalTaxInformation
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.